Phase#
- class orix.crystal_map.Phase(name: str | Phase | None = None, space_group: int | SpaceGroup | None = None, point_group: int | str | Symmetry | None = None, structure: Structure | None = None, color: str | None = None)[source]#
Bases:
objectSymmetry and unit cell of a phase in a crystallographic map.
The phase can be crystallographic or non-crystallographic, with the latter not having a crystal structure or symmetry set.
- Parameters:
- name
Phase name. Overwrites the name in the structure. A phase can also be given, in which case a copy is returned and all other parameters are ignored.
- space_group
Space group describing the symmetry operations resulting from associating the point group with a Bravais lattice, according to the International Tables for Crystallography. If not given, it is set to None.
- point_group
Point group describing the symmetry operations of the phase’s crystal structure, according to the International Tables for Crystallography. If neither this nor space_group is given, it is set to None. If not given but space_group is, it is derived from the space group. If both this and space_group is given, the space group must to be derived from adding translational symmetry to the point group.
- structure
Unit cell with atoms and a lattice. If not given, a default
Structurecompatible with the symmetry is used.- color
Phase color. If not given, it is set to the first default Matplotlib color “tab:blue”.
Attributes
Return the direct lattice vector \(a\) in the cartesian reference frame of the crystal lattice \(e_i\).
Return the reciprocal lattice vector \(a^{*}\) in the cartesian reference frame of the crystal lattice \(e_i\).
Return the direct lattice vector \(b\) in the cartesian reference frame of the crystal lattice \(e_i\).
Return the reciprocal lattice vector \(b^{*}\) in the cartesian reference frame of the crystal lattice \(e_i\).
Return the direct lattice vector \(c\) in the cartesian reference frame of the crystal lattice \(e_i\).
Return or set the phase color name.
Return the phase color as RGB tuple.
Return the reciprocal lattice vector \(c^{*}\) in the cartesian reference frame of the crystal lattice \(e_i\).
Return whether the crystal structure is hexagonal/trigonal or not.
Return or set the phase name.
Return or set the point group.
Return or set the space group.
Return or set the crystal structure containing a lattice (
Lattice) and possibly many atoms (Atom).Methods
Return a deep copy using
deepcopy()function.Return a new phase with all symmetrically equivalent atoms.
Phase.from_cif(filename)Return a new phase from a Crystallographic Information File (CIF).
Examples using Phase#
Rotating z-vector to high-symmetry crystal directions