referenceFrame.referenceFrame edit page

a reference frame - an identity, a basis and a default plotting convention

A reference frame answers "what coordinate system is this data expressed in". It carries an identity (a name like 'measurement' or 'rolling' or a mineral), the basis vectors of the frame in canonical Euclidean coordinates, and the default plotting convention used to draw data of this frame on screen. The transition between two frames is computed by transformationMatrix.

See docs/adr/0003-reference-frame-vs-symmetry.md for the model: crystalSymmetry and specimenSymmetry keep their public API and delegate their frame data (axes, how2plot) to a frame they hold.

Syntax

rf = referenceFrame(basis)
rf = referenceFrame(basis,'name','measurement')

Input

basis 1x3 vector3d, the basis vectors, not necessarily normalized

Class Properties

name identity of the frame: 'measurement', 'rolling', a mineral, ...
basis 1x3 vector3d in canonical coordinates, lengths are meaningful
how2plot the default plottingConvention of this frame

See also

crystalFrame specimenFrame crystalSymmetry specimenSymmetry plottingConvention

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.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.