lsst.obs.base  20.0.0-37-g38a3e24+799acde9b7
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.defineVisits._ComputeVisitRegionsFromSingleRawWcsTask Class Reference
Inheritance diagram for lsst.obs.base.defineVisits._ComputeVisitRegionsFromSingleRawWcsTask:
lsst.obs.base.defineVisits.ComputeVisitRegionsTask

Public Member Functions

Dict[int, List[UnitVector3d]] computeExposureBounds (self, DimensionRecord exposure, *Any collections=None)
 
Tuple[Region, Dict[int, Region]] compute (self, VisitDefinitionData visit, *Any collections=None)
 
Instrument getInstrument (self, instrumentName)
 

Public Attributes

 butler
 
 instrumentMap
 

Static Public Attributes

 ConfigClass = _ComputeVisitRegionsFromSingleRawWcsConfig
 
 registry
 

Detailed Description

A visit region calculator that uses a single raw WCS and a camera to
project the bounding boxes of all detectors onto the sky, relating
different detectors by their positions in focal plane coordinates.

Notes
-----
Most instruments should have their raw WCSs determined from a combination
of boresight angle, rotator angle, and camera geometry, and hence this
algorithm should produce stable results regardless of which detector the
raw corresponds to.  If this is not the case (e.g. because a per-file FITS
WCS is used instead), either the ID of the detector should be fixed (see
the ``detectorId`` config parameter) or a different algorithm used.

Definition at line 619 of file defineVisits.py.

Member Function Documentation

◆ compute()

Tuple[Region, Dict[int, Region]] lsst.obs.base.defineVisits._ComputeVisitRegionsFromSingleRawWcsTask.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 from lsst.obs.base.defineVisits.ComputeVisitRegionsTask.

Definition at line 709 of file defineVisits.py.

◆ computeExposureBounds()

Dict[int, List[UnitVector3d]] lsst.obs.base.defineVisits._ComputeVisitRegionsFromSingleRawWcsTask.computeExposureBounds (   self,
DimensionRecord  exposure,
*Any   collections = None 
)
Compute the lists of unit vectors on the sphere that correspond to
the sky positions of detector corners.

Parameters
----------
exposure : `DimensionRecord`
    Dimension record for the exposure.
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
-------
bounds : `dict`
    Dictionary mapping detector ID to a list of unit vectors on the
    sphere representing that detector's corners projected onto the sky.

Definition at line 636 of file defineVisits.py.

◆ getInstrument()

Instrument lsst.obs.base.defineVisits.ComputeVisitRegionsTask.getInstrument (   self,
  instrumentName 
)
inherited
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 210 of file defineVisits.py.

Member Data Documentation

◆ butler

lsst.obs.base.defineVisits.ComputeVisitRegionsTask.butler
inherited

Definition at line 197 of file defineVisits.py.

◆ ConfigClass

lsst.obs.base.defineVisits._ComputeVisitRegionsFromSingleRawWcsTask.ConfigClass = _ComputeVisitRegionsFromSingleRawWcsConfig
static

Definition at line 634 of file defineVisits.py.

◆ instrumentMap

lsst.obs.base.defineVisits.ComputeVisitRegionsTask.instrumentMap
inherited

Definition at line 198 of file defineVisits.py.

◆ registry

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

Definition at line 204 of file defineVisits.py.


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