lsst.obs.base  19.0.0-51-gb87bce2
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.defineVisits.DefineVisitsTask Class Reference
Inheritance diagram for lsst.obs.base.defineVisits.DefineVisitsTask:

Public Member Functions

def __init__ (self, Optional[DefineVisitsConfig] config=None, *Butler butler, **Any kwargs)
 
def run (self, Iterable[DataId] dataIds, *Optional[Pool] pool=None, int processes=1, Optional[str] collections=None)
 

Public Attributes

 butler
 
 universe
 

Static Public Attributes

 ConfigClass = DefineVisitsConfig
 

Detailed Description

Driver Task for defining visits (and their spatial regions) in Gen3
Butler repositories.

Parameters
----------
config : `DefineVisitsConfig`
    Configuration for the task.
butler : `~lsst.daf.butler.Butler`
    Writeable butler instance.  Will be used to read `raw.wcs` and `camera`
    datasets and insert/sync dimension data.
**kwargs
    Additional keyword arguments are forwarded to the `lsst.pipe.base.Task`
    constructor.

Notes
-----
Each instance of `DefineVisitsTask` reads from / writes to the same Butler.
Each invocation of `DefineVisitsTask.run` processes an independent group of
exposures into one or more new vists, all belonging to the same visit
system and instrument.

The actual work of grouping exposures and computing regions is delegated
to pluggable subtasks (`GroupExposuresTask` and `ComputeVisitRegionsTask`),
respectively.  The defaults are to create one visit for every exposure,
and to use exactly one (arbitrary) detector-level raw dataset's WCS along
with camera geometry to compute regions for all detectors.  Other
implementations can be created and configured for instruments for which
these choices are unsuitable (e.g. because visits and exposures are not
one-to-one, or because ``raw.wcs`` datasets for different detectors may not
be consistent with camera geomery).

It is not necessary in general to ingest all raws for an exposure before
defining a visit that includes the exposure; this depends entirely on the
`ComputeVisitRegionTask` subclass used.  For the default configuration,
a single raw for each exposure is sufficient.

Definition at line 250 of file defineVisits.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.defineVisits.DefineVisitsTask.__init__ (   self,
Optional[DefineVisitsConfig]   config = None,
*Butler  butler,
**Any  kwargs 
)

Definition at line 287 of file defineVisits.py.

Member Function Documentation

◆ run()

def lsst.obs.base.defineVisits.DefineVisitsTask.run (   self,
Iterable[DataId]  dataIds,
*Optional[Pool]   pool = None,
int   processes = 1,
Optional[str]   collections = None 
)
Add visit definitions to the registry for the given exposures.

Parameters
----------
dataIds : `Iterable` [ `dict` or `DataCoordinate` ]
    Exposure-level data IDs.  These must all correspond to the same
    instrument, and are expected to be on-sky science exposures.
pool : `multiprocessing.Pool`, optional
    If not `None`, a process pool with which to parallelize some
    operations.
processes : `int`, optional
    The number of processes to use.  Ignored if ``pool`` is not `None`.
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.

Definition at line 367 of file defineVisits.py.

Member Data Documentation

◆ butler

lsst.obs.base.defineVisits.DefineVisitsTask.butler

Definition at line 290 of file defineVisits.py.

◆ ConfigClass

lsst.obs.base.defineVisits.DefineVisitsTask.ConfigClass = DefineVisitsConfig
static

Definition at line 295 of file defineVisits.py.

◆ universe

lsst.obs.base.defineVisits.DefineVisitsTask.universe

Definition at line 291 of file defineVisits.py.


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