OOF2: The Manual

OOF.File.Load.OrientationMap
Prev  6.2. Menus  Next

Name

OOF.File.Load.OrientationMap — Load an orientation map into a Microstructure

Synopsis

OOF.File.Load.OrientationMap(filename, reader, microstructure)

Details

  • Parent Menu: OOF.File.Load
  • Callback: function _loadOrientationMap in module ooflib.orientationmap.orientmapmenu

  • Parameters:

    filename
    Name of the file containing the orientation map data. Type: A character string.
    reader
    Description of the data file format Type: An object of the OrientMapReader class.
    microstructure
    Add the orientation map to this Microstructure. Type: The path to an existing Microstructure object.

Description

This command loads an Orientation Map into the given pre-existing Microstructure. The Microstructure must have the same physical and pixel dimensions as the Orientation Map, and must not contain another Orientation Map.

(To create a new Microstructure directly from an orientation map file, see OOF.Microstructure.Create_From_OrientationMap_File. This obviates the need to ensure that the map and Microstructure have the same dimensions.)

Prev  Up  Next
OOF.File.Load.Module  Home  OOF.File.Load.Script