Skip to main content

Ctrl+K

orix

User guide
API reference
Contributing
Changelog

GitHub

User guide
API reference
Contributing
Changelog

GitHub

Section Navigation

data
crystal_map
- create_coordinate_arrays
- CrystalMap
  - all_indexed
  - col
  - dx
  - dy
  - id
  - is_indexed
  - ndim
  - orientations
  - phase_id
  - phases
  - phases_in_data
  - prop
  - rotations
  - rotations_per_point
  - rotations_shape
  - row
  - shape
  - size
  - x
  - y
  - deepcopy
  - empty
  - get_map_data
  - plot
- CrystalMapProperties
- Phase
  - a_axis
  - ar_axis
  - b_axis
  - br_axis
  - c_axis
  - color
  - color_rgb
  - cr_axis
  - is_hexagonal
  - name
  - point_group
  - space_group
  - structure
  - deepcopy
  - from_cif
- PhaseList
  - colors
  - colors_rgb
  - ids
  - names
  - point_groups
  - size
  - space_groups
  - structures
  - add
  - add_not_indexed
  - deepcopy
  - id_from_name
  - sort_by_id
io
- plugins
- loadang
- loadctf
- load
- save
measure
- pole_density_function
plot
projections
- InverseStereographicProjection
  - xy2spherical
  - xy2vector
- StereographicProjection
quaternion
- von_mises
- get_proper_groups
- get_distinguished_points
- get_point_group
- Quaternion
  - a
  - angle
  - antipodal
  - axis
  - b
  - c
  - conj
  - d
  - data
  - ndim
  - norm
  - shape
  - size
  - unit
  - dot
  - dot_outer
  - empty
  - flatten
  - from_align_vectors
  - from_axes_angles
  - from_euler
  - from_homochoric
  - from_matrix
  - from_neo_euler
  - from_rodrigues
  - from_scipy_rotation
  - get_random_sample
  - identity
  - inv
  - mean
  - outer
  - random
  - reshape
  - squeeze
  - stack
  - to_axes_angles
  - to_euler
  - to_homochoric
  - to_matrix
  - to_rodrigues
  - transpose
  - triple_cross
  - unique
- Rotation
  - a
  - angle
  - antipodal
  - axis
  - b
  - c
  - conj
  - d
  - data
  - improper
  - ndim
  - norm
  - shape
  - size
  - unit
  - angle_with
  - angle_with_outer
  - dot
  - dot_outer
  - empty
  - flatten
  - from_align_vectors
  - from_axes_angles
  - from_euler
  - from_homochoric
  - from_matrix
  - from_neo_euler
  - from_rodrigues
  - from_scipy_rotation
  - get_random_sample
  - identity
  - inv
  - mean
  - outer
  - random
  - random_vonmises
  - reshape
  - squeeze
  - stack
  - to_axes_angles
  - to_euler
  - to_homochoric
  - to_matrix
  - to_rodrigues
  - transpose
  - triple_cross
  - unique
- Misorientation
  - a
  - angle
  - antipodal
  - axis
  - b
  - c
  - conj
  - d
  - data
  - improper
  - ndim
  - norm
  - shape
  - size
  - symmetry
  - unit
  - angle_with
  - angle_with_outer
  - dot
  - dot_outer
  - empty
  - equivalent
  - flatten
  - from_align_vectors
  - from_axes_angles
  - from_euler
  - from_homochoric
  - from_matrix
  - from_neo_euler
  - from_rodrigues
  - from_scipy_rotation
  - get_distance_matrix
  - get_random_sample
  - identity
  - inv
  - map_into_symmetry_reduced_zone
  - mean
  - outer
  - random
  - random_vonmises
  - reshape
  - scatter
  - squeeze
  - stack
  - to_axes_angles
  - to_euler
  - to_homochoric
  - to_matrix
  - to_rodrigues
  - transpose
  - triple_cross
  - unique
- Orientation
  - a
  - angle
  - antipodal
  - axis
  - b
  - c
  - conj
  - d
  - data
  - improper
  - ndim
  - norm
  - shape
  - size
  - symmetry
  - unit
  - angle_with
  - angle_with_outer
  - dot
  - dot_outer
  - empty
  - equivalent
  - flatten
  - from_align_vectors
  - from_axes_angles
  - from_euler
  - from_homochoric
  - from_matrix
  - from_neo_euler
  - from_rodrigues
  - from_scipy_rotation
  - get_distance_matrix
  - get_random_sample
  - identity
  - in_euler_fundamental_region
  - inv
  - map_into_symmetry_reduced_zone
  - mean
  - outer
  - plot_unit_cell
  - random
  - random_vonmises
  - reshape
  - scatter
  - squeeze
  - stack
  - to_axes_angles
  - to_euler
  - to_homochoric
  - to_matrix
  - to_rodrigues
  - transpose
  - triple_cross
  - unique
- OrientationRegion
  - a
  - angle
  - antipodal
  - axis
  - b
  - c
  - conj
  - d
  - data
  - improper
  - ndim
  - norm
  - shape
  - size
  - unit
  - angle_with
  - angle_with_outer
  - dot
  - dot_outer
  - empty
  - faces
  - flatten
  - from_align_vectors
  - from_axes_angles
  - from_euler
  - from_homochoric
  - from_matrix
  - from_neo_euler
  - from_rodrigues
  - from_scipy_rotation
  - from_symmetry
  - get_plot_data
  - get_random_sample
  - identity
  - inv
  - mean
  - outer
  - random
  - random_vonmises
  - reshape
  - squeeze
  - stack
  - to_axes_angles
  - to_euler
  - to_homochoric
  - to_matrix
  - to_rodrigues
  - transpose
  - triple_cross
  - unique
  - vertices
- Symmetry
  - a
  - angle
  - antipodal
  - axis
  - b
  - c
  - conj
  - contains_inversion
  - d
  - data
  - diads
  - euler_fundamental_region
  - fundamental_sector
  - improper
  - is_proper
  - laue
  - laue_proper_subgroup
  - ndim
  - norm
  - order
  - proper_subgroup
  - proper_subgroups
  - shape
  - size
  - subgroups
  - system
  - unit
  - angle_with
  - angle_with_outer
  - dot
  - dot_outer
  - empty
  - flatten
  - from_align_vectors
  - from_axes_angles
  - from_euler
  - from_generators
  - from_homochoric
  - from_matrix
  - from_neo_euler
  - from_rodrigues
  - from_scipy_rotation
  - fundamental_zone
  - get_axis_orders
  - get_highest_order_axis
  - get_random_sample
  - identity
  - inv
  - mean
  - outer
  - plot
  - random
  - random_vonmises
  - reshape
  - squeeze
  - stack
  - to_axes_angles
  - to_euler
  - to_homochoric
  - to_matrix
  - to_rodrigues
  - transpose
  - triple_cross
  - unique
sampling
vector
- AxAngle
  - angle
  - axis
  - azimuth
  - data
  - ndim
  - norm
  - perpendicular
  - polar
  - radial
  - shape
  - size
  - unit
  - x
  - xyz
  - y
  - z
  - angle_with
  - cross
  - dot
  - dot_outer
  - draw_circle
  - empty
  - flatten
  - from_axes_angles
  - from_path_ends
  - from_polar
  - from_rotation
  - get_circle
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - inverse_pole_density_function
  - mean
  - pole_density_function
  - random
  - reshape
  - rotate
  - scatter
  - squeeze
  - stack
  - to_polar
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector
- FundamentalSector
  - azimuth
  - center
  - data
  - edges
  - ndim
  - norm
  - perpendicular
  - polar
  - radial
  - shape
  - size
  - unit
  - vertices
  - x
  - xyz
  - y
  - z
  - angle_with
  - cross
  - dot
  - dot_outer
  - draw_circle
  - empty
  - flatten
  - from_path_ends
  - from_polar
  - get_circle
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - inverse_pole_density_function
  - mean
  - pole_density_function
  - random
  - reshape
  - rotate
  - scatter
  - squeeze
  - stack
  - to_polar
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector
- Homochoric
  - angle
  - axis
  - azimuth
  - data
  - ndim
  - norm
  - perpendicular
  - polar
  - radial
  - shape
  - size
  - unit
  - x
  - xyz
  - y
  - z
  - angle_with
  - cross
  - dot
  - dot_outer
  - draw_circle
  - empty
  - flatten
  - from_path_ends
  - from_polar
  - from_rotation
  - get_circle
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - inverse_pole_density_function
  - mean
  - pole_density_function
  - random
  - reshape
  - rotate
  - scatter
  - squeeze
  - stack
  - to_polar
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector
- Miller
  - azimuth
  - coordinate_format
  - coordinates
  - data
  - h
  - hkil
  - hkl
  - i
  - is_hexagonal
  - k
  - l
  - length
  - multiplicity
  - ndim
  - norm
  - perpendicular
  - polar
  - radial
  - shape
  - size
  - space
  - u
  - unit
  - uvw
  - v
  - w
  - x
  - xyz
  - y
  - z
  - angle_with
  - cross
  - deepcopy
  - dot
  - dot_outer
  - draw_circle
  - empty
  - flatten
  - from_highest_indices
  - from_min_dspacing
  - from_path_ends
  - from_polar
  - get_circle
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - inverse_pole_density_function
  - mean
  - pole_density_function
  - random
  - reshape
  - rotate
  - round
  - scatter
  - squeeze
  - stack
  - symmetrise
  - to_polar
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector
- NeoEuler
  - angle
  - axis
  - azimuth
  - data
  - ndim
  - norm
  - perpendicular
  - polar
  - radial
  - shape
  - size
  - unit
  - x
  - xyz
  - y
  - z
  - angle_with
  - cross
  - dot
  - dot_outer
  - draw_circle
  - empty
  - flatten
  - from_path_ends
  - from_polar
  - from_rotation
  - get_circle
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - inverse_pole_density_function
  - mean
  - pole_density_function
  - random
  - reshape
  - rotate
  - scatter
  - squeeze
  - stack
  - to_polar
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector
- Rodrigues
  - angle
  - axis
  - azimuth
  - data
  - ndim
  - norm
  - perpendicular
  - polar
  - radial
  - shape
  - size
  - unit
  - x
  - xyz
  - y
  - z
  - angle_with
  - cross
  - dot
  - dot_outer
  - draw_circle
  - empty
  - flatten
  - from_path_ends
  - from_polar
  - from_rotation
  - get_circle
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - inverse_pole_density_function
  - mean
  - pole_density_function
  - random
  - reshape
  - rotate
  - scatter
  - squeeze
  - stack
  - to_polar
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector
- SphericalRegion
  - azimuth
  - data
  - ndim
  - norm
  - perpendicular
  - polar
  - radial
  - shape
  - size
  - unit
  - x
  - xyz
  - y
  - z
  - angle_with
  - cross
  - dot
  - dot_outer
  - draw_circle
  - empty
  - flatten
  - from_path_ends
  - from_polar
  - get_circle
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - inverse_pole_density_function
  - mean
  - pole_density_function
  - random
  - reshape
  - rotate
  - scatter
  - squeeze
  - stack
  - to_polar
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector
- Vector3d
  - azimuth
  - data
  - ndim
  - norm
  - perpendicular
  - polar
  - radial
  - shape
  - size
  - unit
  - x
  - xyz
  - y
  - z
  - angle_with
  - cross
  - dot
  - dot_outer
  - draw_circle
  - empty
  - flatten
  - from_path_ends
  - from_polar
  - get_circle
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - inverse_pole_density_function
  - mean
  - pole_density_function
  - random
  - reshape
  - rotate
  - scatter
  - squeeze
  - stack
  - to_polar
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector

API reference
Phase
name

name#

property Phase.name: str#

Return or set the phase name.

Parameters:

valuestr: Phase name.

previous

is_hexagonal

next

point_group

On this page

Phase.name

© Copyright 2018-2024, orix developers.

Created using Sphinx 7.2.6.

Built with the PyData Sphinx Theme 0.15.2.