Inheritance diagram for sourcextractor.config.measurement_images.ImageGroup:

Collaboration diagram for sourcextractor.config.measurement_images.ImageGroup:

Public Member Functions
	__init__ (self, **kwargs)

	__len__ (self)

	__iter__ (self)

	split (self, grouping_method)

	add_images (self, images)

	add_subgroup (self, name, group)

	is_leaf (self)

	__getitem__ (self, name)

	print (self, prefix='', show_images=False, file=sys.stderr)

	__str__ (self)

Private Attributes
	__images

	__subgroups

	__subgroup_names

Detailed Description

Models the grouping of images. Measurement can *not* be made directly on instances of this type.
The configuration must be "frozen" before creating a MeasurementGroup

See Also
--------
MeasurementGroup

Definition at line 250 of file measurement_images.py.

Constructor & Destructor Documentation

◆ init()

sourcextractor.config.measurement_images.ImageGroup.__init__	(		self,
		**	kwargs )

Constructor. It is not recommended to be used directly. Use instead load_fits_image or load_fits_images.

Definition at line 260 of file measurement_images.py.

Member Function Documentation

◆ getitem()

sourcextractor.config.measurement_images.ImageGroup.__getitem__	(		self,
			name )

Get a subgroup.

Parameters
----------
name : str
    The name of the subgroup.

Returns
-------
ImageGroup
    The matching group.

Raises
------
ValueError
    If the group has not been split.
KeyError
    If the group has not been found.

Definition at line 397 of file measurement_images.py.

References sourcextractor.config.measurement_images.ImageGroup.__subgroups, and sourcextractor.config.measurement_images.MeasurementGroup.__subgroups.

◆ iter()

sourcextractor.config.measurement_images.ImageGroup.__iter__ ( self )

Allows to iterate on the contained subgroups or images

See Also
--------
is_leaf

Returns
-------
iterator

Definition at line 296 of file measurement_images.py.

References sourcextractor.config.measurement_images.ImageGroup.__images, sourcextractor.config.measurement_images.MeasurementGroup.__images, sourcextractor.config.measurement_images.ImageGroup.__iter__(), sourcextractor.config.measurement_images.ImageGroup.__subgroups, and sourcextractor.config.measurement_images.MeasurementGroup.__subgroups.

Referenced by sourcextractor.config.measurement_images.ImageGroup.__iter__().

Here is the call graph for this function:

◆ len()

sourcextractor.config.measurement_images.ImageGroup.__len__ ( self )

See Also
--------
is_leaf

Returns
-------
int
    How may subgroups or images are there in this group

Definition at line 280 of file measurement_images.py.

References sourcextractor.config.measurement_images.ImageGroup.__images, sourcextractor.config.measurement_images.MeasurementGroup.__images, sourcextractor.config.measurement_images.ImageGroup.__subgroups, and sourcextractor.config.measurement_images.MeasurementGroup.__subgroups.

◆ str()

sourcextractor.config.measurement_images.ImageGroup.__str__ ( self )

Returns
-------
str
    A human-readable representation of the group

Definition at line 451 of file measurement_images.py.

References SourceXtractor::ProgressLogger.print(), sourcextractor.config.measurement_images.ImageGroup.print(), and sourcextractor.config.measurement_images.MeasurementGroup.print().

Here is the call graph for this function:

◆ add_images()

sourcextractor.config.measurement_images.ImageGroup.add_images	(		self,
			images )

Add new images to the group.

Parameters
----------
images : list of, or a single, MeasurementImage

Raises
------
ValueError
    If the group has been split, no new images can be added.

Definition at line 350 of file measurement_images.py.

References sourcextractor.config.measurement_images.ImageGroup.__images, sourcextractor.config.measurement_images.MeasurementGroup.__images, sourcextractor.config.measurement_images.ImageGroup.__subgroups, and sourcextractor.config.measurement_images.MeasurementGroup.__subgroups.

◆ add_subgroup()

sourcextractor.config.measurement_images.ImageGroup.add_subgroup	(	self,
		name,
		group )

Add a subgroup to a group.

Parameters
----------
name : str
    The new of the new group

group : ImageGroup

Definition at line 370 of file measurement_images.py.

References sourcextractor.config.measurement_images.ImageGroup.__subgroup_names, sourcextractor.config.measurement_images.ImageGroup.__subgroups, and sourcextractor.config.measurement_images.MeasurementGroup.__subgroups.

◆ is_leaf()

sourcextractor.config.measurement_images.ImageGroup.is_leaf ( self )

Returns
-------
bool
    True if the group is a leaf group

Definition at line 388 of file measurement_images.py.

References sourcextractor.config.measurement_images.ImageGroup.__subgroups, and sourcextractor.config.measurement_images.MeasurementGroup.__subgroups.

◆ print()

sourcextractor.config.measurement_images.ImageGroup.print	(	self,
		prefix = '',
		show_images = False,
		file = sys.stderr )

Print a human-readable representation of the group.

Parameters
----------
prefix : str
    Print each line with this prefix. Used internally for indentation.
show_images : bool
    Show the images belonging to a leaf group.
file : file object
    Where to print the representation. Defaults to sys.stderr

Definition at line 425 of file measurement_images.py.

References sourcextractor.config.measurement_images.ImageGroup.__images, sourcextractor.config.measurement_images.MeasurementGroup.__images, sourcextractor.config.measurement_images.ImageGroup.__subgroups, sourcextractor.config.measurement_images.MeasurementGroup.__subgroups, and sourcextractor.config.measurement_images.ImageGroup.print().

Referenced by sourcextractor.config.measurement_images.ImageGroup.__str__(), sourcextractor.config.measurement_images.MeasurementGroup.__str__(), and sourcextractor.config.measurement_images.ImageGroup.print().

Here is the call graph for this function:

◆ split()

sourcextractor.config.measurement_images.ImageGroup.split	(		self,
			grouping_method )

Splits the group in various subgroups, applying a filter on the contained images. If the group has
already been split, applies the split to each subgroup.

Parameters
----------
grouping_method : callable
    A callable that receives as a parameter the list of contained images, and returns
    a list of tuples, with the grouping key value, and the list of grouped images belonging to the given key.

See Also
--------
ByKeyword
ByPattern

Raises
-------
ValueError
    If some images have not been grouped by the callable.

Definition at line 313 of file measurement_images.py.

References sourcextractor.config.measurement_images.ImageGroup.__images, sourcextractor.config.measurement_images.MeasurementGroup.__images, sourcextractor.config.measurement_images.ImageGroup.__subgroup_names, sourcextractor.config.measurement_images.ImageGroup.__subgroups, and sourcextractor.config.measurement_images.MeasurementGroup.__subgroups.

Member Data Documentation

◆ __images

sourcextractor.config.measurement_images.ImageGroup.__images

private

Definition at line 264 of file measurement_images.py.

◆ __subgroup_names

sourcextractor.config.measurement_images.ImageGroup.__subgroup_names

private

Definition at line 266 of file measurement_images.py.

Referenced by sourcextractor.config.measurement_images.ImageGroup.add_subgroup(), and sourcextractor.config.measurement_images.ImageGroup.split().

◆ __subgroups

sourcextractor.config.measurement_images.ImageGroup.__subgroups

private

Definition at line 265 of file measurement_images.py.

The documentation for this class was generated from the following file:

SEImplementation/python/sourcextractor/config/measurement_images.py

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getitem__()

◆ __iter__()

◆ __len__()

◆ __str__()

◆ add_images()

◆ add_subgroup()

◆ is_leaf()

◆ print()

◆ split()

Member Data Documentation

◆ __images

◆ __subgroup_names

◆ __subgroups

◆ init()

◆ getitem()

◆ iter()

◆ len()

◆ str()