the reference frame a sample is expressed in, with the sample symmetry it claims

Syntax

ss = specimenFrame()

The session default frame.

ss = specimenFrame('mmm')

The session frame in that sample symmetry.

ss = specimenFrame('orthorhombic')

The same by the crystal system.

ss = specimenFrame(pC)

The session frame drawn that way.

ss = specimenFrame(otherFrame)

That frame, claiming no symmetry.

ss = specimenFrame('rolling', axesNames=('RD', 'TD', 'ND'), how2plot='y←↑x')

A fresh named frame.

ss = specimenFrame.rolling

A named session frame.

ss = specimenFrame.rolling('mmm')

In a sample symmetry.

Description

The named frames, specimenFrame.specimen (X, Y, Z), .measurement, .rolling (RD, TD, ND), .geological and .default, are the session’s instances, so that moving between specimen frames is an explicit operation; naming a frame here makes a fresh one. A point group symbol as the name is read as the group, a lookup of the session frame in that group. A specimen frame has no lattice: a point group on it is a claim about a function, the sample symmetry, never about a direction.

Input

name a point group symbol or crystal system, the sample symmetry; or the name of a fresh frame; or a plottingConvention or another specimenFrame

Keywords

keyword	default	description
`axesNames`		the names of the three axes
`how2plot`		the plottingConvention of the frame
`intern`		register the frame with the session
`basis`		vector3d, the basis vectors in canonical coordinates

Output

`ss`	specimenFrame

Members

char	the name or the convention, the point group after it when there is one: y↑→x (mmm)
default	the frame that supplies the session default convention
frameFor	the session frame carrying a convention: the default when it already does, otherwise a fork of it with that convention, registered
geological	north, east, down of structural geology
makeDefault	makes this frame the session’s default frame, the one supplying the default plotting convention
measurement	the sample surface frame of an Oxford instrument, drawn as its SEM images are
named	the interned session instance of a named frame, constructed on first use with its seed convention and kept in the session’s name map
rolling	rolling, transverse and normal direction, RD north and TD west
specimen	the generic specimen frame X, Y, Z - where an import lands and the session default
specimenFrame	the reference frame a sample is expressed in, with the sample symmetry it claims
specimenSymmetry	the reference frame a sample is expressed in, with the sample symmetry it claims

Used on

OrientationDefinition, OrientationFibre, OrientationSymmetry, OrientationVisualizationSections, SpecimenSymmetry, DetectionOfSampleSymmetry, EulerAngleSections, ODFImport, ODFModeling, ODFPlot, RadialODFs, PoleFigureRefinement

MATLAB’s specimenFrame_index

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

The class specimenFrame