OOF2: The Manual

OOF.Graphics_n.Toolbox.Pixel_Select.Circle
	6.2.47. OOF.Graphics_n.Toolbox.Pixel_Select Commands

Name

OOF.Graphics_n.Toolbox.Pixel_Select.Circle — Drag to select a circular region.

Synopsis

OOF.Graphics_n.Toolbox.Pixel_Select.Circle(source,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.

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 dragging out a circle with the mouse.

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, indicating the mouse motion. The first point is the center of the circle, and the last is a point on is perimeter. Any other points in the list will be ignored.

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.13. Selecting a Circular Region of Pixels

Pixels selected with the Circle selector.


OOF.Graphics_n.Toolbox.Pixel_Select.Burn		OOF.Graphics_n.Toolbox.Pixel_Select.Clear