the Python script of an import as the import wizard sets it up: the file, the plotting convention, the correction of the Euler angles, the phases and a first plot

Syntax

script = buildImportWizardScript('map.ctf')

The plain load.

script = buildImportWizardScript('map.h5oina', dataSet=2, dataSets=sets)

A map of a project file.

script = buildImportWizardScript('map.ang', phases=csList, headerPhases=info.phases)

Phases edited.

script = buildImportWizardScript('map.ctf', mapConvention='y↑→x', eulerConvention='y↓→x')

A correction.

script = buildImportWizardScript('volume.dream3d', volume=True)

A volume, read by EBSD3.load.

Description

The script sets the plotting convention of the map, loads the file with EBSD.load or EBSD3.load, turns the Euler angles where their frame differs from the map’s, replaces the phases where they differ from what the file declares, and plots the orientations of the largest phase. It runs as it is and reproduces the import. The window’s Script tab shows it; loadCall gives the one line load.

Input

path the file

Keywords

keyword default description
phases None phaseList, the phases as edited, written out where they differ from headerPhases
headerPhases None the phases the file declares, a phaseList or the snapshot frameKeys took
dataSet None the number of the map of a file with several
dataSets () the maps of the file; a dataSet is written only when there are several
mapConvention 'y↑→x' the plotting convention of the map
eulerConvention None the convention the Euler angles are written in; a correction is written where it differs from the map’s
vendorCorrection None the correction the reader applies anyway, which is then not written
variable 'ebsd' the name of the variable the map is assigned to
drawn None the phases the plot may show, by index, True or False or a pixel count
volume False the file is a volume, read by EBSD3.load

Output

script str

See also

importWizard, loadCall, inspectEBSD, EBSD.load, EBSDImport

MATLAB’s buildImportWizardScript

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