OOF2: The Manual

OOF.Graphics_n.Toolbox.Pixel_Select.Point
	6.2.47. OOF.Graphics_n.Toolbox.Pixel_Select Commands

Name

OOF.Graphics_n.Toolbox.Pixel_Select.Point — Select a single pixel.

Synopsis

OOF.Graphics_n.Toolbox.Pixel_Select.Point(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 the single pixel at the given point.

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. When the command is invoked by the GUI, it's possible that the list may contain more than one point if the mouse was moving during the click. Only the first point in the list is used.

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.

Table 6.1. Keyboard Modifiers for Selection Operations

`shift`	`ctrl`	Effect
`0`	`0`	The previous selection is discarded. The new selection is the current selection.
`1`	`0`	The previous selection is retained, and the current selection is added to it. That is, the new selection is the union of the previous and current selections.
`0`	`1`	The previous selection is toggled at all members of the current selection. That is, all members of the new selection are in the previous or current selections, but not both.
`1`	`1`	Members of the current selection are kept only if they were also members of the previous selection. That is, the new selection is the intersection of the previous and current selections.


OOF.Graphics_n.Toolbox.Pixel_Select.OrientationBurn		OOF.Graphics_n.Toolbox.Pixel_Select.Rectangle