Description

The reader works as follows:

* the file is matched against the configurations in interfaces/hdf5_config,
by the manufacturer stated in the file or by the option 'type'
* the configuration names the groups holding the EBSD data; an error is
thrown if there is no such data
* the data are extracted as the configuration says and converted into an
<EBSD.EBSD.html EBSD> map

Every per pixel data set the config does not read itself becomes a property of the map. For an Oxford file that includes the EDS element maps stored next to the EBSD data set, e.g. plot(ebsd, ebsd.Fe_WindowIntegral_Ka1) - the element comes first and the subgroup they are sorted into is part of the property name, since a quantified map holds a "Fe Ka1" both as a window integral and as a peak area. The EDS header - beam voltage, detector geometry, channel width - comes along as ebsd.opt.eds.header.

Syntax

ebsd = EBSD.load(fname)

The map of an HDF5 file.

ebsd = EBSD.load(fname,'dataSet',2)

The second data set of the file.

ebsd = EBSD.load(fname,'dataSet','OIM Map 2')

The data set of this name.

ebsd = EBSD.load(fname,'headerOnly')

The phases and the data sets only.

Input

fname file name

Options

`dataSet`	which data set to import from a file that holds several of them, either as the number shown in the list printed on import, or as (part of) its name, e.g. EBSD.load(fname,'dataSet',2) or EBSD.load(fname,'dataSet','OIM Map 2'). Oxford files may hold a map twice, as recorded by the detector under "EBSD" and as cleaned up by the vendor software under "Data Processing" - both are offered as data sets and the cleaned up one is imported unless the other one is asked for, EBSD.load(fname,'dataSet','EBSD')
`type`	`the configuration to use, by one of its manufacturer keys, e.g. 'Oxford_EBSD', instead of detecting it`
`debug`	`report the steps of the import`

Flags

headerOnly return only phase/header metadata, skip reading the (potentially large) per-pixel position/rotation/phase data and any other top-level category (e.g. electron images). Also lists the data sets the file contains.

Output

ebsd EBSD

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