sourcextractor.config.measurement_images.MeasurementGroup Class Reference

Inheritance diagram for sourcextractor.config.measurement_images.MeasurementGroup:

Collaboration diagram for sourcextractor.config.measurement_images.MeasurementGroup:

Public Member Functions
	__init__ (self, image_group, is_subgroup=False)
	__iter__ (self)
	__getitem__ (self, index)
	__len__ (self)
	is_leaf (self)
	print (self, prefix='', show_images=False, file=sys.stderr)
	__str__ (self)

Private Attributes
	__images
	__subgroups

Detailed Description

Once an instance of this class is created from an ImageGroup, its configuration is "frozen". i.e.
no new images can be added, or no new grouping applied.

Parameters
----------
image_group : ImageGroup

Definition at line 558 of file measurement_images.py.

Constructor & Destructor Documentation

__init__()

sourcextractor.config.measurement_images.MeasurementGroup.__init__	(		self,
			image_group,
			is_subgroup = False )

Constructor.

Definition at line 568 of file measurement_images.py.

Member Function Documentation

__getitem__()

sourcextractor.config.measurement_images.MeasurementGroup.__getitem__	(		self,
			index )

The subgroup with the given name or image with the given index depending on whether this is a leaf group.

Parameters
----------
index : str or int
    Subgroup name or image index

Returns
-------
MeasurementGroup or MeasurementImage

Raises
------
KeyError
    If we can't find what we want

Definition at line 590 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.

__iter__()

sourcextractor.config.measurement_images.MeasurementGroup.__iter__

(

self

)

Returns
-------
iterator

Definition at line 579 of file measurement_images.py.

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

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

Here is the call graph for this function:

__len__()

sourcextractor.config.measurement_images.MeasurementGroup.__len__

(

self

)

Returns
-------
int
    Number of subgroups, or images contained within the group

Definition at line 620 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.MeasurementGroup.__str__

(

self

)

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

Definition at line 666 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:

is_leaf()

sourcextractor.config.measurement_images.MeasurementGroup.is_leaf

(

self

)

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

Definition at line 632 of file measurement_images.py.

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

print()

sourcextractor.config.measurement_images.MeasurementGroup.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 641 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.MeasurementGroup.print().

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

Here is the call graph for this function:

Member Data Documentation

__images

sourcextractor.config.measurement_images.MeasurementGroup.__images

private

Definition at line 572 of file measurement_images.py.

Referenced by sourcextractor.config.measurement_images.MeasurementGroup.__getitem__(), sourcextractor.config.measurement_images.ImageGroup.__iter__(), sourcextractor.config.measurement_images.MeasurementGroup.__iter__(), sourcextractor.config.measurement_images.ImageGroup.__len__(), sourcextractor.config.measurement_images.MeasurementGroup.__len__(), sourcextractor.config.measurement_images.ImageGroup.add_images(), sourcextractor.config.measurement_images.ImageGroup.print(), sourcextractor.config.measurement_images.MeasurementGroup.print(), and sourcextractor.config.measurement_images.ImageGroup.split().

__subgroups

sourcextractor.config.measurement_images.MeasurementGroup.__subgroups

private

Definition at line 573 of file measurement_images.py.

Referenced by sourcextractor.config.measurement_images.MeasurementGroup.__getitem__(), sourcextractor.config.measurement_images.ImageGroup.__getitem__(), sourcextractor.config.measurement_images.ImageGroup.__iter__(), sourcextractor.config.measurement_images.MeasurementGroup.__iter__(), sourcextractor.config.measurement_images.ImageGroup.__len__(), sourcextractor.config.measurement_images.MeasurementGroup.__len__(), sourcextractor.config.measurement_images.ImageGroup.add_images(), sourcextractor.config.measurement_images.ImageGroup.add_subgroup(), sourcextractor.config.measurement_images.ImageGroup.is_leaf(), sourcextractor.config.measurement_images.MeasurementGroup.is_leaf(), sourcextractor.config.measurement_images.ImageGroup.print(), sourcextractor.config.measurement_images.MeasurementGroup.print(), and sourcextractor.config.measurement_images.ImageGroup.split().

---

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

• SEImplementation/python/sourcextractor/config/measurement_images.py