A method of referenceFrame.

the specimen frame registered under a name; with a frame, registers it under that name; MATLAB’s referenceFrame.byName

Syntax

ss = referenceFrame.byName('rolling')

Look up, None when unknown.

referenceFrame.byName('myFrame', fr)

Store fr under the name.

Description

The register holds one instance per name: the named frames (specimenFrame.rolling, …) are built on first use and stored here, so every later call returns the same handle.

Input

name str

Keywords

keyword default description
fr None the frame to register under the name

Output

ss referenceFrame, the frame registered under the name, or None

See also

specimenFrame.named, referenceFrame.intern

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