vectorose.data
==============

.. py:module:: vectorose.data

.. autoapi-nested-parse::

   Sample datasets for running VectoRose.

   This module grants access to the sample data used in the documentation.
   These datasets may be loaded and accessed as NumPy arrays without requiring
   any external download.

   .. warning::

      This module does not exist as an automatic top-level import in vectorose,
      and must therefore be explicitly imported.



Classes
-------

.. autoapisummary::

   vectorose.data.SampleData


Package Contents
----------------

.. py:class:: SampleData

   Bases: :py:obj:`enum.Enum`


   Interface for accessing sample datasets.

   This enumeration provides a list of sample datasets provided with
   VectoRose, as well as a simple interface to load them. The string
   values associated with each enumerated instance correspond to the base
   filename for the respective dataset.

   .. warning:: All datasets are assumed to be stored as a NumPy array (``*.npy``).

   .. rubric:: Notes

   This system is used to ensure the flexibility to easily add new sample
   data in the future.


   .. py:attribute:: CLUSTER_GIRDLE
      :value: 'cluster_girdle'


      Overlapping cluster and girdle with different magnitudes.


   .. py:attribute:: TWO_CLUSTERS
      :value: 'two_clusters'


      Two clusters with different magnitudes and orientations.


   .. py:attribute:: TWISTED_BLOCKS
      :value: 'twisted_blocks'


      Anisotropy of offset rotated layers of cylinders.

      .. rubric:: Notes

      Computed using Dragonfly 3D World.


   .. py:method:: load() -> numpy.ndarray

      Load the current dataset to use with VectoRose.

      :returns: :class:`numpy.ndarray` -- Array of shape ``(n, d)`` containing the loaded vectors. If the
                specific dataset has location coordinates, then ``d == 6``.
                Otherwise, ``d == 3``. ``n`` represents the number of vectors
                in the dataset.