SourceXtractorPlusPlus  0.12
Please provide a description of the project.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
sourcextractor.config.measurement_images.MeasurementGroup Class Reference
Inheritance diagram for sourcextractor.config.measurement_images.MeasurementGroup:
[legend]
Collaboration diagram for sourcextractor.config.measurement_images.MeasurementGroup:
[legend]

Public Member Functions

def __init__
 
def __iter__
 
def __getitem__
 
def __len__
 
def is_leaf
 
def print
 
def __str__
 

Private Attributes

 __images
 
 __subgroups
 

Static Private Attributes

tuple _all_groups = list()
 

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 656 of file measurement_images.py.

Constructor & Destructor Documentation

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

Definition at line 668 of file measurement_images.py.

Member Function Documentation

def 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 692 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.

def sourcextractor.config.measurement_images.MeasurementGroup.__iter__ (   self)
def sourcextractor.config.measurement_images.MeasurementGroup.__len__ (   self)
def sourcextractor.config.measurement_images.MeasurementGroup.__str__ (   self)
Returns
-------
str
    A human-readable representation of the group

Definition at line 768 of file measurement_images.py.

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

Here is the call graph for this function:

def sourcextractor.config.measurement_images.MeasurementGroup.is_leaf (   self)
Returns
-------
bool
    True if the group is a leaf group

Definition at line 734 of file measurement_images.py.

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

def 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 743 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 join().

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

Here is the call graph for this function:

Member Data Documentation

sourcextractor.config.measurement_images.MeasurementGroup.__images
private
sourcextractor.config.measurement_images.MeasurementGroup.__subgroups
private
tuple sourcextractor.config.measurement_images.MeasurementGroup._all_groups = list()
staticprivate

Definition at line 666 of file measurement_images.py.


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