OOF2: The Manual

OOF.Microstructure.New
Prev  6.2. Menus  Next

Name

OOF.Microstructure.New — Create a new Microstructure.

Synopsis

OOF.Microstructure.New(name, width, height, width_in_pixels, height_in_pixels)

Details

  • Parent Menu: OOF.Microstructure
  • Callback: function newMicrostructure in module ooflib.common.IO.microstructuremenu

  • Parameters:

    name
    Name of the new Microstructure. Type: A character string containing no colons (:), or the value automatic.
    width
    Width in physical units. Type: A real number.
    height
    Height in physical units. Type: A real number.
    width_in_pixels
    Width in pixels. Type: Integer.
    height_in_pixels
    Height in pixels. Type: Integer.

Description

This command creates a new empty Microstructure with no associated Images. To create a Microstructure with an Image, see OOF.Microstructure.Create_From_Image or OOF.Microstructure.Create_From_ImageFile. To create a Microstructure from an EBSD orientation map, see OOF.Microstructure.Create_From_OrientationMap_File.

If the value of the name argument is automatic, the Microstructure will be named “microstructure”. If a Microstructure already exists with the given name, <x> will be appended to it, where x is an integer chosen to make the name unique.

See Also

Prev  Up  Next
OOF.Microstructure.Delete  Home  OOF.Microstructure.Rename