httk.atomistic.models.protopattern.label¶

Eager protopattern-label presentation view.

Classes¶

ProtopatternLabel

Present a protopattern as its eager httk label string.

Module Contents¶

class httk.atomistic.models.protopattern.label.ProtopatternLabel(obj, **hints)[source]¶

Bases: httk.atomistic.models.protopattern.view_base.ProtopatternViewBase, 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.

Parameters:

obj (httk.atomistic.models.protopattern.like.ProtopatternLike) – The protopattern-like object to present.
**hints (Any) – Backend-selection hints.

property spacegroup[source]¶: Return the standard-setting space group of the presented pattern.

property occupations[source]¶: Return the class-partitioned occupations of the presented pattern.

unview()[source]¶

Return the presented protopattern as a standalone value.

Returns:: The protopattern value.
Return type:: httk.atomistic.models.protopattern.protopattern.Protopattern

unwrap()[source]¶

Return the raw object behind the backend.

Returns:: The unwrapped source object.
Return type:: Any