topologicpy 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

topologicpy/Plotly.py

@@ -10,6 +10,7 @@ from topologicpy.Cell import Cell
 from topologicpy.CellComplex import CellComplex
 from topologicpy.Cluster import Cluster
 from topologicpy.Topology import Topology
+import numpy as np
 
 class Plotly:
     @staticmethod
@@ -638,6 +639,7 @@ class Plotly:
             #data.append(vertexData(vertices, dictionaries=[], vertexColor=vertexColor, vertexSize=5, vertexLabelKey=vertexLabelKey, vertexGroupKey=vertexGroupKey, vertexGroups=vertexGroups))
         return data
 
+
     @staticmethod
     def FigureByConfusionMatrix(matrix,
              categories=[],
@@ -661,7 +663,92 @@ class Plotly:
 
         Parameters
         ----------
-        matrix : list
+        matrix : list or numpy.array
+            The matrix to display.
+        categories : list
+            The list of categories to use on the X and Y axes.
+        minValue : float , optional
+            The desired minimum value to use for the color scale. If set to None, the minmum value found in the input matrix will be used. The default is None.
+        maxValue : float , optional
+            The desired maximum value to use for the color scale. If set to None, the maximum value found in the input matrix will be used. The default is None.
+        title : str , optional
+            The desired title to display. The default is "Confusion Matrix".
+        xTitle : str , optional
+            The desired X-axis title to display. The default is "Actual".
+        yTitle : str , optional
+            The desired Y-axis title to display. The default is "Predicted".
+        width : int , optional
+            The desired width of the figure. The default is 950.
+        height : int , optional
+            The desired height of the figure. The default is 500.
+        showScale : bool , optional
+            If set to True, a color scale is shown on the right side of the figure. The default is True.
+        colorScale : str , optional
+            The desired type of plotly color scales to use (e.g. "Viridis", "Plasma"). The default is "Viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
+        colorSamples : int , optional
+            The number of discrete color samples to use for displaying the data. The default is 10.
+        backgroundColor : str , optional
+            The desired background color. This can be any plotly color string and may be specified as:
+            - A hex string (e.g. '#ff0000')
+            - An rgb/rgba string (e.g. 'rgb(255,0,0)')
+            - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
+            - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
+            - A named CSS color.
+            The default is 'rgba(0,0,0,0)' (transparent).
+        marginLeft : int , optional
+            The desired left margin in pixels. The default is 0.
+        marginRight : int , optional
+            The desired right margin in pixels. The default is 0.
+        marginTop : int , optional
+            The desired top margin in pixels. The default is 40.
+        marginBottom : int , optional
+            The desired bottom margin in pixels. The default is 0.
+
+        """
+
+        return Plotly.FigureByMatrix(matrix,
+             xCategories=categories,
+             minValue=minValue,
+             maxValue=maxValue,
+             title=title,
+             xTitle=xTitle,
+             yTitle=yTitle,
+             width=width,
+             height=height,
+             showScale=showScale,
+             colorScale=colorScale,
+             colorSamples=colorSamples,
+             backgroundColor=backgroundColor,
+             marginLeft=marginLeft,
+             marginRight=marginRight,
+             marginTop=marginTop,
+             marginBottom=marginBottom)
+    
+    @staticmethod
+    def FigureByMatrix(matrix,
+             xCategories=[],
+             yCategories=[],
+             minValue=None,
+             maxValue=None,
+             title="Matrix",
+             xTitle = "X Axis",
+             yTitle = "Y Axis",
+             width=950,
+             height=950,
+             showScale = False,
+             colorScale='gray',
+             colorSamples=10,
+             backgroundColor='rgba(0,0,0,0)',
+             marginLeft=0,
+             marginRight=0,
+             marginTop=40,
+             marginBottom=0):
+        """
+        Returns a Plotly Figure of the input matrix.
+
+        Parameters
+        ----------
+        matrix : list or numpy.array
             The matrix to display.
         categories : list
             The list of categories to use on the X and Y axes.
@@ -709,20 +796,27 @@ class Plotly:
 
         annotations = []
 
-        # Transpose the confusion matrix
-        matrix = matrix.T
+        if isinstance(matrix, list):
+            matrix = np.array(matrix)
         colors = px.colors.sample_colorscale(colorScale, [n/(colorSamples -1) for n in range(colorSamples)])
-        if not minValue:
-            minValue = 0
-        if not maxValue:
+
+        if not xCategories:
+            xCategories = [x for x in range(len(matrix[0]))]
+        if not yCategories:
+            yCategories = [y for y in range(len(matrix))]
+        
+        if not maxValue or not minValue:
             max_values = []
-            for i, row in enumerate(matrix):
+            min_values = []
+            for i in range(len(matrix)):
+                row = matrix[i]
                 max_values.append(max(row))
+                min_values.append(min(row))
                 for j, value in enumerate(row):
                     annotations.append(
                         {
-                            "x": categories[j],
-                            "y": categories[i],
+                            "x": xCategories[j],
+                            "y": yCategories[i],
                             "font": {"color": "black"},
                             "bgcolor": "white",
                             "opacity": 0.5,
@@ -732,14 +826,18 @@ class Plotly:
                             "showarrow": False
                         }
                     )
-            maxValue = max(max_values)
+            if not minValue:
+                minValueB = min(min_values)
+            if not maxValue:
+                maxValue = max(max_values)
         else:
-            for i, row in enumerate(matrix):
+            for i in range(len(matrix)):
+                row = matrix[i]
                 for j, value in enumerate(row):
                     annotations.append(
                         {
-                            "x": categories[j],
-                            "y": categories[i],
+                            "x": xCategories[j],
+                            "y": yCategories[i],
                             "font": {"color": "black"},
                             "bgcolor": "white",
                             "opacity": 0.5,
@@ -749,7 +847,15 @@ class Plotly:
                             "showarrow": False
                         }
                     )
-        data = go.Heatmap(z=matrix, y=categories, x=categories, zmin=minValue, zmax=maxValue, showscale=showScale, colorscale=colors)
+        new_matrix = []
+        for i in range(len(matrix)):
+            row = matrix[i]
+            new_row = []
+            maxRow = sum(row)
+            for j in range(len(row)):
+                new_row.append(round(float(row[j])/float(maxRow), 3))
+            new_matrix.append(new_row)
+        data = go.Heatmap(z=new_matrix, y=yCategories, x=xCategories, zmin=minValue, zmax=maxValue, showscale=showScale, colorscale=colors)
         
         layout = {
             "width": width,
@@ -763,8 +869,8 @@ class Plotly:
             "margin":dict(l=marginLeft, r=marginRight, t=marginTop, b=marginBottom)
         }
         fig = go.Figure(data=data, layout=layout)
-        fig.update_xaxes( tickvals=categories)
-        fig.update_yaxes( tickvals=categories)
+        fig.update_xaxes( tickvals=xCategories)
+        fig.update_yaxes( tickvals=yCategories)
         return fig
         
     @staticmethod

topologicpy/Topology.py

@@ -3605,19 +3605,20 @@ class Topology():
         dy = y2 - y1
         dz = z2 - z1    
         dist = math.sqrt(dx**2 + dy**2 + dz**2)
+        world_origin = Vertex.ByCoordinates(0,0,0)
+
         phi = math.degrees(math.atan2(dy, dx)) # Rotation around Y-Axis
-        if dist < tolerance:
+        if dist < 0.0001:
             theta = 0
         else:
             theta = math.degrees(math.acos(dz/dist)) # Rotation around Z-Axis
-        world_origin = Vertex.ByCoordinates(0,0,0)
-        returnTopology = Topology.Rotate(topology, world_origin, 0, 0, 1, -phi)
-        returnTopology = Topology.Rotate(returnTopology, world_origin, 0, 1, 0, -theta)
+        returnTopology = Topology.Rotate(topology, world_origin, 0, 1, 0, theta)
+        returnTopology = Topology.Rotate(returnTopology, world_origin, 0, 0, 1, phi)
         returnTopology = Topology.Place(returnTopology, world_origin, origin)
         return returnTopology
 
     @staticmethod
-    def Place(topology, oldLocation=None, newLocation=None):
+    def Place(topology, originA=None, originB=None):
         """
         Places the input topology at the specified location.
 
@@ -3625,9 +3626,9 @@ class Topology():
         ----------
         topology : topologic.Topology
             The input topology.
-        oldLocation : topologic.Vertex , optional
+        originA : topologic.Vertex , optional
             The old location to use as the origin of the movement. If set to None, the centroid of the input topology is used. The default is None.
-        newLocation : topologic.Vertex , optional
+        originB : topologic.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.
 
         Returns
@@ -3639,14 +3640,14 @@ class Topology():
         from topologicpy.Vertex import Vertex
         if not isinstance(topology, topologic.Topology):
             return None
-        if not isinstance(oldLocation, topologic.Vertex):
-            oldLocation = Topology.Centroid(topology)
-        if not isinstance(newLocation, topologic.Vertex):
-            newLocation = Vertex.ByCoordinates(0,0,0)
-
-        x = newLocation.X() - oldLocation.X()
-        y = newLocation.Y() - oldLocation.Y()
-        z = newLocation.Z() - oldLocation.Z()
+        if not isinstance(originA, topologic.Vertex):
+            originA = Topology.Centroid(topology)
+        if not isinstance(originA, topologic.Vertex):
+            originA = Vertex.ByCoordinates(0,0,0)
+
+        x = originB.X() - originA.X()
+        y = originB.Y() - originA.Y()
+        z = originB.Z() - originA.Z()
         newTopology = None
         try:
             newTopology = Topology.Translate(topology, x, y, z)
@@ -4787,6 +4788,8 @@ class Topology():
             _ = topology.Clusters(None, subTopologies)
         elif subTopologyType.lower() == "aperture":
             _ = topology.Apertures(subTopologies)
+        if not subTopologies:
+            return [] # Make sure to return an empty list instead of None
         return subTopologies
 
     
@@ -4840,6 +4843,8 @@ class Topology():
             topology.Cluster(hostTopology, superTopologies)
         else:
             return None
+        if not superTopologies:
+            return [] # Make sure you return an empty list instead of None
         return superTopologies
     
     @staticmethod
@@ -5079,7 +5084,7 @@ class Topology():
         return topologic.TopologyUtility.Translate(topology, x, y, z)
     
     @staticmethod
-    def TranslateByDirectionDistance(topology, direction, distance):
+    def TranslateByDirectionDistance(topology, direction=[0,0,0], distance=0):
         """
         Translates (moves) the input topology along the input direction by the specified distance.
 
@@ -5087,12 +5092,10 @@ class Topology():
         ----------
         topology : topologic.topology
             The input topology.
-        x : float , optional
-            The x translation value. The default is 0.
-        y : float , optional
-            The y translation value. The default is 0.
-        z : float , optional
-            The z translation value. The default is 0.
+        direction : list , optional
+            The direction vector in which the topology should be moved. The default is [0,0,0]
+        distance : float , optional
+            The distance by which the toplogy should be moved. The default is 0.
 
         Returns
         -------
@@ -5104,7 +5107,7 @@ class Topology():
         if not isinstance(topology, topologic.Topology):
             return None
         v = Vector.SetMagnitude(direction, distance)
-        return topologic.TopologyUtility.Translate(topology, v[0], v[1], v[2])
+        return Topology.Translate(topology, v[0], v[1], v[2])
 
     
     @staticmethod

topologicpy/Vertex.py

@@ -6,7 +6,7 @@ import collections
 
 class Vertex(Topology):
     @staticmethod
-    def AreIpsilateral(vertices, face):
+    def AreIpsilateral(vertices: list, face: topologic.Face) -> bool:
         """
         Returns True if the two input vertices are on the same side of the input face. Returns False otherwise. If at least one of the vertices is on the face, this method return True.
 
@@ -62,7 +62,7 @@ class Vertex(Topology):
         return True
     
     @staticmethod
-    def AreOnSameSide(vertices, face):
+    def AreOnSameSide(vertices: list, face: topologicpy.Face.Face) -> bool:
         """
         Returns True if the two input vertices are on the same side of the input face. Returns False otherwise. If at least one of the vertices is on the face, this method return True.
 
@@ -82,7 +82,7 @@ class Vertex(Topology):
         return IsIpsileteral(vertices, face)
 
     @staticmethod
-    def AreOnSameSideCluster(cluster, face):
+    def AreOnSameSideCluster(cluster: topologic.Cluster, face: topologic.Face) -> bool:
         """
         Returns True if the two input vertices are on the same side of the input face. Returns False otherwise. If at least one of the vertices is on the face, this method return True.
 
@@ -106,18 +106,18 @@ class Vertex(Topology):
         return AreIpsilateral(vertices, face)
 
     @staticmethod
-    def ByCoordinates(x, y, z):
+    def ByCoordinates(x: float = 0, y: float = 0, z: float = 0) -> topologic.Vertex:
         """
         Creates a vertex at the coordinates specified by the x, y, z inputs.
 
         Parameters
         ----------
-        x : float
-            The X coordinate.
-        y : float
-            The Y coordinate.
-        z : float
-            The Z coodinate.
+        x : float , optional
+            The X coordinate. The default is 0.
+        y : float , optional
+            The Y coordinate. The default is 0.
+        z : float , optional
+            The Z coordinate. The defaults is 0.
 
         Returns
         -------
@@ -133,7 +133,7 @@ class Vertex(Topology):
         return vertex
     
     @staticmethod
-    def Coordinates(vertex, outputType="xyz", mantissa=4):
+    def Coordinates(vertex: topologic.Vertex, outputType: str = "xyz", mantissa: int = 4) -> list:
         """
         Returns the coordinates of the input vertex.
 
@@ -176,9 +176,8 @@ class Vertex(Topology):
                     output.append(z)
         return output
 
-    
     @staticmethod
-    def Distance(vertex, topology, mantissa=4):
+    def Distance(vertex: topologic.Vertex, topology: topologic.Topology, mantissa: int = 4) -> float:
         """
         Returns the distance between the input vertex and the input topology.
 
@@ -202,7 +201,7 @@ class Vertex(Topology):
         return round(topologic.VertexUtility.Distance(vertex, topology), mantissa)
     
     @staticmethod
-    def EnclosingCell(vertex, topology, exclusive=True, tolerance=0.0001):
+    def EnclosingCell(vertex: topologic.Vertex, topology: topologic.Topology, exclusive: bool = True, tolerance: float = 0.0001) -> list:
         """
         Returns the list of Cells found in the input topology that enclose the input vertex.
 
@@ -257,7 +256,7 @@ class Vertex(Topology):
         return enclosingCells
 
     @staticmethod
-    def Index(vertex, vertices, strict=False, tolerance=0.0001):
+    def Index(vertex: topologic.Vertex, vertices: list, strict: bool = False, tolerance: float = 0.0001) -> int:
         """
         Returns index of the input vertex in the input list of vertices
 
@@ -291,12 +290,13 @@ class Vertex(Topology):
                 if Topology.IsSame(vertex, vertices[i]):
                     return i
             else:
-                if Vertex.Distance(vertex, vertices[i]) < tolerance:
+                d = Vertex.Distance(vertex, vertices[i])
+                if d < tolerance:
                     return i
         return None
 
     @staticmethod
-    def IsInside(vertex, topology, tolerance=0.0001):
+    def IsInside(vertex: topologic.Vertex, topology: topologic.Topology, tolerance: float = 0.0001) -> bool:
         """
         Returns True if the input vertex is inside the input topology. Returns False otherwise.
 
@@ -372,7 +372,7 @@ class Vertex(Topology):
         return False
     
     @staticmethod
-    def NearestVertex(vertex, topology, useKDTree=True):
+    def NearestVertex(vertex: topologic.Vertex, topology: topologic.Topology, useKDTree: bool = True) -> topologic.Vertex:
         """
         Returns the vertex found in the input topology that is the nearest to the input vertex.
 
@@ -514,9 +514,22 @@ class Vertex(Topology):
             sorted_indices = [x for _, x in sorted(zip(distances, indices))]
         return vertices[sorted_indices[0]]
 
+    @staticmethod
+    def Origin() -> topologic.Vertex:
+        """
+        Returns a vertex with coordinates (0,0,0)
+
+        Parameters
+        -----------
+
+        Return
+        -----------
+        topologic.Vertex
+        """
+        return Vertex.ByCoordinates(0,0,0)
     
     @staticmethod
-    def Project(vertex, face, direction=None, mantissa=4, tolerance=0.0001):
+    def Project(vertex: topologic.Vertex, face: topologic.Face, direction: bool = None, mantissa: int = 4, tolerance: float = 0.0001) -> topologic.Vertex:
         """
         Returns a vertex that is the projection of the input vertex unto the input face.
 
@@ -567,7 +580,7 @@ class Vertex(Topology):
             return None
 
     @staticmethod
-    def X(vertex, mantissa=4):
+    def X(vertex: topologic.Vertex, mantissa: int = 4) -> float:
         """
         Returns the X coordinate of the input vertex.
 
@@ -589,7 +602,7 @@ class Vertex(Topology):
         return round(vertex.X(), mantissa)
 
     @staticmethod
-    def Y(vertex, mantissa=4):
+    def Y(vertex: topologic.Vertex, mantissa: int = 4) -> float:
         """
         Returns the Y coordinate of the input vertex.
 
@@ -611,7 +624,7 @@ class Vertex(Topology):
         return round(vertex.Y(), mantissa)
 
     @staticmethod
-    def Z(vertex, mantissa=4):
+    def Z(vertex: topologic.Vertex, mantissa: int = 4) -> float:
         """
         Returns the Z coordinate of the input vertex.