SourceXtractorPlusPlus
0.14
Please provide a description of the project.
|
Public Member Functions | |
def | __init__ |
def | __len__ |
def | __iter__ |
def | split |
def | add_images |
def | add_subgroup |
def | is_leaf |
def | __getitem__ |
def | |
def | __str__ |
Private Attributes | |
__images | |
__subgroups | |
__subgroup_names | |
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 230 of file measurement_images.py.
def 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 240 of file measurement_images.py.
def 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 377 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.__subgroups.
def 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 276 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.__subgroups.
def 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 260 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.__images, and sourcextractor.config.measurement_images.ImageGroup.__subgroups.
def sourcextractor.config.measurement_images.ImageGroup.__str__ | ( | self | ) |
Returns ------- str A human-readable representation of the group
Definition at line 429 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.print().
def 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 330 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.__subgroups.
def 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 350 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.__subgroup_names, and sourcextractor.config.measurement_images.ImageGroup.__subgroups.
def sourcextractor.config.measurement_images.ImageGroup.is_leaf | ( | self | ) |
Returns ------- bool True if the group is a leaf group
Definition at line 368 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.__subgroups.
def 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 405 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.__images, sourcextractor.config.measurement_images.ImageGroup.__subgroups, and join().
Referenced by sourcextractor.config.measurement_images.ImageGroup.__str__(), and sourcextractor.config.measurement_images.MeasurementGroup.__str__().
def 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 293 of file measurement_images.py.
References sourcextractor.config.measurement_images.ImageGroup.__images, sourcextractor.config.measurement_images.ImageGroup.__subgroup_names, and sourcextractor.config.measurement_images.ImageGroup.__subgroups.
|
private |
Definition at line 244 of file measurement_images.py.
Referenced by sourcextractor.config.measurement_images.MeasurementGroup.__getitem__(), sourcextractor.config.measurement_images.ImageGroup.__len__(), sourcextractor.config.measurement_images.MeasurementGroup.__len__(), sourcextractor.config.measurement_images.ImageGroup.print(), sourcextractor.config.measurement_images.MeasurementGroup.print(), and sourcextractor.config.measurement_images.ImageGroup.split().
|
private |
Definition at line 246 of file measurement_images.py.
Referenced by sourcextractor.config.measurement_images.ImageGroup.add_subgroup(), and sourcextractor.config.measurement_images.ImageGroup.split().
|
private |
Definition at line 245 of file measurement_images.py.
Referenced by sourcextractor.config.measurement_images.ImageGroup.__getitem__(), 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.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().