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

Public Member Functions

def __init__ (self, GroupExposuresConfig config, **Any kwargs)
 
Iterable[VisitDefinitionDatagroup (self, List[DimensionRecord] exposures)
 
Tuple[int, str] getVisitSystem (self)
 

Static Public Attributes

 ConfigClass = GroupExposuresConfig
 
 registry
 

Detailed Description

Abstract base class for the subtask of `DefineVisitsTask` that is
responsible for grouping exposures into visits.

Subclasses should be registered with `GroupExposuresTask.registry` to
enable use by `DefineVisitsTask`, and should generally correspond to a
particular 'visit_system' dimension value.  They are also responsible for
defining visit IDs and names that are unique across all visit systems in
use by an instrument.

Parameters
----------
config : `GroupExposuresConfig`
    Configuration information.
**kwargs
    Additional keyword arguments forwarded to the `Task` constructor.

Definition at line 103 of file defineVisits.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.defineVisits.GroupExposuresTask.__init__ (   self,
GroupExposuresConfig  config,
**Any  kwargs 
)

Definition at line 120 of file defineVisits.py.

Member Function Documentation

◆ getVisitSystem()

Tuple[int, str] lsst.obs.base.defineVisits.GroupExposuresTask.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 in lsst.obs.base.defineVisits._GroupExposuresByGroupMetadataTask, and lsst.obs.base.defineVisits._GroupExposuresOneToOneTask.

Definition at line 151 of file defineVisits.py.

◆ group()

Iterable[VisitDefinitionData] lsst.obs.base.defineVisits.GroupExposuresTask.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 in lsst.obs.base.defineVisits._GroupExposuresByGroupMetadataTask, and lsst.obs.base.defineVisits._GroupExposuresOneToOneTask.

Definition at line 133 of file defineVisits.py.

Member Data Documentation

◆ ConfigClass

lsst.obs.base.defineVisits.GroupExposuresTask.ConfigClass = GroupExposuresConfig
static

Definition at line 123 of file defineVisits.py.

◆ registry

lsst.obs.base.defineVisits.GroupExposuresTask.registry
static
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: