Gimp.Selection

g GObject.Object GObject.Object Gimp.Item Gimp.Item GObject.Object->Gimp.Item Gimp.Channel Gimp.Channel Gimp.Selection Gimp.Selection Gimp.Channel->Gimp.Selection Gimp.Drawable Gimp.Drawable Gimp.Drawable->Gimp.Channel Gimp.Item->Gimp.Drawable

Subclasses:

None

Methods

Inherited:

Gimp.Channel (11), Gimp.Drawable (55), Gimp.Item (55), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

all (image)

class

border (image, radius)

class

bounds (image)

class

feather (image, radius)

class

float (image, drawables, offx, offy)

class

flood (image)

class

get_by_id (selection_id)

class

grow (image, steps)

class

invert (image)

class

is_empty (image)

class

none (image)

class

save (image)

class

sharpen (image)

class

shrink (image, steps)

class

translate (image, offx, offy)

class

value (image, x, y)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

Gimp.Item (1)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Gimp.Selection(**kwargs)
Bases:

Gimp.Channel

Abstract:

No

Structure:

Gimp.SelectionClass

Functions for manipulating selections.

classmethod all(image)
Parameters:

image (Gimp.Image) – The image.

Returns:

True on success.

Return type:

bool

Select all of the image.

This procedure sets the selection mask to completely encompass the image. Every pixel in the selection channel is set to 255.

classmethod border(image, radius)
Parameters:

  • image (Gimp.Image) – The image.

  • radius (int) – Radius of border (in pixels).

Returns:

True on success.

Return type:

bool

Border the image’s selection

This procedure borders the selection. Bordering creates a new selection which is defined along the boundary of the previous selection at every point within the specified radius.

classmethod bounds(image)
Parameters:

image (Gimp.Image) – The image.

Returns:

True on success.

non_empty:

True if there is a selection.

x1:

x coordinate of upper left corner of selection bounds.

y1:

y coordinate of upper left corner of selection bounds.

x2:

x coordinate of lower right corner of selection bounds.

y2:

y coordinate of lower right corner of selection bounds.

Return type:

(bool, non_empty: bool, x1: int, y1: int, x2: int, y2: int)

Find the bounding box of the current selection.

This procedure returns whether there is a selection for the specified image. If there is one, the upper left and lower right corners of the bounding box are returned. These coordinates are relative to the image. Please note that the pixel specified by the lower right coordinate of the bounding box is not part of the selection. The selection ends at the upper left corner of this pixel. This means the width of the selection can be calculated as (x2 - x1), its height as (y2 - y1).

classmethod feather(image, radius)
Parameters:

  • image (Gimp.Image) – The image.

  • radius (float) – Radius of feather (in pixels).

Returns:

True on success.

Return type:

bool

Feather the image’s selection

This procedure feathers the selection. Feathering is implemented using a gaussian blur.

classmethod float(image, drawables, offx, offy)
Parameters:

  • image (Gimp.Image) – ignored

  • drawables ([Gimp.Drawable]) – The drawables from which to float selection.

  • offx (int) – x offset for translation.

  • offy (int) – y offset for translation.

Returns:

The floated layer.

Return type:

Gimp.Layer

Float the selection from the specified drawable with initial offsets as specified.

This procedure determines the region of the specified drawable that lies beneath the current selection. The region is then cut from the drawable and the resulting data is made into a new layer which is instantiated as a floating selection. The offsets allow initial positioning of the new floating selection.

classmethod flood(image)
Parameters:

image (Gimp.Image) – The image.

Returns:

True on success.

Return type:

bool

Remove holes from the image’s selection

This procedure removes holes from the selection, that can come from selecting a patchy area with the Fuzzy Select Tool. In technical terms this procedure floods the selection. See the Algorithms page in the developer wiki for details.

New in version 2.10.

classmethod get_by_id(selection_id)
Parameters:

selection_id (int) – The selection id.

Returns:

a Gimp.Selection for selection_id or None if selection_id does not represent a valid selection. The object belongs to libgimp and you must not modify or unref it.

Return type:

Gimp.Selection or None

Returns a Gimp.Selection representing selection_id. This function calls Gimp.Item.get_by_id() and returns the item if it is selection or None otherwise.

New in version 3.0.

classmethod grow(image, steps)
Parameters:

  • image (Gimp.Image) – The image.

  • steps (int) – Steps of grow (in pixels).

Returns:

True on success.

Return type:

bool

Grow the image’s selection

This procedure grows the selection. Growing involves expanding the boundary in all directions by the specified pixel amount.

classmethod invert(image)
Parameters:

image (Gimp.Image) – The image.

Returns:

True on success.

Return type:

bool

Invert the selection mask.

This procedure inverts the selection mask. For every pixel in the selection channel, its new value is calculated as (255 - old-value).

classmethod is_empty(image)
Parameters:

image (Gimp.Image) – The image.

Returns:

Is the selection empty?

Return type:

bool

Determine whether the selection is empty.

This procedure returns True if the selection for the specified image is empty.

classmethod none(image)
Parameters:

image (Gimp.Image) – The image.

Returns:

True on success.

Return type:

bool

Deselect the entire image.

This procedure deselects the entire image. Every pixel in the selection channel is set to 0.

classmethod save(image)
Parameters:

image (Gimp.Image) – The image.

Returns:

The new channel.

Return type:

Gimp.Channel

Copy the selection mask to a new channel.

This procedure copies the selection mask and stores the content in a new channel. The new channel is automatically inserted into the image’s list of channels.

classmethod sharpen(image)
Parameters:

image (Gimp.Image) – The image.

Returns:

True on success.

Return type:

bool

Sharpen the selection mask.

This procedure sharpens the selection mask. For every pixel in the selection channel, if the value is > 127, the new pixel is assigned a value of 255. This removes any \”anti-aliasing\” that might exist in the selection mask’s boundary.

classmethod shrink(image, steps)
Parameters:

  • image (Gimp.Image) – The image.

  • steps (int) – Steps of shrink (in pixels).

Returns:

True on success.

Return type:

bool

Shrink the image’s selection

This procedure shrinks the selection. Shrinking involves trimming the existing selection boundary on all sides by the specified number of pixels.

classmethod translate(image, offx, offy)
Parameters:

  • image (Gimp.Image) – The image.

  • offx (int) – x offset for translation.

  • offy (int) – y offset for translation.

Returns:

True on success.

Return type:

bool

Translate the selection by the specified offsets.

This procedure actually translates the selection for the specified image by the specified offsets. Regions that are translated from beyond the bounds of the image are set to empty. Valid regions of the selection which are translated beyond the bounds of the image because of this call are lost.

classmethod value(image, x, y)
Parameters:

  • image (Gimp.Image) – The image.

  • x (int) – x coordinate of value.

  • y (int) – y coordinate of value.

Returns:

Value of the selection.

Return type:

int

Find the value of the selection at the specified coordinates.

This procedure returns the value of the selection at the specified coordinates. If the coordinates lie out of bounds, 0 is returned.