OOF2: The Manual
Name
OOF.Microstructure.Create_From_Image — Create a Microstructure from an already loaded Image.
Synopsis
OOF.Microstructure.Create_From_Image(name
,width
,height
,image
)
Details
- Parent Menu: OOF.Microstructure
-
Callback: function
createMSFromImage
in moduleooflib.image.IO.imagemenu
-
Parameters:
name
- Name of the new Microstructure. Type: A character string not containing ':', or the variable
automatic
. width
- Width in physical units, or automatic to use the image width. Type: An integer, a real number, or the string 'automatic'.
height
- Height in physical units. or automatic to use the image height. Type: An integer, a real number, or the string 'automatic'.
image
- Image on which to base the Microstructure. Type: The path to an existing
Image
object.
Description
This menu command creates a second Microstructure
based on an Image
already loaded in another Microstructure
. The new Microstructure
will have the
same physical size and pixel size as the old Microstructure
, but will not
inherit any other data from it (except for the Image
).
The name
parameter is the name of the new
Microstructure
. If set to automatic
(by checking the box in the GUI or entering
automatic
without quotation marks in
scripts) the Microstructure
name will be taken from the Image
name.
The image
parameter must be a path to an existing Image
object.