feat: Logo detection (#1873)

Co-authored-by: PyAnsys CI Bot <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 4 people

doc/changelog.d/1873.added.md

@@ -0,0 +1 @@
+Logo detection

src/ansys/geometry/core/tools/prepare_tools.py

@@ -23,25 +23,30 @@
 
 from typing import TYPE_CHECKING
 
+from beartype import beartype as check_input_types
 from google.protobuf.wrappers_pb2 import BoolValue, DoubleValue
 
 from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
-from ansys.api.geometry.v0.models_pb2 import Body as GRPCBody, Face as GRPCFace
+from ansys.api.geometry.v0.models_pb2 import Body as GRPCBody, Face as GRPCFace, FindLogoOptions
 from ansys.api.geometry.v0.preparetools_pb2 import (
     ExtractVolumeFromEdgeLoopsRequest,
     ExtractVolumeFromFacesRequest,
+    FindLogosRequest,
     RemoveRoundsRequest,
     ShareTopologyRequest,
 )
 from ansys.api.geometry.v0.preparetools_pb2_grpc import PrepareToolsStub
 from ansys.geometry.core.connection import GrpcClient
+from ansys.geometry.core.connection.backend import BackendType
 from ansys.geometry.core.errors import protect_grpc
+from ansys.geometry.core.logger import LOG
 from ansys.geometry.core.misc.auxiliary import (
     get_bodies_from_ids,
     get_design_from_edge,
     get_design_from_face,
 )
 from ansys.geometry.core.misc.checks import check_type_all_elements_in_iterable, min_backend_version
+from ansys.geometry.core.tools.problem_areas import LogoProblemArea
 from ansys.geometry.core.tools.repair_tool_message import RepairToolMessage
 from ansys.geometry.core.typing import Real
 
@@ -295,3 +300,101 @@ def enhanced_share_topology(
             share_topo_response.repaired,
         )
         return message
+
+    @check_input_types
+    @protect_grpc
+    @min_backend_version(25, 2, 0)
+    def find_logos(
+        self, bodies: list["Body"] = None, min_height: Real = None, max_height: Real = None
+    ) -> "LogoProblemArea":
+        """Detect logos in geometry.
+
+        Detects logos, using a list of bodies if provided.
+        The logos are returned as a list of faces.
+
+        Parameters
+        ----------
+        bodies : list[Body], optional
+            List of bodies where logos should be detected
+        min_height : real, optional
+            The minimum height when searching for logos
+        max_height: real, optional
+            The minimum height when searching for logos
+
+        Returns
+        -------
+        LogoProblemArea
+            Problem area with logo faces.
+        """
+        from ansys.geometry.core.designer.body import Body
+
+        if BackendType.is_linux_service(self._grpc_client.backend_type):
+            # not yet available in Linux
+            LOG.warning("Logo detection not available on Linux")
+            return
+
+        # Verify inputs
+        if bodies and len(bodies) > 0:
+            check_type_all_elements_in_iterable(bodies, Body)
+
+        body_ids = [] if bodies is None else [body._grpc_id for body in bodies]
+        find_logo_options = FindLogoOptions(
+            min_height=min_height,
+            max_height=max_height,
+        )
+
+        response = self._prepare_stub.FindLogos(
+            FindLogosRequest(bodies=body_ids, options=find_logo_options)
+        )
+
+        return LogoProblemArea(
+            id=response.id,
+            grpc_client=self._grpc_client,
+            face_ids=[grpc_face.id for grpc_face in response.logo_faces],
+        )
+
+    @check_input_types
+    @protect_grpc
+    @min_backend_version(25, 2, 0)
+    def find_and_remove_logos(
+        self, bodies: list["Body"] = None, min_height: Real = None, max_height: Real = None
+    ) -> bool:
+        """Detect and remove logos in geometry.
+
+        Detects and remove logos, using a list of bodies if provided.
+
+        Parameters
+        ----------
+        bodies : list[Body], optional
+            List of bodies where logos should be detected and removed.
+        min_height : real, optional
+            The minimum height when searching for logos
+        max_height: real, optional
+            The minimum height when searching for logos
+
+        Returns
+        -------
+        Boolean value indicating whether the operation was successful.
+        """
+        from ansys.geometry.core.designer.body import Body
+
+        if BackendType.is_linux_service(self._grpc_client.backend_type):
+            # not yet available in Linux
+            LOG.warning("Logo detection not available on Linux")
+            return
+
+        # Verify inputs
+        if bodies and len(bodies) > 0:
+            check_type_all_elements_in_iterable(bodies, Body)
+
+        body_ids = [] if bodies is None else [body._grpc_id for body in bodies]
+        find_logo_options = FindLogoOptions(
+            min_height=min_height,
+            max_height=max_height,
+        )
+
+        response = self._prepare_stub.FindAndRemoveLogos(
+            FindLogosRequest(bodies=body_ids, options=find_logo_options)
+        )
+
+        return response.success

src/ansys/geometry/core/tools/problem_areas.py

@@ -26,6 +26,11 @@
 
 from google.protobuf.wrappers_pb2 import Int32Value
 
+from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
+from ansys.api.geometry.v0.preparetools_pb2 import (
+    RemoveLogoRequest,
+)
+from ansys.api.geometry.v0.preparetools_pb2_grpc import PrepareToolsStub
 from ansys.api.geometry.v0.repairtools_pb2 import (
     FixAdjustSimplifyRequest,
     FixDuplicateFacesRequest,
@@ -71,6 +76,7 @@ def __init__(self, id: str, grpc_client: GrpcClient):
         self._id = id
         self._grpc_id = Int32Value(value=int(id))
         self._repair_stub = RepairToolsStub(grpc_client.channel)
+        self._prepare_stub = PrepareToolsStub(grpc_client.channel)
 
     @property
     def id(self) -> str:
@@ -619,3 +625,45 @@ def fix(self) -> RepairToolMessage:
         message = RepairToolMessage(response.result.success, [], [])
 
         return message
+
+
+class LogoProblemArea(ProblemArea):
+    """Represents a logo problem area defined by a list of faces.
+
+    Parameters
+    ----------
+    id : str
+        Server-defined ID for the problem area.
+    grpc_client : GrpcClient
+        Active supporting geometry service instance for design modeling.
+    faces : list[str]
+        List of faces defining the logo problem area.
+    """
+
+    def __init__(self, id: str, grpc_client: GrpcClient, face_ids: list[str]):
+        """Initialize a new instance of the logo problem area class."""
+        super().__init__(id, grpc_client)
+
+        self._face_ids = face_ids
+
+    @property
+    def face_ids(self) -> list[str]:
+        """The ids of the faces defining the logos."""
+        return self._face_ids
+
+    @protect_grpc
+    def fix(self) -> bool:
+        """Fix the problem area by deleting the logos.
+
+        Returns
+        -------
+        message: bool
+            Message that return whether the operation was successful.
+        """
+        if len(self._face_ids) == 0:
+            return False
+
+        entity_ids = [EntityIdentifier(id=face_id) for face_id in self._face_ids]
+        response = self._prepare_stub.RemoveLogo(RemoveLogoRequest(face_ids=entity_ids))
+
+        return response.success

tests/integration/files/partWithLogos.scdocx

@@ -23,6 +23,7 @@
 
 from pint import Quantity
 
+from ansys.geometry.core.connection.backend import BackendType
 from ansys.geometry.core.math.point import Point2D
 from ansys.geometry.core.misc.measurements import UNITS
 from ansys.geometry.core.modeler import Modeler
@@ -112,3 +113,45 @@ def test_enhanced_share_topology(modeler: Modeler):
     result = modeler.prepare_tools.enhanced_share_topology(design.bodies, 0.000554167, True)
     assert result.found == 14
     assert result.repaired == 14
+
+
+def test_detect_logos(modeler: Modeler):
+    """Test logos are detected and deleted."""
+    if BackendType.is_linux_service(modeler.client.backend_type):
+        # not yet available in Linux
+        return
+    design = modeler.open_file(FILES_DIR / "partWithLogos.scdocx")
+    component = [c for c in design.components if c.name == "Default"][0]
+    body = [b for b in component.bodies if b.name == "Solid3"][0]
+    assert len(body.faces) == 189
+    result = modeler.prepare_tools.find_logos()
+    # no logos should be found is max height is not given
+    assert len(result.face_ids) == 0
+    result = modeler.prepare_tools.find_logos(max_height=0.005)
+    assert len(result.face_ids) == 147
+    success = modeler.prepare_tools.find_and_remove_logos(max_height=0.005)
+    assert success is True
+    assert len(body.faces) == 42
+
+
+def test_detect_and_fix_logo_as_problem_area(modeler: Modeler):
+    """Test logos are detected and deleted as problem area"""
+    if BackendType.is_linux_service(modeler.client.backend_type):
+        # not yet available in Linux
+        return
+    design = modeler.open_file(FILES_DIR / "partWithLogos.scdocx")
+    # Get the component named "Default"
+    component = [c for c in design.components if c.name == "Default"][0]
+    # test that no issue occurs when no logos are found on body named Solid1
+    bodies = [b for b in component.bodies if b.name == "Solid1"]
+    result = modeler.prepare_tools.find_logos(bodies, max_height=0.005)
+    assert len(result.face_ids) == 0
+    success = result.fix()
+    assert success is False
+    # Remove logos from body named Solid3
+    bodies = [b for b in component.bodies if b.name == "Solid3"]
+    result = modeler.prepare_tools.find_logos(bodies, max_height=0.005)
+    assert len(result.face_ids) == 147
+    result.fix()
+    assert success is False
+    assert len(design.components[0].bodies[2].faces) == 42