Class WireNetwork

python/pymesh/wires/WireNetwork.py:7–328

Data structure for wire network. A wire network consists of a list of vertices and a list of edges. Thus, it is very similar to a graph except all vertices have their positions specified. Optionally, each vertex and edge could be associated with one or more attributes. Attribu

import PyMesh

class WireNetwork(object):
    """ Data structure for wire network.

    A wire network consists of a list of vertices and a list of edges.
    Thus, it is very similar to a graph except all vertices have their positions
    specified. Optionally, each vertex and edge could be associated with one or
    more attributes.

    Attributes:

        dim (``int``): The dimension of the embedding space of this wire network.
            Must be 2 or 3.

        vertices (:py:class:`numpy.ndarray`): A ``V`` by ``dim`` vertex matrix.
            One vertex per row.

        edges (:py:class:`numpy.ndarray`): A ``E`` by 2 edge matrix.
            One edge per row.

        num_vertices (``int``): The number of vertices (i.e. ``V``).

        num_edges (``int``): The number of edges (i.e. ``E``).

        bbox (:py:class:`numpy.ndarray`): A 2 by ``dim`` matrix with first and
            second rows being the minimum and maximum corners of the bounding
            box respectively.

        bbox_center (:py:class:`numpy.ndarray`): Center of the ``bbox``.

        centroid (:py:class:`numpy.ndarray`): Average of all ``vertices``.

        wire_lengths (:py:class:`numpy.ndarray`): An array of lengths of all
            edges.

        total_wire_length (``float``): Sum of ``wire_lengths``.

        attribute_names (:py:class:`list` of :py:class:`str`): The names of all
            defined attributes.
    """

    @classmethod
    def create_empty(cls):
        """ Handy factory method to create an empty wire network.
        """
        return cls()

    @classmethod
    def create_from_file(cls, wire_file):
        """ Handy factory method to load data from a file.
        """
        wire_network = cls()
        wire_network.load_from_file(wire_file)
        return wire_network

    @classmethod
    def create_from_data(cls, vertices, edges):
        """ Handy factory method to create wire network from ``vertices`` and
        ``edges``.