topologicpy 0.7.63__py3-none-any.whl → 0.7.65__py3-none-any.whl

topologicpy/Face.py

@@ -399,7 +399,157 @@ class Face():
                 print("Face.ByOffset - Warning: Could not create face from wires. Returning None.")
             return None
         return return_face
-    
+
+    @staticmethod  
+    def ByOffsetArea(face,
+                    area,
+                    offsetKey="offset",
+                    minOffsetKey="minOffset",
+                    maxOffsetKey="maxOffset",
+                    defaultMinOffset=0,
+                    defaultMaxOffset=1,
+                    maxIterations = 1,
+                    tolerance=0.0001,
+                    silent = False,
+                    numWorkers = None):
+        """
+        Creates an offset face from the input face based on the input area.
+
+        Parameters
+        ----------
+        face : topologic_core.Face
+            The input face.
+        area : float
+            The desired area of the created face.
+        offsetKey : str , optional
+            The edge dictionary key under which to store the offset value. The default is "offset".
+        minOffsetKey : str , optional
+            The edge dictionary key under which to find the desired minimum edge offset value. If a value cannot be found, the defaultMinOffset input parameter value is used instead. The default is "minOffset".
+        maxOffsetKey : str , optional
+            The edge dictionary key under which to find the desired maximum edge offset value. If a value cannot be found, the defaultMaxOffset input parameter value is used instead. The default is "maxOffset".
+        defaultMinOffset : float , optional
+            The desired minimum edge offset distance. The default is 0.
+        defaultMaxOffset : float , optional
+            The desired maximum edge offset distance. The default is 1.
+        maxIterations: int , optional
+            The desired maximum number of iterations to attempt to converge on a solution. The default is 1.
+        tolerance : float , optional
+            The desired tolerance. The default is 0.0001.
+        silent : bool , optional
+            If set to True, no error and warning messages are printed. Otherwise, they are. The default is False.
+        numWorkers : int , optional
+            Number of workers run in parallel to process. If you set it to 1, no parallel processing will take place.
+            The default is None which causes the algorithm to use twice the number of cpu cores in the host computer.
+        
+        Returns
+        -------
+        topologic_core.Face
+            The created face.
+
+        """
+        from topologicpy.Wire import Wire
+        from topologicpy.Face import Face
+        from topologicpy.Topology import Topology
+        from topologicpy.Dictionary import Dictionary
+        import numpy as np
+        from scipy.optimize import minimize
+
+        def compute_offset_amounts(face,
+                                area,
+                                offsetKey="offset",
+                                minOffsetKey="minOffset",
+                                maxOffsetKey="maxOffset",
+                                defaultMinOffset=0,
+                                defaultMaxOffset=1,
+                                maxIterations = 1,
+                                tolerance=0.0001):
+            
+            initial_offsets = []
+            bounds = []
+            for edge in edges:
+                d = Topology.Dictionary(edge)
+                minOffset = Dictionary.ValueAtKey(d, minOffsetKey) or defaultMinOffset
+                maxOffset = Dictionary.ValueAtKey(d, maxOffsetKey) or defaultMaxOffset
+                # Initial guess: small negative offsets to shrink the polygon, within the constraints
+                initial_offsets.append((minOffset + maxOffset) / 2)
+                # Bounds based on the constraints for each edge
+                bounds.append((minOffset, maxOffset))
+
+            # Convert initial_offsets to np.array for efficiency
+            initial_offsets = np.array(initial_offsets)
+            iteration_count = [0]  # List to act as a mutable counter
+
+            def objective_function(offsets):
+                for i, edge in enumerate(edges):
+                    d = Topology.Dictionary(edge)
+                    d = Dictionary.SetValueAtKey(d, offsetKey, offsets[i])
+                    edge = Topology.SetDictionary(edge, d)
+                
+                # Offset the wire
+                new_face = Face.ByOffset(face, offsetKey=offsetKey, silent=silent, numWorkers=numWorkers)
+                # Check for an illegal wire. In that case, return a very large loss value.
+                if not Topology.IsInstance(new_face, "Face"):
+                    return (float("inf"))
+                # Calculate the area of the new wire/face
+                new_area = Face.Area(new_face)
+                
+                # The objective is the difference between the target hole area and the actual hole area
+                # We want this difference to be as close to 0 as possible
+                loss = (new_area - area) ** 2
+                # If the loss is less than the tolerance, accept the result and return a loss of 0.
+                if loss < tolerance:
+                    return 0
+                # Otherwise, return the actual loss value.
+                return loss 
+            
+            # Callback function to track and display iteration number
+            def iteration_callback(xk):
+                iteration_count[0] += 1  # Increment the counter
+                if not silent:
+                    print(f"Face.ByOffsetArea - Information: Iteration {iteration_count[0]}")
+            
+            # Use scipy optimization/minimize to find the correct offsets, respecting the min/max bounds
+            result = minimize(objective_function,
+                            initial_offsets,
+                            method = "Powell",
+                            bounds=bounds,
+                            options={ 'maxiter': maxIterations},
+                            callback=iteration_callback
+                            )
+
+            # Return the offsets
+            return result.x
+        
+        if not Topology.IsInstance(face, "Face"):
+            if not silent:
+                print("Face.OffsetByArea - Error: The input face parameter is not a valid face. Returning None.")
+            return None
+        
+        edges = Topology.Edges(face)
+        # Compute the offset amounts
+        offsets = compute_offset_amounts(face,
+                                area = area,
+                                offsetKey = offsetKey,
+                                minOffsetKey = minOffsetKey,
+                                maxOffsetKey = maxOffsetKey,
+                                defaultMinOffset = defaultMinOffset,
+                                defaultMaxOffset = defaultMaxOffset,
+                                maxIterations = maxIterations,
+                                tolerance = tolerance)
+        # Set the edge dictionaries correctly according to the specified offsetKey
+        for i, edge in enumerate(edges):
+            d = Topology.Dictionary(edge)
+            d = Dictionary.SetValueAtKey(d, offsetKey, offsets[i])
+            edge = Topology.SetDictionary(edge, d)
+                
+        # Offset the face
+        return_face = Face.ByOffset(face, offsetKey=offsetKey, silent=silent, numWorkers=numWorkers)
+        if not Topology.IsInstance(face, "Face"):
+            if not silent:
+                print("Face.OffsetByArea - Error: Could not create the offset face. Returning None.")
+            return None
+        return return_face
+
     @staticmethod
     def ByShell(shell, origin= None, angTolerance: float = 0.1, tolerance: float = 0.0001, silent=False):
         """

topologicpy/Wire.py

@@ -694,7 +694,8 @@ class Wire():
                     defaultMaxOffset=1,
                     maxIterations = 1,
                     tolerance=0.0001,
-                    silent = False):
+                    silent = False,
+                    numWorkers = None):
         """
         Creates an offset wire from the input wire based on the input area.
 
@@ -720,6 +721,9 @@ class Wire():
             The desired tolerance. The default is 0.0001.
         silent : bool , optional
             If set to True, no error and warning messages are printed. Otherwise, they are. The default is False.
+        numWorkers : int , optional
+            Number of workers run in parallel to process. If you set it to 1, no parallel processing will take place.
+            The default is None which causes the algorithm to use twice the number of cpu cores in the host computer.
         
         Returns
         -------
@@ -742,7 +746,6 @@ class Wire():
                                 defaultMinOffset=0,
                                 defaultMaxOffset=1,
                                 maxIterations = 10000,
-                                maxTime = 10,
                                 tolerance=0.0001):
             
             initial_offsets = []
@@ -767,7 +770,7 @@ class Wire():
                     edge = Topology.SetDictionary(edge, d)
                 
                 # Offset the wire
-                new_wire = Wire.ByOffset(wire, offsetKey=offsetKey, silent=silent)
+                new_wire = Wire.ByOffset(wire, offsetKey=offsetKey, silent=silent, numWorkers=numWorkers)
                 # Check for an illegal wire. In that case, return a very large loss value.
                 if not Topology.IsInstance(new_wire, "Wire"):
                     return (float("inf"))
@@ -839,7 +842,7 @@ class Wire():
             edge = Topology.SetDictionary(edge, d)
                 
         # Offset the wire
-        return_wire = Wire.ByOffset(wire, offsetKey=offsetKey, silent=silent)
+        return_wire = Wire.ByOffset(wire, offsetKey=offsetKey, silent=silent, numWorkers=numWorkers)
         if not Topology.IsInstance(wire, "Wire"):
             if not silent:
                 print("Wire.OffsetByArea - Error: Could not create the offset wire. Returning None.")

topologicpy/version.py

@@ -1 +1 @@
-__version__ = '0.7.63'
+__version__ = '0.7.65'

topologicpy-0.7.65.dist-info/LICENSE

@@ -0,0 +1,16 @@
+AGPL v3 License
+
+Copyright (c) 2024 Wassim Jabi
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+details.
+
+You should have received a copy of the GNU Affero General Public License along with
+this program. If not, see <https://www.gnu.org/licenses/>.

{topologicpy-0.7.63.dist-info → topologicpy-0.7.65.dist-info}/METADATA

@@ -1,29 +1,24 @@
 Metadata-Version: 2.1
 Name: topologicpy
-Version: 0.7.63
+Version: 0.7.65
 Summary: An AI-Powered Spatial Modelling and Analysis Software Library for Architecture, Engineering, and Construction.
 Author-email: Wassim Jabi <wassim.jabi@gmail.com>
-License: MIT License
+License: AGPL v3 License
         
         Copyright (c) 2024 Wassim Jabi
         
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
+        This program is free software: you can redistribute it and/or modify it under
+        the terms of the GNU Affero General Public License as published by the Free Software
+        Foundation, either version 3 of the License, or (at your option) any later
+        version.
         
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
+        This program is distributed in the hope that it will be useful, but WITHOUT
+        ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+        FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+        details.
         
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
+        You should have received a copy of the GNU Affero General Public License along with
+        this program. If not, see <https://www.gnu.org/licenses/>.
         
 Project-URL: Homepage, https://github.com/wassimj/TopologicPy
 Project-URL: Bug Tracker, https://github.com/wassimj/TopologicPy/issues

{topologicpy-0.7.63.dist-info → topologicpy-0.7.65.dist-info}/RECORD

@@ -10,7 +10,7 @@ topologicpy/DGL.py,sha256=Dd6O08D-vSxpjHYgKm45JpKiaeGvWlg1BRMzYMAXGNc,138991
 topologicpy/Dictionary.py,sha256=cURg452wwk2WeSxWY46ncgAUo5XD1c2c5EtO6ESZHaY,27304
 topologicpy/Edge.py,sha256=FACD8Bm2nL2uTHIeRMVXfRF0cYeqhZ-lCZPHAfjAIPg,66927
 topologicpy/EnergyModel.py,sha256=NM3_nAdY9_YDtbp9CaEZ0x0xVsetTqVDzm_VSjmq_mI,53746
-topologicpy/Face.py,sha256=OyzEWdXl8yScHlyG3jDqcI31d_QlAt3SDma8AtkLQFs,116746
+topologicpy/Face.py,sha256=emRTWbaLZeU3E0MprqpltTxC4ckv42h36enOcUMcLpU,124144
 topologicpy/Graph.py,sha256=4b8bzlyXmh0Ef9rjiEjl8wmh_9vAxoE5xiSiGvGjG9Q,411392
 topologicpy/Grid.py,sha256=3-sn7CHWGcXk18XCnHjsUttNJTWwmN63g_Insj__p04,18218
 topologicpy/Helper.py,sha256=i-AfI29NMsZXBaymjilfvxQbuS3wpYbpPw4RWu1YCHs,16358
@@ -26,11 +26,11 @@ topologicpy/Sun.py,sha256=42tDWMYpwRG7Z2Qjtp94eRgBuqySq7k8TgNUZDK7QxQ,36837
 topologicpy/Topology.py,sha256=DsRPV0iWUY2NIlxdvLLDBkkDY3xw8oYvmzQEEfJUusQ,398136
 topologicpy/Vector.py,sha256=A1g83zDHep58iVPY8WQ8iHNrSOfGWFEzvVeDuMnjDNY,33078
 topologicpy/Vertex.py,sha256=bLY60YWoMsgCgHk7F7k9F93Sq2FJ6AzUcTfJ83NZfHA,71107
-topologicpy/Wire.py,sha256=x2ut3Pej3fTBv1nPzQMsJ8asWFy4WKIjrAUPA0boesU,171628
+topologicpy/Wire.py,sha256=68KGFO6jere1aj5lci0W67kDRThXLMko8oY68q-ZP_A,171939
 topologicpy/__init__.py,sha256=D7ky87CAQMiS2KE6YLvcTLkTgA2PY7rASe6Z23pjp9k,872
-topologicpy/version.py,sha256=MZJ0DcglO3LqgTS4xIW_NWvmDzvvzxd1VdjKOHudVIk,23
-topologicpy-0.7.63.dist-info/LICENSE,sha256=BRNw73R2WdDBICtwhI3wm3cxsaVqLTAGuRwrTltcfxs,1068
-topologicpy-0.7.63.dist-info/METADATA,sha256=EsGaYJ2wOBoqKTUUzAmNE_G0taxa5TW-Eg7UJzZqyYs,10920
-topologicpy-0.7.63.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-topologicpy-0.7.63.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
-topologicpy-0.7.63.dist-info/RECORD,,
+topologicpy/version.py,sha256=4-LUGtsfz8i419m9JYP1wXtHIMULgrganMwzGAvPIkU,23
+topologicpy-0.7.65.dist-info/LICENSE,sha256=FK0vJ73LuE8PYJAn7LutsReWR47-Ooovw2dnRe5yV6Q,681
+topologicpy-0.7.65.dist-info/METADATA,sha256=BzRukyNwXpaXv7OWSodC4FUsGbC5LMvLaGsAj10xvV8,10493
+topologicpy-0.7.65.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+topologicpy-0.7.65.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
+topologicpy-0.7.65.dist-info/RECORD,,

topologicpy-0.7.63.dist-info/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Wassim Jabi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.