OOF2: The Manual

Name

OOF.Graphics_n.Toolbox.Pixel_Select.Orientation — Select pixels whose orientation is within the given misorientation of the selected pixel's orientation.

Synopsis

OOF.Graphics_n.Toolbox.Pixel_Select.Orientation(source, lattice_symmetry, misorientation, points, shift, ctrl)

Details

  • Parent Menu: OOF.Graphics_n.Toolbox.Pixel_Select
  • Callback: function PixelSelectToolbox.selectCB in module ooflib.common.IO.genericselecttoolbox
  • Parameters:

    source
    Microstructure or Image Type: The path to an OOF2 object.
    lattice_symmetry
    Assume the material at each point has this symmetry, making some orientations equivalent. Type: An object of the LatticeSymmetry class.
    misorientation
    Select orientations with misorientation less than this, relative to the selected pixel's orientation, in degrees. Type: A real number in the range [0, 180].
    points
    Type: A list of Point objects.
    shift
    True for addition. Type: Boolean: True or False.
    ctrl
    True for toggle. Type: Boolean: True or False.

Description

Select pixels that have similar orientations to the pixel at a given location (the reference pixel). When using the Pixel Selection Toolbox, this location is given by a mouse click. In text mode the location is the first entry in the points list. Pixels selected in this way are not necessarily contiguous. The pixels must have been given orientations by assigning to them a Material that contains an Orientation Property or an OrientationMap Property.

Selecting by orientation is similar to selecting by color: pixels are selected if their orientations are within a certain misorientation of a reference orientation. Misorientations are defined in Section 2.3.2. The misorientation calculation depends on the crystal structure, which is set by the lattice_symmetry parameter.

The shift and ctrl parameters govern how the current selection (i.e, the set of objects defined by this operation) is merged with the previous selection (the objects already selected) to form a new selection, as shown in Table 6.1. They indicate whether (True) or not (False) the shift and control keys were depressed during the mouse click that initiated this command.