OOF2: The Manual

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: True or False.
    ctrl
    True for toggle. Type: Boolean: True or False.

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. Only the first point in the list is used. The OOF2 GUI puts only one point in the list — the position of the mouse when the mouse button is released. If the button is released outside the Image or Microstructure, no action is taken.

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.

Table 6.1. Keyboard Modifiers for Selection Operations

shift

ctrl

Effect

False False

The previous selection is discarded. The new selection is the current selection.

True False

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.

False True

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.

True True

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.