httk.atomistic.models.protopattern.derived
==========================================

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

.. autoapi-nested-parse::

   The structure/protostructure-to-protopattern erasure adapter.



Classes
-------

.. autoapisummary::

   httk.atomistic.models.protopattern.derived.DerivedProtopattern


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

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

   Bases: :py:obj:`httk.atomistic.models.protopattern.backend.ProtopatternBackend`


   Erase a protostructure or structure lazily to an anonymous protopattern.

   A protostructure-family source has its real species erased to anonymous classes by the
   pinned group-ordering rule. A crystalpattern-family (fundamental-domain) or
   structure-family source is routed through
   :class:`~httk.atomistic.models.crystalpattern.fundamental_view.FundamentalDomainPatternView`
   recognition and then discretized to its Wyckoff letters and anonymous classes. An exact
   fundamental-domain source needs no spglib; a raw structure source does.

   :param obj: The protostructure-like or structure-like source to erase.
   :param \*\*hints: Backend-selection hints.


   .. py:attribute:: kind
      :value: 'protopattern'



   .. py:method:: resolve()

      Return the complete erased protopattern.



   .. py:property:: spacegroup

      Return the erased standard-setting space group.


   .. py:property:: occupations
      :type: tuple[httk.atomistic.models.protopattern.occupation.ProtopatternOccupation, Ellipsis]


      Return the erased class-partitioned occupations.


   .. py:method:: unwrap()

      Return the original erasure source.