OOF2: The Manual

OOF.Graphics_n.Toolbox.Pixel_Select.OrientationBurn
Prev  6.2. Menus  Next

Name

OOF.Graphics_n.Toolbox.Pixel_Select.OrientationBurn — Select a contiguous set of similarly oriented pixels, using a forest fire algorithm on an orientation map.

Synopsis

OOF.Graphics_n.Toolbox.Pixel_Select.OrientationBurn(source, local_flammability, global_flammability, lattice_symmetry, next_nearest, 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.
    local_flammability
    Maximum misorientation angle, in degrees, between neighboring pixels, across which a burn will extend. Type: A real number in the range [0, 180].
    global_flammability
    Misorientation, in degrees measured from initial point, beyond which a burn will not spread. Type: A real number in the range [0, 180].
    lattice_symmetry
    Assume that the material at each point has this symmetry, making some orientations equivalent. Type: An object of the LatticeSymmetry class.
    next_nearest
    Burn next-nearest neighbors? Type: Boolean: True or False.
    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 a contiguous set of similarly oriented pixels, using an algorithm sometimes used to model forest fires. This can be a powerful way of selecting features in a Microstructure. The process is identical to OOF.Graphics_n.Toolbox.Pixel_Select.Burn except that it works with orientations instead of colors. The pixels must have an Orientation assigned to them.

The source parameter must be the path to an Image. The selection is made in the Microstructure in which the Image resides.

The algorithm first selects the pixel located at the first Point in the points list. The selection spreads like a forest fire from one pixel to its neighbors, if the misorientation between the selected pixel and its neighbor is less than local_flammability, and the misorientation between the neighbor and the first point is less than global_flammability.

The next_nearest parameter determines whether the selection spreads diagonally from pixel to pixel in the Image, or only along the x and y axes. A burn started at one square on a checkerboard will spread to all the squares of the same color if next_nearest is True, but will not spread beyond the initial square if next_nearest is False.

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.

See Also

Prev  Up  Next
OOF.Graphics_n.Toolbox.Pixel_Select.Orientation  Home  OOF.Graphics_n.Toolbox.Pixel_Select.Point