OOF2: The Manual

OOF.Graphics_n.Toolbox.Pixel_Select.Brush
Prev  6.2.47. OOF.Graphics_n.Toolbox.Pixel_Select Commands  Next

Name

OOF.Graphics_n.Toolbox.Pixel_Select.Brush — Drag to select multiple pixels with a brush.

Synopsis

OOF.Graphics_n.Toolbox.Pixel_Select.Brush(source,style,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.
    style
    Type: An object of the BrushStyle class.
    points
    Type: A list of Point objects.
    shift
    True for addition. Type: Boolean, 0 (false) or 1 (true).
    ctrl
    True for toggle. Type: Boolean, 0 (false) or 1 (true).

Description

Select a contiguous set of pixels by sweeping the mouse over them. The mouse acts like a paintbrush with a size and shape given by the style parameter.

The source parameter is the path to a Microstructure or Image. If it's an Image, the selection is made in the Microstructure in which the Image resides.

The points parameter is a Python list of Points in the Microstructure. The selected pixels will be those that are under the brush when the brush is centered on one of the specified points or on any point on the line segments joining them.

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 (1) or not (0) the shift and control keys were depressed during the mouse click that initiated this command.

Figure 6.11. Selecting Pixels with the Brush

Selecting Pixels with the Brush

Pixels selected with the brush, using the CircleBrush style with radius=2.0 (the Microstructure is 200×200, in physical units).


Prev  Up  Next
OOF.Graphics_n.Toolbox.Pixel_Info.Query  Home  OOF.Graphics_n.Toolbox.Pixel_Select.Burn