OOF2: The Manual

OOF.File.Load.Image
Prev  6.2.12. OOF.File.Load Commands  Next

Name

OOF.File.Load.Image — Load an Image into an existing Microstructure.

Synopsis

OOF.File.Load.Image(filename,microstructure,height,width)

Details

  • Parent Menu: OOF.File.Load
  • Callback: function loadImage in module ooflib.image.IO.imagemenu
  • Options: disabled=1

  • Parameters:

    filename
    Name of the image file. Type: A character string.
    microstructure
    Type: The path to an existing Microstructure object.
    height
    Physical height of image, or 'automatic'. Type: An integer, a real number, or the string 'automatic'.
    width
    Physical width of image, or 'automatic'. Type: An integer, a real number, or the string 'automatic'.

Description

This command loads an Image into an existing Microstructure. The new Image must have the same physical and pixel sizes as the Microstructure.

[Note] Note

All Images in OOF2 must be associated with Microstructures. To load an Image without a preexisting Microstructure, use OOF.Microstructure.Create_From_ImageFile instead.

The image file can be in any format understood by the ImageMagick library. All the common formats (jpg, gif, ppm, png, tif, etc.) are acceptable.

The new Image will be identified within the Microstructure by its filename (after stripping off any directory path components). If there is already an Image with that name in the Microstructure, then <x> will be appended to the name, where x is an integer.

Prev  Up  Next
OOF.File.Load.Data  Home  OOF.File.Load.OrientationMap