OOF2: The Manual
Name
OOF.OrientationMap.Convert_to_Image — Convert an Orientation Map into an Image, so that pixel selection tools will work on it.
Synopsis
OOF.OrientationMap.Convert_to_Image(microstructure
,imagename
,colorscheme
)
Details
- Parent Menu: OOF.OrientationMap
-
Callback: function
_imageFromOrientationMap
in moduleooflib.orientationmap.orientmapmenu
-
Parameters:
microstructure
- Convert the Orientation Map in this Microstructure Type: The path to an existing
Microstructure
object. imagename
- Name to give to the new Image. Type: A character string not containing ':', or the variable
automatic
. colorscheme
- How to convert angles to colors. Type: An object of the
Angle2Color
class.
Description
This command converts an Orientation
Map
into an Image
, and loads the Image
into
the map's Microstructure
. This is useful if you'd like to use
color-dependent pixel selection tools on the data in the map.
Those tools only work on Images
.
The microstructure
parameter specifies which
Orientation Map
to convert. Microstructures
can
contain only one Orientation Map
, so
specifying the Microstructure
name is sufficient.
The imagename
parameter holds the name that will
be assigned to the new Image
. If the name is not unique,
<x>
will be appended to it, where
x
is a suitable integer.
The colorscheme
parameter governs how
orientations in the map will be converted to pixels in the
Image
. If most of the orientations in the
Orientation Map
are similar, the resulting
Image
will have very low contrast. It may be useful to use
image modification tools, especially OOF.Image.Modify.Equalize, to enhance the
contrast.
This command is only available if OOF2 was built with the
--enable-orientationmap
option.