a reference frame, the coordinate system data is expressed in: an identity, a basis, the point group the data is invariant under and the default plotting convention

Syntax

f = referenceFrame(name='lab', axesNames=('A', 'B', 'C'))

A frame of the canonical basis.

f = referenceFrame(basis)

A frame of the given basis vectors.

Description

The base class of crystalFrame, the frame glued to the lattice of a phase, and specimenFrame, the frame of a sample; use those. A frame carries an identity, a name such as ‘measurement’, ‘rolling’ or a mineral; the basis vectors in canonical Euclidean coordinates, whose lengths count; the point group; and the plotting convention its data is drawn in. Frames are handles compared by identity, registered and sealed by the session; transformationMatrix gives the change of coordinates between two frames.

Input

basis vector3d or 3 x 3 array, the basis vectors in canonical coordinates, by default the canonical basis

Keywords

keyword default description
name '' the identity of the frame
axesNames ('X', 'Y', 'Z') the names of the three axes
how2plot None the default plottingConvention of the frame
sym None the point group, by default the trivial one
color None the colour of the frame’s data in a phase map

Output

f referenceFrame

See also

crystalFrame, specimenFrame, plottingConvention, referenceFrame.transformationMatrix

MATLAB’s referenceFrame.referenceFrame

source

Citing this page. This page is part of the documentation of MTEX, a free and open source MATLAB toolbox for analyzing and modeling crystallographic textures. It was written by The MTEX Developers and is published at https://mtex-toolbox.github.io/referenceFrame.referenceFrame_py.html. If you use MTEX, or reuse text or figures from this page, in your research, please cite

F. Bachmann, R. Hielscher, H. Schaeben: Texture Analysis with MTEX - Free and Open Source Software Toolbox, Solid State Phenomena 160 (2010), 63-68. 10.4028/www.scientific.net/SSP.160.63

BibTeX 
@article{bachmann2010mtex,
  author  = {F. Bachmann and R. Hielscher and H. Schaeben},
  title   = {Texture Analysis with MTEX - Free and Open Source Software Toolbox},
  journal = {Solid State Phenomena},
  volume  = {160},
  pages   = {63-68},
  year    = {2010},
  doi     = {10.4028/www.scientific.net/SSP.160.63},
  url     = {https://doi.org/10.4028/www.scientific.net/SSP.160.63}
}

Other papers describing specific MTEX methods are listed under Publications — please cite the one that best fits your application. The MTEX source code is licensed under the GNU General Public License v2.0; the text and figures of this documentation are licensed under CC BY 4.0, which permits reuse — including by automated systems — provided The MTEX Developers and this page are credited.