lsst.obs.base  19.0.0-64-gf672fef+7
Public Member Functions | Static Public Attributes | List of all members
lsst.obs.base.defineVisits._GroupExposuresByGroupMetadataTask Class Reference
Inheritance diagram for lsst.obs.base.defineVisits._GroupExposuresByGroupMetadataTask:
lsst.obs.base.defineVisits.GroupExposuresTask

Public Member Functions

Iterable[VisitDefinitionDatagroup (self, List[DimensionRecord] exposures)
 
Tuple[int, str] getVisitSystem (self)
 

Static Public Attributes

 ConfigClass = _GroupExposuresOneToOneConfig
 
 registry
 

Detailed Description

An exposure grouping algorithm that uses exposure.group_name and
exposure.group_id.

This algorithm _assumes_ exposure.group_id (generally populated from
`astro_metadata_translator.ObservationInfo.visit_id`) is not just unique,
but disjoint from all `ObservationInfo.exposure_id` values - if it isn't,
it will be impossible to ever use both this grouping algorithm and the
one-to-one algorithm for a particular camera in the same data repository.

Definition at line 519 of file defineVisits.py.

Member Function Documentation

◆ getVisitSystem()

Tuple[int, str] lsst.obs.base.defineVisits._GroupExposuresByGroupMetadataTask.getVisitSystem (   self)
Return identifiers for the 'visit_system' dimension this
algorithm implements.

Returns
-------
id : `int`
    Integer ID for the visit system (given an instrument).
name : `str`
    Unique string identifier for the visit system (given an
    instrument).

Reimplemented from lsst.obs.base.defineVisits.GroupExposuresTask.

Definition at line 545 of file defineVisits.py.

◆ group()

Iterable[VisitDefinitionData] lsst.obs.base.defineVisits._GroupExposuresByGroupMetadataTask.group (   self,
List[DimensionRecord]  exposures 
)
Group the given exposures into visits.

Parameters
----------
exposures : `list` [ `DimensionRecord` ]
    DimensionRecords (for the 'exposure' dimension) describing the
    exposures to group.

Returns
-------
visits : `Iterable` [ `VisitDefinitionData` ]
    Structs identifying the visits and the exposures associated with
    them.  This may be an iterator or a container.

Reimplemented from lsst.obs.base.defineVisits.GroupExposuresTask.

Definition at line 532 of file defineVisits.py.

Member Data Documentation

◆ ConfigClass

lsst.obs.base.defineVisits._GroupExposuresByGroupMetadataTask.ConfigClass = _GroupExposuresOneToOneConfig
static

Definition at line 530 of file defineVisits.py.

◆ registry

lsst.obs.base.defineVisits.GroupExposuresTask.registry
staticinherited
Initial value:
= makeRegistry(
doc="Registry of algorithms for grouping exposures into visits.",
configBaseType=GroupExposuresConfig,
)

Definition at line 127 of file defineVisits.py.


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