topologicpy 0.8.46__py3-none-any.whl → 0.8.47__py3-none-any.whl

topologicpy/CellComplex.py

@@ -59,25 +59,25 @@ class CellComplex():
         Parameters
         ----------
         origin : topologic_core.Vertex , optional
-            The origin location of the box. The default is None which results in the box being placed at (0, 0, 0).
+            The origin location of the box. Default is None which results in the box being placed at (0, 0, 0).
         width : float , optional
-            The width of the box. The default is 1.
+            The width of the box. Default is 1.
         length : float , optional
-            The length of the box. The default is 1.
+            The length of the box. Default is 1.
         height : float , optional
             The height of the box.
         uSides : int , optional
-            The number of sides along the width. The default is 1.
+            The number of sides along the width. Default is 1.
         vSides : int, optional
-            The number of sides along the length. The default is 1.
+            The number of sides along the length. Default is 1.
         wSides : int , optional
-            The number of sides along the height. The default is 1.
+            The number of sides along the height. Default is 1.
         direction : list , optional
-            The vector representing the up direction of the box. The default is [0, 0, 1].
+            The vector representing the up direction of the box. Default is [0, 0, 1].
         placement : str , optional
-            The description of the placement of the origin of the box. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
+            The description of the placement of the origin of the box. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         
         Returns
         -------
@@ -100,11 +100,11 @@ class CellComplex():
         cells : list
             The list of input cells.
         transferDictionaries : bool , optional
-            If set to True, any dictionaries in the cells are transferred to the CellComplex. Otherwise, they are not. The default is False.
+            If set to True, any dictionaries in the cells are transferred to the CellComplex. Otherwise, they are not. Default is False.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------
@@ -176,7 +176,7 @@ class CellComplex():
         cluster : topologic_core.Cluster
             The input cluster of cells.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -203,9 +203,9 @@ class CellComplex():
         faces : list
             The input faces.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------
@@ -270,7 +270,7 @@ class CellComplex():
         cluster : topologic_core.Cluster
             The input cluster of faces.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -296,9 +296,9 @@ class CellComplex():
         wires : list
             The input list of wires. The list should contain a minimum of two wires. All wires must have the same number of edges.
         triangulate : bool , optional
-            If set to True, the faces will be triangulated. The default is True.
+            If set to True, the faces will be triangulated. Default is True.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -407,9 +407,9 @@ class CellComplex():
         cluster : topologic_core.Cluster
             The input cluster of wires.
         triangulate : bool , optional
-            If set to True, the faces will be triangulated. The default is True.
+            If set to True, the faces will be triangulated. Default is True.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -461,21 +461,21 @@ class CellComplex():
         Parameters
         ----------
         origin : topologic_core.Vertex , optional
-            The origin location of the cube. The default is None which results in the cube being placed at (0, 0, 0).
+            The origin location of the cube. Default is None which results in the cube being placed at (0, 0, 0).
         size : float , optional
-            The size of the cube. The default is 1.
+            The size of the cube. Default is 1.
         uSides : int , optional
-            The number of sides along the width. The default is 1.
+            The number of sides along the width. Default is 1.
         vSides : int, optional
-            The number of sides along the length. The default is 1.
+            The number of sides along the length. Default is 1.
         wSides : int , optional
-            The number of sides along the height. The default is 1.
+            The number of sides along the height. Default is 1.
         direction : list , optional
-            The vector representing the up direction of the cube. The default is [0, 0, 1].
+            The vector representing the up direction of the cube. Default is [0, 0, 1].
         placement : str , optional
-            The description of the placement of the origin of the cube. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
+            The description of the placement of the origin of the cube. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         
         Returns
         -------
@@ -498,9 +498,9 @@ class CellComplex():
         cellComplex : topologic_core.CellComplex
             the input cellComplex.
         tiltAngle : float , optional
-            The threshold tilt angle in degrees to determine if a face is vertical, horizontal, or tilted. The tilt angle is measured from the nearest cardinal direction. The default is 10.
+            The threshold tilt angle in degrees to determine if a face is vertical, horizontal, or tilted. The tilt angle is measured from the nearest cardinal direction. Default is 10.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -643,7 +643,7 @@ class CellComplex():
             The input list of vertices to use for delaunay triangulation. If set to None, the algorithm uses the vertices of the input cell parameter.
             if both are set to none, a unit cube centered around the origin is used.
         tolerance : float , optional
-            the desired tolerance. The default is 0.0001.
+            the desired tolerance. Default is 0.0001.
         
         Returns
         -------
@@ -835,15 +835,15 @@ class CellComplex():
         Parameters
         ----------
         origin : topologic_core.Vertex , optional
-            The origin location of the octahedron. The default is None which results in the octahedron being placed at (0, 0, 0).
+            The origin location of the octahedron. Default is None which results in the octahedron being placed at (0, 0, 0).
         radius : float , optional
-            The radius of the octahedron's circumscribed sphere. The default is 0.5.
+            The radius of the octahedron's circumscribed sphere. Default is 0.5.
         direction : list , optional
-            The vector representing the up direction of the octahedron. The default is [0, 0, 1].
+            The vector representing the up direction of the octahedron. Default is [0, 0, 1].
         placement : str , optional
-            The description of the placement of the origin of the octahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
+            The description of the placement of the origin of the octahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         
         Returns
         -------
@@ -899,27 +899,27 @@ class CellComplex():
         Parameters
         ----------
         origin : topologic_core.Vertex , optional
-            The origin location of the prism. The default is None which results in the prism being placed at (0, 0, 0).
+            The origin location of the prism. Default is None which results in the prism being placed at (0, 0, 0).
         width : float , optional
-            The width of the prism. The default is 1.
+            The width of the prism. Default is 1.
         length : float , optional
-            The length of the prism. The default is 1.
+            The length of the prism. Default is 1.
         height : float , optional
             The height of the prism.
         uSides : int , optional
-            The number of sides along the width. The default is 1.
+            The number of sides along the width. Default is 1.
         vSides : int , optional
-            The number of sides along the length. The default is 1.
+            The number of sides along the length. Default is 1.
         wSides : int , optional
-            The number of sides along the height. The default is 1.
+            The number of sides along the height. Default is 1.
         direction : list , optional
-            The vector representing the up direction of the prism. The default is [0, 0, 1].
+            The vector representing the up direction of the prism. Default is [0, 0, 1].
         placement : str , optional
-            The description of the placement of the origin of the prism. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
+            The description of the placement of the origin of the prism. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         
         Returns
         -------
@@ -999,11 +999,11 @@ class CellComplex():
         cellComplex : topologic_core.CellComplex
             The input cellComplex.
         angTolerance : float , optional
-            The desired angular tolerance. The default is 0.1.
+            The desired angular tolerance. Default is 0.1.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-                If set to True, error and warning messages are suppressed. The default is False.
+                If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------
@@ -1087,21 +1087,21 @@ class CellComplex():
         Parameters
         ----------
         origin : topologic_core.Vertex , optional
-            The origin location of the tetrahedron. The default is None which results in the tetrahedron being placed at (0, 0, 0).
+            The origin location of the tetrahedron. Default is None which results in the tetrahedron being placed at (0, 0, 0).
         length : float , optional
-            The length of the edge of the tetrahedron. The default is 1.
+            The length of the edge of the tetrahedron. Default is 1.
         depth : int , optional
             The desired maximum number of recrusive subdivision levels.
         direction : list , optional
-            The vector representing the up direction of the tetrahedron. The default is [0, 0, 1].
+            The vector representing the up direction of the tetrahedron. Default is [0, 0, 1].
         placement : str , optional
-            The description of the placement of the origin of the tetrahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
+            The description of the placement of the origin of the tetrahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -1234,21 +1234,21 @@ class CellComplex():
         Parameters
         ----------
         origin : topologic_core.Vertex , optional
-            The origin location of the torus. The default is None which results in the torus being placed at (0, 0, 0).
+            The origin location of the torus. Default is None which results in the torus being placed at (0, 0, 0).
         majorRadius : float , optional
-            The major radius of the torus. The default is 0.5.
+            The major radius of the torus. Default is 0.5.
         minorRadius : float , optional
-            The minor radius of the torus. The default is 0.1.
+            The minor radius of the torus. Default is 0.1.
         uSides : int , optional
-            The number of sides along the longitude of the torus. The default is 16.
+            The number of sides along the longitude of the torus. Default is 16.
         vSides : int , optional
-            The number of sides along the latitude of the torus. The default is 8.
+            The number of sides along the latitude of the torus. Default is 8.
         direction : list , optional
-            The vector representing the up direction of the torus. The default is [0, 0, 1].
+            The vector representing the up direction of the torus. Default is [0, 0, 1].
         placement : str , optional
-            The description of the placement of the origin of the torus. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
+            The description of the placement of the origin of the torus. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -1319,7 +1319,7 @@ class CellComplex():
         cellComplex : topologic_core.CellComplex
             The input cellComplex.
         manitssa: int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
 
         Returns
         -------
@@ -1352,9 +1352,9 @@ class CellComplex():
             The input list of vertices to use for voronoi partitioning. If set to None, the algorithm uses the vertices of the input cell parameter.
             if both are set to none, a unit cube centered around the origin is used.
         cell : topologic_core.Cell , optional
-            The input bounding cell. If set to None, an axes-aligned bounding cell is created from the list of vertices. The default is None.
+            The input bounding cell. If set to None, an axes-aligned bounding cell is created from the list of vertices. Default is None.
         tolerance : float , optional
-            the desired tolerance. The default is 0.0001.
+            the desired tolerance. Default is 0.0001.
         
 
         Returns

topologicpy/Cluster.py

@@ -76,9 +76,9 @@ class Cluster():
                 The method will attempt to evaluate Y based on the specified xRange.
                 xRange and yRange CANNOT be None or unspecified at the same time. One or the other must be specified.
         xString : str , optional
-            The string used to represent the X independent variable. The default is 'X' (uppercase).
+            The string used to represent the X independent variable. Default is 'X' (uppercase).
         yString : str , optional
-            The string used to represent the Y independent variable. The default is 'Y' (uppercase).
+            The string used to represent the Y independent variable. Default is 'Y' (uppercase).
 
         Returns:
             topologic_core.Cluster
@@ -152,9 +152,9 @@ class Cluster():
         *topologies : topologic_core.Topology
             One or more instances of `topologic_core.Topology` to be processed.
         transferDictionaries : bool , optional
-            If set to True, the dictionaries from the input topologies are merged and transferred to the cluster. Otherwise they are not. The default is False.
+            If set to True, the dictionaries from the input topologies are merged and transferred to the cluster. Otherwise they are not. Default is False.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -287,14 +287,14 @@ class Cluster():
             The input list of topologies to be clustered.
         selectors : list , optional
             If the list of topologies are not vertices then please provide a corresponding list of selectors (vertices) that represent the topologies for clustering. For example, these can be the centroids of the topologies.
-            If set to None, the list of topologies is expected to be a list of vertices. The default is None.
+            If set to None, the list of topologies is expected to be a list of vertices. Default is None.
         keys : list, optional
             The keys in the embedded dictionaries in the topologies. If specified, the values at these keys will be added to the dimensions to be clustered. The values must be numeric. If you wish the x, y, z location to be included,
-            make sure the keys list includes "X", "Y", and/or "Z" (case insensitive). The default is ["x", "y", "z"]
+            make sure the keys list includes "X", "Y", and/or "Z" (case insensitive). Default is ["x", "y", "z"]
         epsilon : float , optional
-            The maximum radius around a data point within which other points are considered to be part of the same sense region (cluster). The default is 0.5. 
+            The maximum radius around a data point within which other points are considered to be part of the same sense region (cluster). Default is 0.5. 
         minSamples : int , optional
-            The minimum number of points required to form a dense region (cluster). The default is 2.
+            The minimum number of points required to form a dense region (cluster). Default is 2.
 
         Returns
         -------
@@ -517,7 +517,7 @@ class Cluster():
         cluster : topologic_core.Cluster
             The input cluster.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -564,7 +564,7 @@ class Cluster():
         cluster : topologic_core.Cluster
             The input cluster.
         tolerance : float, optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -610,7 +610,7 @@ class Cluster():
         cluster : topologic_core.Cluster
             The input cluster.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -656,7 +656,7 @@ class Cluster():
         cluster : topologic_core.Cluster
             The input cluster.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -702,7 +702,7 @@ class Cluster():
         cluster : topologic_core.Cluster
             The input cluster.
         tolerance : float, optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -748,7 +748,7 @@ class Cluster():
         cluster : topologic_core.Cluster
             The input cluster.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -794,7 +794,7 @@ class Cluster():
         cluster : topologic_core.Cluster
             The input cluster.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -866,16 +866,16 @@ class Cluster():
             The input list of topologies. If this is not a list of topologic vertices then please provide a list of selectors
         selectors : list , optional
             If the list of topologies are not vertices then please provide a corresponding list of selectors (vertices) that represent the topologies for clustering. For example, these can be the centroids of the topologies.
-            If set to None, the list of topologies is expected to be a list of vertices. The default is None.
+            If set to None, the list of topologies is expected to be a list of vertices. Default is None.
         keys : list, optional
             The keys in the embedded dictionaries in the topologies. If specified, the values at these keys will be added to the dimensions to be clustered. The values must be numeric. If you wish the x, y, z location to be included,
-            make sure the keys list includes "X", "Y", and/or "Z" (case insensitive). The default is ["x", "y", "z"]
+            make sure the keys list includes "X", "Y", and/or "Z" (case insensitive). Default is ["x", "y", "z"]
         k : int , optional
-            The desired number of clusters. The default is 4.
+            The desired number of clusters. Default is 4.
         maxIterations : int , optional
             The desired maximum number of iterations for the clustering algorithm
         centroidKey : str , optional
-            The desired dictionary key under which to store the cluster's centroid (this is not to be confused with the actual geometric centroid of the cluster). The default is "k_centroid"
+            The desired dictionary key under which to store the cluster's centroid (this is not to be confused with the actual geometric centroid of the cluster). Default is "k_centroid"
 
         Returns
         -------
@@ -1046,7 +1046,7 @@ class Cluster():
         cells : list
             The input list of cells.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -1114,21 +1114,21 @@ class Cluster():
         wire : topologic_core.Wire , optional
             The input Wire. if set to None, a circle with the input parameters is created. Otherwise, the input parameters are ignored.
         origin : topologic_core.Vertex , optional
-            The location of the origin of the circle. The default is None which results in the circle being placed at (0, 0, 0).
+            The location of the origin of the circle. Default is None which results in the circle being placed at (0, 0, 0).
         radius : float , optional
-            The radius of the mystic rose. The default is 1.
+            The radius of the mystic rose. Default is 1.
         sides : int , optional
-            The number of sides of the mystic rose. The default is 16.
+            The number of sides of the mystic rose. Default is 16.
         perimeter : bool , optional
-            If True, the perimeter edges are included in the output. The default is True.
+            If True, the perimeter edges are included in the output. Default is True.
         direction : list , optional
-            The vector representing the up direction of the mystic rose. The default is [0, 0, 1].
+            The vector representing the up direction of the mystic rose. Default is [0, 0, 1].
         placement : str , optional
-            The description of the placement of the origin of the mystic rose. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
+            The description of the placement of the origin of the mystic rose. This can be "center", or "lowerleft". It is case insensitive. Default is "center".
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------
@@ -1264,21 +1264,21 @@ class Cluster():
         Parameters
         ----------
         size : float , optional
-            The desired size of the tripod. The default is 1.0.
+            The desired size of the tripod. Default is 1.0.
         radius : float , optional
-            The desired radiues of the tripod. The default is 0.03
+            The desired radiues of the tripod. Default is 0.03
         sides : int , optional
-            The desired number of sides of the tripod. The default is 4.
+            The desired number of sides of the tripod. Default is 4.
         faceColorKey : str , optional
             The dictionary key under which to store the colors of the axes.
         xColor : str , optional
-            The color to use for the X axis. The default is "red".
+            The color to use for the X axis. Default is "red".
         yColor : str , optional
-            The color to use for the Y axis. The default is "green".
+            The color to use for the Y axis. Default is "green".
         zColor : str , optional
-            The color to use for the Z axis. The default is "blue".
+            The color to use for the Z axis. Default is "blue".
         matrix : list , optional
-            The desired 4X4 transformation matrix to use for transforming the tripod. The default is None which means the tripod will be placed at the origin and will be axis-aligned. 
+            The desired 4X4 transformation matrix to use for transforming the tripod. Default is None which means the tripod will be placed at the origin and will be axis-aligned. 
 
         Returns
         -------

topologicpy/Color.py

@@ -175,7 +175,7 @@ class Color:
         color : str
             A CSS named color.
         alpha : float , optional
-            THe desired alpha (transparency value). The default is None which means no alpha value will be included in the returned list.
+            THe desired alpha (transparency value). Default is None which means no alpha value will be included in the returned list.
 
         Returns
         -------
@@ -224,7 +224,7 @@ class Color:
         hex : str
             A hexadecimal color string in the format '#RRGGBB'.
         alpha : float , optional
-            The transparency value. 0.0 means the color is fully transparent, 1.0 means the color is fully opaque. The default is None
+            The transparency value. 0.0 means the color is fully transparent, 1.0 means the color is fully opaque. Default is None
             which means no transparency value will be included in the returned color.
         Returns
         -------
@@ -259,17 +259,17 @@ class Color:
         Parameters
         ----------
         value : float , optional
-            The input value. The default is 0.5.
+            The input value. Default is 0.5.
         minValue : float , optional
-            the input minimum value. The default is 0.0.
+            the input minimum value. Default is 0.0.
         maxValue : float , optional
-            The input maximum value. The default is 1.0.
+            The input maximum value. Default is 1.0.
         alpha : float , optional
-            The alpha (transparency) value. 0.0 means the color is fully transparent, 1.0 means the color is fully opaque. The default is 1.0.
+            The alpha (transparency) value. 0.0 means the color is fully transparent, 1.0 means the color is fully opaque. Default is 1.0.
         useAlpha : bool , optional
             If set to True, the returns list includes the alpha value as a fourth element in the list.
         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/.
+            The desired type of plotly color scales to use (e.g. "Viridis", "Plasma"). Default is "Viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
 
         Returns
         -------
@@ -548,7 +548,7 @@ class Color:
         color : list
             The input color list. This is assumed to be in the format [r, g, b] or [r, g, b, a] where the range is from 0 to 255.
         alpha : float , optional
-            The transparency value. 0.0 means the color is fully transparent, 1.0 means the color is fully opaque. The default is 1.0.
+            The transparency value. 0.0 means the color is fully transparent, 1.0 means the color is fully opaque. Default is 1.0.
         useAlpha : bool , optional
             If set to True, the returns list includes the alpha value as a fourth element in the list.