lsst.obs.base  21.0.0-9-g0393deb+2a5fe077cf
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.defineVisits.ComputeVisitRegionsTask Class Reference
Inheritance diagram for lsst.obs.base.defineVisits.ComputeVisitRegionsTask:
lsst.obs.base.defineVisits._ComputeVisitRegionsFromSingleRawWcsTask

Public Member Functions

def __init__ (self, ComputeVisitRegionsConfig config, *Butler butler, **Any kwargs)
 
Instrument getInstrument (self, instrumentName)
 
Tuple[Region, Dict[int, Region]] compute (self, VisitDefinitionData visit, *Any collections=None)
 

Public Attributes

 butler
 
 instrumentMap
 

Static Public Attributes

 ConfigClass = ComputeVisitRegionsConfig
 
 registry
 

Detailed Description

Abstract base class for the subtask of `DefineVisitsTask` that is
responsible for extracting spatial regions for visits and visit+detector
combinations.

Subclasses should be registered with `ComputeVisitRegionsTask.registry` to
enable use by `DefineVisitsTask`.

Parameters
----------
config : `ComputeVisitRegionsConfig`
    Configuration information.
butler : `lsst.daf.butler.Butler`
    The butler to use.
**kwargs
    Additional keyword arguments forwarded to the `Task` constructor.

Definition at line 180 of file defineVisits.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.defineVisits.ComputeVisitRegionsTask.__init__ (   self,
ComputeVisitRegionsConfig  config,
*Butler  butler,
**Any  kwargs 
)

Definition at line 197 of file defineVisits.py.

Member Function Documentation

◆ compute()

Tuple[Region, Dict[int, Region]] lsst.obs.base.defineVisits.ComputeVisitRegionsTask.compute (   self,
VisitDefinitionData  visit,
*Any   collections = None 
)
Compute regions for the given visit and all detectors in that visit.

Parameters
----------
visit : `VisitDefinitionData`
    Struct describing the visit and the exposures associated with it.
collections : Any, optional
    Collections to be searched for raws and camera geometry, overriding
    ``self.butler.collections``.
    Can be any of the types supported by the ``collections`` argument
    to butler construction.

Returns
-------
visitRegion : `lsst.sphgeom.Region`
    Region for the full visit.
visitDetectorRegions : `dict` [ `int`, `lsst.sphgeom.Region` ]
    Dictionary mapping detector ID to the region for that detector.
    Should include all detectors in the visit.

Reimplemented in lsst.obs.base.defineVisits._ComputeVisitRegionsFromSingleRawWcsTask.

Definition at line 237 of file defineVisits.py.

◆ getInstrument()

Instrument lsst.obs.base.defineVisits.ComputeVisitRegionsTask.getInstrument (   self,
  instrumentName 
)
Retrieve an `~lsst.obs.base.Instrument` associated with this
instrument name.

Parameters
----------
instrumentName : `str`
    The name of the instrument.

Returns
-------
instrument : `~lsst.obs.base.Instrument`
    The associated instrument object.

Notes
-----
The result is cached.

Definition at line 212 of file defineVisits.py.

Member Data Documentation

◆ butler

lsst.obs.base.defineVisits.ComputeVisitRegionsTask.butler

Definition at line 199 of file defineVisits.py.

◆ ConfigClass

lsst.obs.base.defineVisits.ComputeVisitRegionsTask.ConfigClass = ComputeVisitRegionsConfig
static

Definition at line 202 of file defineVisits.py.

◆ instrumentMap

lsst.obs.base.defineVisits.ComputeVisitRegionsTask.instrumentMap

Definition at line 200 of file defineVisits.py.

◆ registry

lsst.obs.base.defineVisits.ComputeVisitRegionsTask.registry
static
Initial value:
= makeRegistry(
doc=("Registry of algorithms for computing on-sky regions for visits "
"and visit+detector combinations."),
configBaseType=ComputeVisitRegionsConfig,
)

Definition at line 206 of file defineVisits.py.


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