httk.atomistic.models.protopattern.label
========================================

.. py:module:: httk.atomistic.models.protopattern.label

.. autoapi-nested-parse::

   Eager protopattern-label presentation view.



Classes
-------

.. autoapisummary::

   httk.atomistic.models.protopattern.label.ProtopatternLabel


Module Contents
---------------

.. py:class:: ProtopatternLabel(obj, **hints)

   Bases: :py:obj:`httk.atomistic.models.protopattern.view_base.ProtopatternViewBase`, :py:obj:`str`


   Present a protopattern as its eager httk label string.

   Any faithful render is the protopattern label; the *canonical* protopattern label is
   the one obtained from a normalizer-canonical pattern (for example one derived via
   ``canonical_asu``). This view renders the label with no affine-normalizer pass.

   :param obj: The protopattern-like object to present.
   :param \*\*hints: Backend-selection hints.


   .. py:property:: spacegroup

      Return the standard-setting space group of the presented pattern.


   .. py:property:: occupations

      Return the class-partitioned occupations of the presented pattern.


   .. py:method:: unview()

      Return the presented protopattern as a standalone value.

      :return: The protopattern value.



   .. py:method:: unwrap()

      Return the raw object behind the backend.

      :return: The unwrapped source object.