OOF2: The Manual

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
  • Options: disabled=1
  • Parameters:

    filename
    Name of the file containing the orientation map data. Type: A character string.
    reader
    MISSING TIP STRING 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.)

The format argument indicates which type of orientation map data file is being loaded. The available formats are listed at ???. New formats can be added by writing a small amount of python code, as described in Section 8.5.3.

This command is only available if OOF2 was built with the --enable-orientationmap option.