topologicpy 0.8.2__py3-none-any.whl → 0.8.3__py3-none-any.whl

topologicpy/Edge.py

@@ -325,6 +325,50 @@ class Edge():
             edge = None
         return edge
     
+    @staticmethod
+    def ByOriginDirectionLength(origin = None, direction=[0,0,1], length: float = 1.0, tolerance: float = 0.0001, silent: bool = False):
+        """
+        Creates a straight edge from the input parameters.
+
+        Parameters
+        ----------
+        origin : topologic_core.Vertex
+            The origin (start vertex) of the edge.
+        direction : list , optional
+            The desired direction vector of the edge. The default is [0,0,1] (pointing up in the Z direction)
+        length: float , optional
+            The desired length of edge. The default is 1.0.
+        tolerance : float , optional
+            The desired tolerance to decide if an edge can be created. 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.
+
+        Returns
+        -------
+        topologic_core.Edge
+            The created edge.
+
+        """
+        from topologicpy.Vertex import Vertex
+        from topologicpy.Topology import Topology
+
+        if origin == None:
+            origin = Vertex.Origin()
+        
+        if not Topology.IsInstance(origin, "vertex"):
+            if not silent:
+                print("Edge.ByVertexDirectionLength - Error: The input vertex parameter is not a valid vertex. Returning None.")
+            return None
+        
+        if length < tolerance:
+            if not silent:
+                print("Edge.ByVertexDirectionLength - Error: The input edge parameter must not be less than the input tolerance parameter. Returning None.")
+            return None
+
+        endVertex = Topology.TranslateByDirectionDistance(origin, direction=direction[:3], distance=length)
+        edge = Edge.ByVertices(origin, endVertex, tolerance=tolerance)
+        return edge
+
     @staticmethod
     def ByVertices(*args, tolerance: float = 0.0001, silent: bool = False):
         """

topologicpy/Matrix.py

@@ -204,6 +204,46 @@ class Matrix:
         e_vectors = Helper.Sort(e_vectors, list(eigenvalues))
         return e_values, e_vectors
     
+    @staticmethod
+    def Invert(matA, silent: bool = False):
+        """
+        Inverts the input matrix.
+
+        Parameters
+        ----------
+        matA : list of list of float
+            The input matrix.
+        silent : bool , optional
+            If set to True, no error and warning messages are printed. Otherwise, they are. The default is False.
+
+        Returns
+        -------
+        list of list of float
+            The resulting matrix after it has been inverted.
+
+        """
+        import numpy as np
+
+        if not isinstance(matA, list):
+            if not silent:
+                print("Matrix.Invert - Error: The input matA parameter is not a valid 4X4 matrix. Returning None.")
+            return None
+        np_matrix = np.array(matA)
+        if np_matrix.shape != (4, 4):
+            if not silent:
+                print("Matrix.Invert - Error: The input matA parameter is not a valid 4X4 matrix. Returning None.")
+            return None
+        
+        # Check if the matrix is invertible
+        if np.isclose(np.linalg.det(np_matrix), 0):
+            if not silent:
+                print("Matrix.Invert - Error: The input matA parameter is not invertible. Returning None.")
+            return None
+        
+        # Invert the matrix
+        inverted_matrix = np.linalg.inv(np_matrix)
+        return inverted_matrix.tolist()
+    
     @staticmethod
     def Multiply(matA, matB):
         """

topologicpy/Topology.py

@@ -4126,6 +4126,116 @@ class Topology():
             return None
         return Topology.ByXYZFile(file, frameIdKey=frameIdKey, vertexIdKey=frameIdKey)
     
+    def CanonicalMatrix(topology, n: int = 10, normalize: bool = False, mantissa: int = 6, silent: bool = False):
+        """
+        Returns the canonical matrix of the input topology.
+        The canonical matrix refers to a transformation matrix that maps an object's
+        coordinate system to a canonical coordinate frame, where:
+        . The origin of the object aligns with the world origin
+        . The principal axes of the object align with the world axes
+        This transformation is computed using Principal Component Analysis (PCA),
+        leveraging the eigenvectors of the covariance matrix of the object's vertices
+        and thus can give erroneous results. The transformation matrix may not yield an object oriented as expected.
+        
+        Parameters
+        ----------
+        topology : topologic_core.Topology
+            The input topology.
+        n : int , optional
+            The number of segments to use to increase the number of points on each face. The default is 10.
+        normalize : bool , optional
+            If set to True, the longest edge in the input topology is scaled to become of length 1. The default is False.
+        mantissa : int , optional
+            The desired length of the mantissa. The default is 6.
+        silent : bool , optional
+            If set to True, no error and warning messages are printed. Otherwise, they are. The default is False.
+        
+        Returns
+        -------
+        list
+            The 4X4 canonical matrix.
+
+        """
+        from topologicpy.Vertex import Vertex
+        from topologicpy.Edge import Edge
+        from topologicpy.CellComplex import CellComplex
+        from topologicpy.Topology import Topology
+        from topologicpy.Grid import Grid
+        from topologicpy.Matrix import Matrix
+        import numpy as np
+
+        def generate_floats(n):
+            if n < 2:
+                return [0.0] if n == 1 else []
+            return [i / (n - 1) for i in range(n)]
+
+        if not Topology.IsInstance(topology, "topology"):
+            if not silent:
+                print("Topology.CanonicalMatrix - Error: The input topology parameter is not a valid topology. Returning None.")
+            return None
+        
+        faces = Topology.Faces(topology)
+        if len(faces) == 0:
+            if not silent:
+                print("Topology.CanonicalMatrix - Error: The input topology parameter does not contain any faces. Returning None.")
+            return None
+        
+        # Step 1: Derive a copy topology to work with.
+        if Topology.IsInstance(topology, "CellComplex"):
+            top = CellComplex.ExternalBoundary(topology)
+        else:
+            top = Topology.Copy(topology)
+        
+        # Step 2: Create a Translation Matrix to translate to origin
+        centroid = Topology.Centroid(top)
+        translation_matrix = Matrix.ByTranslation(-Vertex.X(centroid, mantissa=mantissa), -Vertex.Y(centroid, mantissa=mantissa), -Vertex.Z(centroid, mantissa=mantissa))
+        translated_top = Topology.Translate(top, -Vertex.X(centroid, mantissa=mantissa), -Vertex.Y(centroid, mantissa=mantissa), -Vertex.Z(centroid, mantissa=mantissa))
+
+        # Step 3: Create a Scaling matrix to normalize size (e.g., largest edge length to 1)
+        if normalize == False:
+            scale_factor = 1.0
+        else:
+            edges = Topology.Edges(translated_top)
+            max_edge_length = max([Edge.Length(edge, mantissa=mantissa) for edge in edges])
+            scale_factor = 1.0 / max_edge_length if max_edge_length != 0 else 1.0
+        scaling_matrix = Matrix.ByScaling(scaleX=scale_factor, scaleY=scale_factor, scaleZ=scale_factor)
+        scaled_top = Topology.Scale(translated_top, origin=Vertex.Origin(), x=scale_factor, y=scale_factor, z=scale_factor)
+
+        # Step 4: Increase the number of vertices by adding a grid of points on each face.
+        faces = Topology.Faces(scaled_top)
+        vertices = Topology.Vertices(scaled_top)
+        r = generate_floats(n)
+        for face in faces:
+            vertices += Topology.Vertices(Grid.VerticesByParameters(face=face, uRange=r, vRange=r, clip=True))
+        points = np.array([[Vertex.X(v, mantissa=mantissa), Vertex.Y(v, mantissa=mantissa), Vertex.Z(v, mantissa=mantissa)] for v in vertices])
+
+        # Step 5: Align orientation using PCA
+        # Compute PCA
+        mean = points.mean(axis=0)
+        centered_points = points - mean
+        covariance_matrix = np.cov(centered_points.T)
+        eigenvalues, eigenvectors = np.linalg.eigh(covariance_matrix)
+
+        # Step 6: Sort eigenvectors by eigenvalues (largest first)
+        sorted_indices = np.argsort(-eigenvalues)
+        eigenvectors = eigenvectors[:, sorted_indices]
+
+        # Step 7: Enforce consistent orientation by flipping eigenvectors
+        for i in range(3):  # Ensure each eigenvector points in a positive direction
+            if np.dot(eigenvectors[:, i], [1, 0, 0]) < 0:
+                eigenvectors[:, i] *= -1
+        
+        # Step 8: Create the rotation matrix
+        rotation_matrix = np.eye(4)
+        rotation_matrix[:3, :3] = eigenvectors.T  # Use transpose to align points to axes
+        
+        # Step 9: Rotate the object to align it 
+        transformation_matrix = Matrix.Multiply(scaling_matrix, translation_matrix)
+        transformation_matrix = Matrix.Multiply(rotation_matrix.tolist(), transformation_matrix)
+
+        # Step 10: Return the resulting matrix
+        return transformation_matrix
+
     @staticmethod
     def CenterOfMass(topology):
         """
@@ -6833,7 +6943,7 @@ class Topology():
         originB : topologic_core.Vertex , optional
             The new location at which to place the topology. If set to None, the world origin (0, 0, 0) is used. The default is None.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6
+            The desired length of the mantissa. The default is 6.
 
         Returns
         -------
@@ -6860,6 +6970,90 @@ class Topology():
             newTopology = None
         return newTopology
 
+    @staticmethod
+    def PrincipalAxes(topology, n: int = 10, mantissa: int = 6, silent: bool = False):
+        """
+        Returns the prinicipal axes (vectors) of the input topology.
+        Please note that this is not a perfect algorithm and it can get confused based on the geometry of the input.
+        Also, please note that there is no guarantee that three returned vectors match your expectation for an x,y,z axis order.
+
+        Parameters
+        ----------
+        topology : topologic_core.Topology
+            The input topology.
+        n : int , optional
+            The number of segments to use to increase the number of points on each face. The default is 10.
+        mantissa : int , optional
+            The desired length of the mantissa. The default is 6.
+        silent : bool , optional
+            If set to True, no error and warning messages are printed. Otherwise, they are. The default is False.
+        
+        Returns
+        -------
+        list
+            The list of x, y, and z vectors representing the principal axes of the topology.
+
+        """
+        from topologicpy.Vertex import Vertex
+        from topologicpy.CellComplex import CellComplex
+        from topologicpy.Topology import Topology
+        from topologicpy.Grid import Grid
+        from topologicpy.Vector import Vector
+        import numpy as np
+
+        def generate_floats(n):
+            if n < 2:
+                return [0.0] if n == 1 else []
+            return [i / (n - 1) for i in range(n)]
+
+        
+        if not Topology.IsInstance(topology, "topology"):
+            if not silent:
+                print("Topology.CanonicalMatrix - Error: The input topology parameter is not a valid topology. Returning None.")
+            return None
+        
+        faces = Topology.Faces(topology)
+        if len(faces) == 0:
+            if not silent:
+                print("Topology.CanonicalMatrix - Error: The input topology parameter does not contain any faces. Returning None.")
+            return None
+        
+        # Step 1: Derive a copy topology to work with.
+        if Topology.IsInstance(topology, "CellComplex"):
+            top = CellComplex.ExternalBoundary(topology)
+        else:
+            top = Topology.Copy(topology)
+        
+        # Step 2: Increase the number of vertices by adding a grid of points on each face.
+        faces = Topology.Faces(top)
+        vertices = Topology.Vertices(top)
+        r = generate_floats(n)
+        for face in faces:
+            vertices += Topology.Vertices(Grid.VerticesByParameters(face=face, uRange=r, vRange=r, clip=True))
+        points = np.array([[Vertex.X(v, mantissa=mantissa), Vertex.Y(v, mantissa=mantissa), Vertex.Z(v, mantissa=mantissa)] for v in vertices])
+
+        # Step 3: Align orientation using PCA
+        # Compute PCA
+        mean = points.mean(axis=0)
+        centered_points = points - mean
+        covariance_matrix = np.cov(centered_points.T)
+        eigenvalues, eigenvectors = np.linalg.eigh(covariance_matrix)
+
+        # Sort eigenvectors by eigenvalues (largest first)
+        sorted_indices = np.argsort(-eigenvalues)
+        eigenvectors = eigenvectors[:, sorted_indices]
+
+        # Enforce consistent orientation by flipping eigenvectors
+        for i in range(3):  # Ensure each eigenvector points in a positive direction
+            if np.dot(eigenvectors[:, i], [1, 0, 0]) < 0:
+                eigenvectors[:, i] *= -1
+        
+        # Retrieve and return the principal axes
+        x_axis = Vector.ByCoordinates(*eigenvectors[:, 0])
+        y_axis = Vector.ByCoordinates(*eigenvectors[:, 1])
+        z_axis = Vector.ByCoordinates(*eigenvectors[:, 2])
+        return x_axis, y_axis, z_axis
+
     @staticmethod
     def RemoveCollinearEdges(topology, angTolerance: float = 0.1, tolerance: float = 0.0001, silent: bool = False):
         """

topologicpy/version.py

@@ -1 +1 @@
-__version__ = '0.8.2'
+__version__ = '0.8.3'

{topologicpy-0.8.2.dist-info → topologicpy-0.8.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: topologicpy
-Version: 0.8.2
+Version: 0.8.3
 Summary: An AI-Powered Spatial Modelling and Analysis Software Library for Architecture, Engineering, and Construction.
 Author-email: Wassim Jabi <wassim.jabi@gmail.com>
 License: AGPL v3 License

{topologicpy-0.8.2.dist-info → topologicpy-0.8.3.dist-info}/RECORD

@@ -8,14 +8,14 @@ topologicpy/Color.py,sha256=q9xsGmxFMz7sQKmygwSVS12GaTRB-OT0-_i6t3-cthE,20307
 topologicpy/Context.py,sha256=ppApYKngZZCQBFWaxIMi2z2dokY23c935IDCBosxDAE,3055
 topologicpy/DGL.py,sha256=M_znFtyPBJJz-iXLYZs2wwBj24fhevIo739dGha0chM,139041
 topologicpy/Dictionary.py,sha256=t0O7Du-iPq46FyKqZfcjHfsUK1E8GS_e67R2V5cpkbw,33186
-topologicpy/Edge.py,sha256=4Rl6M9ex66Q9-kNvi_Lg7UlAwdvMzpeFlxlieI3amn0,69511
+topologicpy/Edge.py,sha256=lWwJdQkAhiH5POB7TN6HSLv03g2jXHzBU7e2fE3eAno,71340
 topologicpy/EnergyModel.py,sha256=UoQ9Jm-hYsN383CbcLKw-y6BKitRHj0uyh84yQ-8ACg,53856
 topologicpy/Face.py,sha256=D1g4O5i5QMPZvIoX06Z-FsyNsYBDkCiHWJp00uqnr5o,180742
 topologicpy/Graph.py,sha256=T_NC-Gvf7F7DWdfWvQB7sQ_v790lTT74SLKTl-UhSZE,492072
 topologicpy/Grid.py,sha256=2s9cSlWldivn1i9EUz4OOokJyANveqmRe_vR93CAndI,18245
 topologicpy/Helper.py,sha256=DAAE_Ie_ekeMnCvcW08xXRwSAGCkjrS4lbz-o3ELuY4,27172
 topologicpy/Honeybee.py,sha256=Y_El6M8x3ixvvIe_VcRiwj_4C89ZZg5_WlT7adbCkpw,21849
-topologicpy/Matrix.py,sha256=QOQ7W12344hMLXfSTlJcluOm7od25LImWKKb2O0ADmg,9572
+topologicpy/Matrix.py,sha256=ydw0EH4rZcGBFeLmBHPIyuk57DVKKL3M1GcArkFsYxM,10941
 topologicpy/Neo4j.py,sha256=BKOF29fRgXmdpMGkrNzuYbyqgCJ6ElPPMYlfTxXiVbc,22392
 topologicpy/Plotly.py,sha256=Tvo0_zKVEHtPhsMNNvLy5G0HIys5FPAOyp_o4QN_I_A,115760
 topologicpy/Polyskel.py,sha256=EFsuh2EwQJGPLiFUjvtXmAwdX-A4r_DxP5hF7Qd3PaU,19829
@@ -23,14 +23,14 @@ topologicpy/PyG.py,sha256=LU9LCCzjxGPUM31qbaJXZsTvniTtgugxJY7y612t4A4,109757
 topologicpy/Shell.py,sha256=fLRnQ79vtdBDRW1Xn8Gaap34XheGbw7UBFd-ALJ2Y1g,87978
 topologicpy/Speckle.py,sha256=AlsGlSDuKRtX5jhVsPNSSjjbZis079HbUchDH_5RJmE,18187
 topologicpy/Sun.py,sha256=42tDWMYpwRG7Z2Qjtp94eRgBuqySq7k8TgNUZDK7QxQ,36837
-topologicpy/Topology.py,sha256=-7OsjGeJ64NKcEONee9SqOeh1YQ6yGHEzIPxycQCUdA,445348
+topologicpy/Topology.py,sha256=xbiMgnRrO_My5cHVMajsIuQYU81zsDy6C-7ZQgF5OFU,454552
 topologicpy/Vector.py,sha256=Cl7besf20cAGmyNPh-9gbFAHnRU5ZWSMChJ3VyFIDs4,35416
 topologicpy/Vertex.py,sha256=tv6C-rbuNgXHDGgVLT5fbalynLdXqlUuiCDKtkeQ0vk,77814
 topologicpy/Wire.py,sha256=Gl3Jpygwp8775SG57ua5r5ffTHcN4FOAkeI87yP1cok,234001
 topologicpy/__init__.py,sha256=vlPCanUbxe5NifC4pHcnhSzkmmYcs_UrZrTlVMsxcFs,928
-topologicpy/version.py,sha256=K2rsUy8S7UHe3tStL6NCs5z92apbvbkrpGIEjcCNCNs,22
-topologicpy-0.8.2.dist-info/LICENSE,sha256=FK0vJ73LuE8PYJAn7LutsReWR47-Ooovw2dnRe5yV6Q,681
-topologicpy-0.8.2.dist-info/METADATA,sha256=DBa_orJTbm3dIrzhCaCiTfsaqfvkAg1jaxCdeHFoeQA,10512
-topologicpy-0.8.2.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-topologicpy-0.8.2.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
-topologicpy-0.8.2.dist-info/RECORD,,
+topologicpy/version.py,sha256=LokQdkRCwhhLh0zOp7jizhyDgbtAU-IWRIObrz2zLjA,22
+topologicpy-0.8.3.dist-info/LICENSE,sha256=FK0vJ73LuE8PYJAn7LutsReWR47-Ooovw2dnRe5yV6Q,681
+topologicpy-0.8.3.dist-info/METADATA,sha256=Alf593hRuyD3EdVldbGvB1qklfCWf2sDcSvktEhmHn8,10512
+topologicpy-0.8.3.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
+topologicpy-0.8.3.dist-info/top_level.txt,sha256=J30bDzW92Ob7hw3zA8V34Jlp-vvsfIkGzkr8sqvb4Uw,12
+topologicpy-0.8.3.dist-info/RECORD,,