topologicpy 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

topologicpy/Plotly.py

@@ -92,7 +92,7 @@ class Plotly:
         edgeGroupKey : str , optional
             The dictionary key to use to display the edge group. The default is None.
         edgeColor : str , optional
-            The desired color of the output wires (edges). This can be any plotly color string and may be specified as:
+            The desired color of the output edges. 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%)')
@@ -250,14 +250,14 @@ class Plotly:
         return data
 
     @staticmethod
-    def DataByTopology(topology, vertexLabelKey=None, vertexGroupKey=None, edgeLabelKey=None, edgeGroupKey=None, faceLabelKey=None, faceGroupKey=None, vertexGroups=[], edgeGroups=[], faceGroups=[], faceColor="white", faceOpacity=0.5, edgeColor="black", edgeWidth=1, vertexColor="black", vertexSize=1.1, showFaces=True, showEdges=True, showVertices=True):
+    def DataByTopology(topology, vertexLabelKey=None, vertexGroupKey=None, edgeLabelKey=None, edgeGroupKey=None, faceLabelKey=None, faceGroupKey=None, vertexGroups=[], edgeGroups=[], faceGroups=[], faceColor="white", faceOpacity=0.5, edgeColor="black", edgeWidth=1, vertexColor="black", vertexSize=1.1, showFaces=True, showEdges=True, showVertices=True, verticesLabel="Topology Vertices", edgesLabel="Topology Edges", facesLabel="Topology Faces"):
         """
-        Creates plotly face, wire, and vertex data.
+        Creates plotly face, edge, and vertex data.
 
         Parameters
         ----------
         topology : topologic.Topology
-            The input topology. This must contain faces and or wires.
+            The input topology. This must contain faces and or edges.
         vertexLabelKey : str , optional
             The dictionary key to use to display the vertex label. The default is None.
         vertexGroupKey : str , optional
@@ -287,7 +287,7 @@ class Plotly:
         faceOpacity : float , optional
             The desired opacity of the output faces (0=transparent, 1=opaque). The default is 0.5.
         edgeColor : str , optional
-            The desired color of the output wires (edges). This can be any plotly color string and may be specified as:
+            The desired color of the output edges. 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%)')
@@ -312,7 +312,12 @@ class Plotly:
             If set to True the edges will be drawn. Otherwise, they will not be drawn. The default is True.
         showVertices : bool , optional
             If set to True the vertices will be drawn. Otherwise, they will not be drawn. The default is True.
-
+        verticesLabel : str , optional
+            The legend label string used to identify vertices. The default is "Topology Vertices".
+        edgesLabel : str , optional
+            The legend label string used to identify edges. The default is "Topology Edges".
+        facesLabel : str , optional
+            The legend label string used to idenitfy edges. The default is "Topology Faces".
         Returns
         -------
         list
@@ -322,7 +327,7 @@ class Plotly:
         from topologicpy.Topology import Topology
         from topologicpy.Dictionary import Dictionary
 
-        def vertexData(vertices, dictionaries=None, vertexColor="black", vertexSize=1.1, vertexLabelKey=None, vertexGroupKey=None, vertexGroups=[]):
+        def vertexData(vertices, dictionaries=None, vertexColor="black", vertexSize=1.1, vertexLabelKey=None, vertexGroupKey=None, vertexGroups=[], verticesLabel="Topology Vertices"):
             x = []
             y = []
             z = []
@@ -368,7 +373,7 @@ class Plotly:
             return go.Scatter3d(x=x,
                                 y=y,
                                 z=z,
-                                name='Topology Vertices',
+                                name=verticesLabel,
                                 showlegend=True,
                                 marker=dict(color=v_groupList,  size=vertexSize),
                                 mode='markers',
@@ -378,7 +383,7 @@ class Plotly:
                                 hoverinfo='text',
                                 hovertext=v_labels)
 
-        def edgeData(vertices, edges, dictionaries=None, edgeColor="black", edgeWidth=1, edgeLabelKey=None, edgeGroupKey=None, edgeGroups=[]):
+        def edgeData(vertices, edges, dictionaries=None, edgeColor="black", edgeWidth=1, edgeLabelKey=None, edgeGroupKey=None, edgeGroups=[], edgesLabel="Topology Edges"):
             x = []
             y = []
             z = []
@@ -427,7 +432,7 @@ class Plotly:
             return go.Scatter3d(x=x,
                                 y=y,
                                 z=z,
-                                name="Topology Edges",
+                                name=edgesLabel,
                                 showlegend=True,
                                 marker_size=0,
                                 mode="lines",
@@ -554,7 +559,7 @@ class Plotly:
                 ev = Edge.EndVertex(tp_edge)
                 ei = Vertex.Index(ev, tp_verts)
                 edges.append([si, ei])
-            data.append(edgeData(vertices, edges, dictionaries=[], edgeColor=edgeColor, edgeWidth=edgeWidth, edgeLabelKey=edgeLabelKey, edgeGroupKey=edgeGroupKey, edgeGroups=edgeGroups))
+            data.append(edgeData(vertices, edges, dictionaries=[], edgeColor=edgeColor, edgeWidth=edgeWidth, edgeLabelKey=edgeLabelKey, edgeGroupKey=edgeGroupKey, edgeGroups=edgeGroups, edgesLabel=edgesLabel))
         if showFaces and topology.Type() >= topologic.Face.Type():
             tp_faces = Topology.SubTopologies(topology, subTopologyType="face")
             triangles = []
@@ -591,6 +596,7 @@ class Plotly:
              height=500,
              showScale = True,
              colorScale='Viridis',
+             colorSamples=10,
              backgroundColor='rgba(0,0,0,0)',
              marginLeft=0,
              marginRight=0,
@@ -623,6 +629,8 @@ class Plotly:
             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')
@@ -643,9 +651,13 @@ class Plotly:
         """
         #import plotly.figure_factory as ff
         import plotly.graph_objects as go
+        import plotly.express as px
 
         annotations = []
-       
+
+        # Transpose the confusion matrix
+        matrix = matrix.T
+        colors = px.colors.sample_colorscale(colorScale, [n/(colorSamples -1) for n in range(colorSamples)])
         if not minValue:
             minValue = 0
         if not maxValue:
@@ -655,10 +667,12 @@ class Plotly:
                 for j, value in enumerate(row):
                     annotations.append(
                         {
-                            "x": categories[i],
-                            "y": categories[j],
-                            "font": {"color": "white"},
-                            "text": str(value),
+                            "x": categories[j],
+                            "y": categories[i],
+                            "font": {"color": "black"},
+                            "bgcolor": "white",
+                            "opacity": 0.5,
+                            "text": str(round(value,2)), 
                             "xref": "x1",
                             "yref": "y1",
                             "showarrow": False
@@ -670,16 +684,18 @@ class Plotly:
                 for j, value in enumerate(row):
                     annotations.append(
                         {
-                            "x": categories[i],
-                            "y": categories[j],
-                            "font": {"color": "white"},
-                            "text": str(value),
+                            "x": categories[j],
+                            "y": categories[i],
+                            "font": {"color": "black"},
+                            "bgcolor": "white",
+                            "opacity": 0.5,
+                            "text": str(round(value,2)),
                             "xref": "x1",
                             "yref": "y1",
                             "showarrow": False
                         }
                     )
-        data = go.Heatmap(z=matrix, y=categories, x=categories, zmin=minValue, zmax=maxValue, showscale=showScale, colorscale=colorScale)
+        data = go.Heatmap(z=matrix, y=categories, x=categories, zmin=minValue, zmax=maxValue, showscale=showScale, colorscale=colors)
         
         layout = {
             "width": width,
@@ -690,7 +706,7 @@ class Plotly:
             "annotations": annotations,
             "paper_bgcolor": backgroundColor,
             "plot_bgcolor": backgroundColor,
-            "margin":dict(l=marginLeft, r=marginRight, t=marginTop, b=marginBottom),
+            "margin":dict(l=marginLeft, r=marginRight, t=marginTop, b=marginBottom)
         }
         fig = go.Figure(data=data, layout=layout)
         return fig
@@ -752,7 +768,7 @@ class Plotly:
         return fig
 
     @staticmethod
-    def FigureByData(data, color=None, width=950, height=500, xAxis=False, yAxis=False, zAxis=False, backgroundColor='rgba(0,0,0,0)', marginLeft=0, marginRight=0, marginTop=20, marginBottom=0):
+    def FigureByData(data, color=None, width=950, height=500, xAxis=False, yAxis=False, zAxis=False, axisSize=1, backgroundColor='rgba(0,0,0,0)', marginLeft=0, marginRight=0, marginTop=20, marginBottom=0):
         """
         Creates a plotly figure.
 
@@ -770,6 +786,8 @@ class Plotly:
             If set to True the y axis is drawn. Otherwise it is not drawn. The default is False.
         zAxis : bool , optional
             If set to True the z axis is drawn. Otherwise it is not drawn. The default is False.
+        axisSize : float , optional
+            The size of the X,Y,Z, axes. The default is 1.
         backgroundColor : str , optional
             The desired color of the background. This can be any plotly color string and may be specified as:
             - A hex string (e.g. '#ff0000')
@@ -800,24 +818,24 @@ class Plotly:
             return None
 
         v0 = Vertex.ByCoordinates(0,0,0)
-        v1 = Vertex.ByCoordinates(1,0,0)
-        v2 = Vertex.ByCoordinates(0,1,0)
-        v3 = Vertex.ByCoordinates(0,0,1)
+        v1 = Vertex.ByCoordinates(axisSize,0,0)
+        v2 = Vertex.ByCoordinates(0,axisSize,0)
+        v3 = Vertex.ByCoordinates(0,0,axisSize)
 
         if xAxis:
             xEdge = Edge.ByVertices([v0,v1])
             xWire = Wire.ByEdges([xEdge])
-            xData = Plotly.DataByTopology(xWire, wireColor="red", wireWidth=6, drawFaces=False, drawWires=True, drawVertices=False)
+            xData = Plotly.DataByTopology(xWire, edgeColor="red", edgeWidth=6, showFaces=False, showEdges=True, showVertices=False, edgesLabel="X-Axis")
             data = data + xData
         if yAxis:
             yEdge = Edge.ByVertices([v0,v2])
             yWire = Wire.ByEdges([yEdge])
-            yData = Plotly.DataByTopology(yWire, wireColor="green", wireWidth=6, drawFaces=False, drawWires=True, drawVertices=False)
+            yData = Plotly.DataByTopology(yWire, edgeColor="green", edgeWidth=6, showFaces=False, showEdges=True, showVertices=False, edgesLabel="Y-Axis")
             data = data + yData
         if zAxis:
             zEdge = Edge.ByVertices([v0,v3])
             zWire = Wire.ByEdges([zEdge])
-            zData = Plotly.DataByTopology(zWire, wireColor="blue", wireWidth=6, drawFaces=False, drawWires=True, drawVertices=False)
+            zData = Plotly.DataByTopology(zWire, edgeColor="blue", edgeWidth=6, showFaces=False, showEdges=True, showVertices=False, edgesLabel="Z-Axis")
             data = data + zData
 
         figure = go.Figure(data=data)
@@ -946,7 +964,7 @@ class Plotly:
          'iframe_connected', 'sphinx_gallery', 'sphinx_gallery_png']
 
     @staticmethod
-    def ExportToImage(figure, filePath, format="png", width="1920", height="1080"):
+    def ExportToImage(figure, path, format="png", width="1920", height="1080"):
         """
         Exports the plotly figure to an image.
 
@@ -954,7 +972,7 @@ class Plotly:
         ----------
         figure : plotly.graph_objs._figure.Figure
             The input plotly figure.
-        filePath : str
+        path : str
             The image file path.
         format : str , optional
             The desired format. This can be any of "jpg", "jpeg", "pdf", "png", "svg", or "webp". It is case insensitive. The default is "png". 
@@ -971,13 +989,13 @@ class Plotly:
         """
         if not isinstance(figure, plotly.graph_objs._figure.Figure):
             return None
-        if not isinstance(filePath, str):
+        if not isinstance(path, str):
             return None
         if not format.lower() in ["jpg", "jpeg", "pdf", "png", "svg", "webp"]:
             return None
         returnStatus = False
         try:
-            plotly.io.write_image(figure, filePath, format=format.lower(), scale=None, width=width, height=height, validate=True, engine='auto')
+            plotly.io.write_image(figure, path, format=format.lower(), scale=None, width=width, height=height, validate=True, engine='auto')
             returnStatus = True
         except:
             returnStatus = False

topologicpy/Shell.py

@@ -187,7 +187,7 @@ class Shell(Topology):
         return Shell.ByWires(wires, triangulate=triangulate, tolerance=tolerance)
 
     @staticmethod
-    def Circle(origin=None, radius=0.5, sides=32, fromAngle=0, toAngle=360, dirX=0, dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def Circle(origin=None, radius=0.5, sides=32, fromAngle=0, toAngle=360, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates a circle.
 
@@ -203,12 +203,8 @@ class Shell(Topology):
             The angle in degrees from which to start creating the arc of the circle. The default is 0.
         toAngle : float , optional
             The angle in degrees at which to end creating the arc of the circle. The default is 360.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the circle. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the circle. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the circle. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the circle. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the pie. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -219,7 +215,7 @@ class Shell(Topology):
         topologic.Shell
             The created circle.
         """
-        return Shell.Pie(origin=origin, radiusA=radius, radiusB=0, sides=sides, rings=1, fromAngle=fromAngle, toAngle=toAngle, dirX=dirX, dirY=dirY, dirZ=dirZ, placement=placement, tolerance=tolerance)
+        return Shell.Pie(origin=origin, radiusA=radius, radiusB=0, sides=sides, rings=1, fromAngle=fromAngle, toAngle=toAngle, direction=direction, placement=placement, tolerance=tolerance)
 
     @staticmethod
     def Delaunay(vertices, face=None):
@@ -393,7 +389,7 @@ class Shell(Topology):
         return faces
 
     @staticmethod
-    def HyperbolicParaboloidRectangularDomain(origin=None, llVertex=None, lrVertex=None, ulVertex=None, urVertex=None, u=10, v=10, dirX=0, dirY=0, dirZ=1, placement="bottom"):
+    def HyperbolicParaboloidRectangularDomain(origin=None, llVertex=None, lrVertex=None, ulVertex=None, urVertex=None, u=10, v=10, direction=[0,0,1], placement="bottom"):
         """
         Creates a hyperbolic paraboloid with a rectangular domain.
 
@@ -413,14 +409,10 @@ class Shell(Topology):
             The number of segments along the X axis. The default is 10.
         v : int , optional
             The number of segments along the Y axis. The default is 10.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the circle. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the circle. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the circle. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the hyperbolic parabolid. The default is [0,0,1].
         placement : str , optional
-            The description of the placement of the origin of the circle. This can be "center", "lowerleft", "bottom". It is case insensitive. The default is "center".
+            The description of the placement of the origin of the hyperbolic parabolid. This can be "center", "lowerleft", "bottom". It is case insensitive. The default is "center".
 
         Returns
         -------
@@ -487,9 +479,9 @@ class Shell(Topology):
         x1 = 0
         y1 = 0
         z1 = 0
-        x2 = 0 + dirX
-        y2 = 0 + dirY
-        z2 = 0 + dirZ
+        x2 = 0 + direction[0]
+        y2 = 0 + direction[1]
+        z2 = 0 + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1    
@@ -505,7 +497,7 @@ class Shell(Topology):
         return returnTopology
     
     @staticmethod
-    def HyperbolicParaboloidCircularDomain(origin=None, radius=0.5, sides=36, rings=10, A=1.0, B=-1.0, dirX=0, dirY=0, dirZ=1, placement="bottom"):
+    def HyperbolicParaboloidCircularDomain(origin=None, radius=0.5, sides=36, rings=10, A=1.0, B=-1.0, direction=[0,0,1], placement="bottom"):
         """
         Creates a hyperbolic paraboloid with a circular domain. See https://en.wikipedia.org/wiki/Compactness_measure_of_a_shape
 
@@ -523,12 +515,8 @@ class Shell(Topology):
             The *A* constant in the equation z = A*x^2^ + B*y^2^. The default is 1.0.
         B : float , optional
             The *B* constant in the equation z = A*x^2^ + B*y^2^. The default is -1.0.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the circle. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the circle. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the circle. The default is 1.
+        direction : list , optional
+            The  vector representing the up direction of the hyperbolic paraboloid. The default is [0,0,1.
         placement : str , optional
             The description of the placement of the origin of the circle. This can be "center", "lowerleft", "bottom". It is case insensitive. The default is "center".
 
@@ -663,9 +651,9 @@ class Shell(Topology):
         x1 = 0
         y1 = 0
         z1 = 0
-        x2 = 0 + dirX
-        y2 = 0 + dirY
-        z2 = 0 + dirZ
+        x2 = 0 + direction[0]
+        y2 = 0 + direction[1]
+        z2 = 0 + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1    
@@ -727,7 +715,7 @@ class Shell(Topology):
         return shell.IsClosed()
 
     @staticmethod
-    def Pie(origin=None, radiusA=0.5, radiusB=0, sides=32, rings=1, fromAngle=0, toAngle=360, dirX=0, dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def Pie(origin=None, radiusA=0.5, radiusB=0, sides=32, rings=1, fromAngle=0, toAngle=360, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates a pie shape.
 
@@ -747,12 +735,8 @@ class Shell(Topology):
             The angle in degrees from which to start creating the arc of the pie. The default is 0.
         toAngle : float , optional
             The angle in degrees at which to end creating the arc of the pie. The default is 360.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the pie. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the pie. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the pie. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the pie. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the pie. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -852,9 +836,9 @@ class Shell(Topology):
         x1 = 0
         y1 = 0
         z1 = 0
-        x2 = 0 + dirX
-        y2 = 0 + dirY
-        z2 = 0 + dirZ
+        x2 = 0 + direction[0]
+        y2 = 0 + direction[1]
+        z2 = 0 + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1    
@@ -870,7 +854,7 @@ class Shell(Topology):
         return shell
 
     @staticmethod
-    def Rectangle(origin=None, width=1.0, length=1.0, uSides=2, vSides=2, dirX=0, dirY=0, dirZ=1, placement="center", tolerance=0.0001):
+    def Rectangle(origin=None, width=1.0, length=1.0, uSides=2, vSides=2, direction=[0,0,1], placement="center", tolerance=0.0001):
         """
         Creates a rectangle.
 
@@ -886,12 +870,8 @@ class Shell(Topology):
             The number of sides along the width. The default is 2.
         vSides : int , optional
             The number of sides along the length. The default is 2.
-        dirX : float , optional
-            The X component of the vector representing the up direction of the rectangle. The default is 0.
-        dirY : float , optional
-            The Y component of the vector representing the up direction of the rectangle. The default is 0.
-        dirZ : float , optional
-            The Z component of the vector representing the up direction of the rectangle. The default is 1.
+        direction : list , optional
+            The vector representing the up direction of the rectangle. The default is [0,0,1].
         placement : str , optional
             The description of the placement of the origin of the rectangle. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
         tolerance : float , optional
@@ -922,16 +902,16 @@ class Shell(Topology):
         for i in range(uSides):
             for j in range(vSides):
                 rOrigin = Vertex.ByCoordinates(i*uOffset - wOffset, j*vOffset - lOffset, 0)
-                w = Wire.Rectangle(origin=rOrigin, width=uOffset, length=vOffset, dirX=0, dirY=0, dirZ=1, placement="lowerleft", tolerance=tolerance)
+                w = Wire.Rectangle(origin=rOrigin, width=uOffset, length=vOffset, placement="lowerleft", tolerance=tolerance)
                 f = Face.ByWire(w)
                 faces.append(f)
         shell = Shell.ByFaces(faces)
         x1 = origin.X()
         y1 = origin.Y()
         z1 = origin.Z()
-        x2 = origin.X() + dirX
-        y2 = origin.Y() + dirY
-        z2 = origin.Z() + dirZ
+        x2 = origin.X() + direction[0]
+        y2 = origin.Y() + direction[1]
+        z2 = origin.Z() + direction[2]
         dx = x2 - x1
         dy = y2 - y1
         dz = z2 - z1