LSST Applications
21.0.0+75b29a8a7f,21.0.0+e70536a077,21.0.0-1-ga51b5d4+62c747d40b,21.0.0-10-gbfb87ad6+3307648ee3,21.0.0-15-gedb9d5423+47cba9fc36,21.0.0-2-g103fe59+fdf0863a2a,21.0.0-2-g1367e85+d38a93257c,21.0.0-2-g45278ab+e70536a077,21.0.0-2-g5242d73+d38a93257c,21.0.0-2-g7f82c8f+e682ffb718,21.0.0-2-g8dde007+d179fbfa6a,21.0.0-2-g8f08a60+9402881886,21.0.0-2-ga326454+e682ffb718,21.0.0-2-ga63a54e+08647d4b1b,21.0.0-2-gde069b7+26c92b3210,21.0.0-2-gecfae73+0445ed2f95,21.0.0-2-gfc62afb+d38a93257c,21.0.0-27-gbbd0d29+ae871e0f33,21.0.0-28-g5fc5e037+feb0e9397b,21.0.0-3-g21c7a62+f4b9c0ff5c,21.0.0-3-g357aad2+57b0bddf0b,21.0.0-3-g4be5c26+d38a93257c,21.0.0-3-g65f322c+3f454acf5d,21.0.0-3-g7d9da8d+75b29a8a7f,21.0.0-3-gaa929c8+9e4ef6332c,21.0.0-3-ge02ed75+4b120a55c4,21.0.0-4-g3300ddd+e70536a077,21.0.0-4-g591bb35+4b120a55c4,21.0.0-4-gc004bbf+4911b9cd27,21.0.0-4-gccdca77+f94adcd104,21.0.0-4-ge8fba5a+2b3a696ff9,21.0.0-5-gb155db7+2c5429117a,21.0.0-5-gdf36809+637e4641ee,21.0.0-6-g00874e7+c9fd7f7160,21.0.0-6-g4e60332+4b120a55c4,21.0.0-7-gc8ca178+40eb9cf840,21.0.0-8-gfbe0b4b+9e4ef6332c,21.0.0-9-g2fd488a+d83b7cd606,w.2021.05
LSST Data Management Base Package
|
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) |
def | emptyMetadata (self) |
def | getSchemaCatalogs (self) |
def | getAllSchemaCatalogs (self) |
def | getFullMetadata (self) |
def | getFullName (self) |
def | getName (self) |
def | getTaskDict (self) |
def | makeSubtask (self, name, **keyArgs) |
def | timer (self, name, logLevel=Log.DEBUG) |
def | makeField (cls, doc) |
def | __reduce__ (self) |
Public Attributes | |
butler | |
instrumentMap | |
metadata | |
log | |
config | |
Static Public Attributes | |
ConfigClass = ComputeVisitRegionsConfig | |
registry | |
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.
def lsst.obs.base.defineVisits.ComputeVisitRegionsTask.__init__ | ( | self, | |
ComputeVisitRegionsConfig | config, | ||
*Butler | butler, | ||
**Any | kwargs | ||
) |
Definition at line 197 of file defineVisits.py.
|
inherited |
Pickler.
Reimplemented in lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask, and lsst.pipe.drivers.coaddDriver.CoaddDriverTask.
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.
|
inherited |
Empty (clear) the metadata for this Task and all sub-Tasks.
Definition at line 166 of file task.py.
|
inherited |
Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict. Returns ------- schemacatalogs : `dict` Keys are butler dataset type, values are a empty catalog (an instance of the appropriate `lsst.afw.table` Catalog type) for all tasks in the hierarchy, from the top-level task down through all subtasks. Notes ----- This method may be called on any task in the hierarchy; it will return the same answer, regardless. The default implementation should always suffice. If your subtask uses schemas the override `Task.getSchemaCatalogs`, not this method.
Definition at line 204 of file task.py.
|
inherited |
Get metadata for all tasks. Returns ------- metadata : `lsst.daf.base.PropertySet` The `~lsst.daf.base.PropertySet` keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc. Notes ----- The returned metadata includes timing information (if ``@timer.timeMethod`` is used) and any metadata set by the task. The name of each item consists of the full task name with ``.`` replaced by ``:``, followed by ``.`` and the name of the item, e.g.:: topLevelTaskName:subtaskName:subsubtaskName.itemName using ``:`` in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.
Definition at line 229 of file task.py.
|
inherited |
Get the task name as a hierarchical name including parent task names. Returns ------- fullName : `str` The full name consists of the name of the parent task and each subtask separated by periods. For example: - The full name of top-level task "top" is simply "top". - The full name of subtask "sub" of top-level task "top" is "top.sub". - The full name of subtask "sub2" of subtask "sub" of top-level task "top" is "top.sub.sub2".
Definition at line 256 of file task.py.
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.
|
inherited |
Get the name of the task. Returns ------- taskName : `str` Name of the task. See also -------- getFullName
Definition at line 274 of file task.py.
|
inherited |
Get the schemas generated by this task. Returns ------- schemaCatalogs : `dict` Keys are butler dataset type, values are an empty catalog (an instance of the appropriate `lsst.afw.table` Catalog type) for this task. Notes ----- .. warning:: Subclasses that use schemas must override this method. The default implementation returns an empty dict. This method may be called at any time after the Task is constructed, which means that all task schemas should be computed at construction time, *not* when data is actually processed. This reflects the philosophy that the schema should not depend on the data. Returning catalogs rather than just schemas allows us to save e.g. slots for SourceCatalog as well. See also -------- Task.getAllSchemaCatalogs
Definition at line 172 of file task.py.
|
inherited |
Get a dictionary of all tasks as a shallow copy. Returns ------- taskDict : `dict` Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
Definition at line 288 of file task.py.
|
inherited |
Make a `lsst.pex.config.ConfigurableField` for this task. Parameters ---------- doc : `str` Help text for the field. Returns ------- configurableField : `lsst.pex.config.ConfigurableField` A `~ConfigurableField` for this task. Examples -------- Provides a convenient way to specify this task is a subtask of another task. Here is an example of use: .. code-block:: python class OtherTaskConfig(lsst.pex.config.Config): aSubtask = ATaskClass.makeField("brief description of task")
Definition at line 359 of file task.py.
|
inherited |
Create a subtask as a new instance as the ``name`` attribute of this task. Parameters ---------- name : `str` Brief name of the subtask. keyArgs Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden: - "config". - "parentTask". Notes ----- The subtask must be defined by ``Task.config.name``, an instance of `~lsst.pex.config.ConfigurableField` or `~lsst.pex.config.RegistryField`.
Definition at line 299 of file task.py.
|
inherited |
Context manager to log performance data for an arbitrary block of code. Parameters ---------- name : `str` Name of code being timed; data will be logged using item name: ``Start`` and ``End``. logLevel A `lsst.log` level constant. Examples -------- Creating a timer context: .. code-block:: python with self.timer("someCodeToTime"): pass # code to time See also -------- timer.logInfo
Definition at line 327 of file task.py.
lsst.obs.base.defineVisits.ComputeVisitRegionsTask.butler |
Definition at line 199 of file defineVisits.py.
|
static |
Definition at line 202 of file defineVisits.py.
lsst.obs.base.defineVisits.ComputeVisitRegionsTask.instrumentMap |
Definition at line 200 of file defineVisits.py.
|
static |
Definition at line 206 of file defineVisits.py.