:class:`Points`
===============

.. py:class:: ansys.dpf.core.geometry.Points(coordinates, server=None)

   Collection of DPF points.

   This can be a single point or a cloud of points.

   :param coordinates: Coordinates of the points in a 3D space.
   :type coordinates: array, list, Field
   :param server: Server with the channel connected to the remote or local instance. The
                  default is ``None``, in which case an attempt is made to use the global
                  server.
   :type server: :class:`ansys.dpf.core.server`, optional

   .. rubric:: Examples

   Create Points object with two points, print object information and plot.

   >>> from ansys.dpf.core.geometry import Points
   >>> points = Points([[0, 0, 0], [1, 0, 0]])
   >>> print(points)
   DPF Points object:
   Number of points: 2
   Coordinates:
     [0. 0. 0.]
     [1. 0. 0.]
   >>> points.plot()






.. py:currentmodule:: Points

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~plot`
            - Visualize Points object. If provided, ``mesh`` will be also plotted.


   .. tab-item:: Properties

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~coordinates`
            - Coordinates of the Points.
          * - :py:attr:`~n_points`
            - Total number of points.
          * - :py:attr:`~dimension`
            - Dimension of the Points object space.




   .. tab-item:: Special methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~__getitem__`
            - Retrieve coordinates data corresponding to a given value.
          * - :py:attr:`~__len__`
            - Retrieve the number of points.
          * - :py:attr:`~__str__`
            - Print Points information.




Import detail
-------------

.. code-block:: python

    from ansys.dpf.core.geometry import Points

Property detail
---------------

.. py:property:: coordinates

   Coordinates of the Points.

.. py:property:: n_points

   Total number of points.

.. py:property:: dimension

   Dimension of the Points object space.




Method detail
-------------

.. py:method:: __getitem__(value)

   Retrieve coordinates data corresponding to a given value.


.. py:method:: __len__()

   Retrieve the number of points.


.. py:method:: __str__()

   Print Points information.


.. py:method:: plot(mesh=None, **kwargs)

   Visualize Points object. If provided, ``mesh`` will be also plotted.