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 | getDatasetType (self) |
def | __init__ (self, Optional[RawIngestConfig] config=None, *Butler butler, **Any kwargs) |
RawFileData | extractMetadata (self, str filename) |
List[RawExposureData] | groupByExposure (self, Iterable[RawFileData] files) |
RawExposureData | expandDataIds (self, RawExposureData data) |
Iterator[RawExposureData] | prep (self, files, *Optional[Pool] pool=None, int processes=1) |
List[DatasetRef] | ingestExposureDatasets (self, RawExposureData exposure, *Optional[str] run=None) |
def | run (self, files, *Optional[Pool] pool=None, int processes=1, Optional[str] run=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 | |
universe | |
datasetType | |
metadata | |
log | |
config | |
Static Public Attributes | |
ConfigClass = RawIngestConfig | |
Driver Task for ingesting raw data into Gen3 Butler repositories. Parameters ---------- config : `RawIngestConfig` Configuration for the task. butler : `~lsst.daf.butler.Butler` Writeable butler instance, with ``butler.run`` set to the appropriate `~lsst.daf.butler.CollectionType.RUN` collection for these raw datasets. **kwargs Additional keyword arguments are forwarded to the `lsst.pipe.base.Task` constructor. Notes ----- Each instance of `RawIngestTask` writes to the same Butler. Each invocation of `RawIngestTask.run` ingests a list of files.
def lsst.obs.base.ingest.RawIngestTask.__init__ | ( | self, | |
Optional[RawIngestConfig] | config = None , |
||
*Butler | butler, | ||
**Any | kwargs | ||
) |
|
inherited |
Pickler.
Reimplemented in lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask, and lsst.pipe.drivers.coaddDriver.CoaddDriverTask.
|
inherited |
Empty (clear) the metadata for this Task and all sub-Tasks.
Definition at line 166 of file task.py.
RawExposureData lsst.obs.base.ingest.RawIngestTask.expandDataIds | ( | self, | |
RawExposureData | data | ||
) |
Expand the data IDs associated with a raw exposure to include additional metadata records. Parameters ---------- exposure : `RawExposureData` A structure containing information about the exposure to be ingested. Must have `RawExposureData.records` populated. Should be considered consumed upon return. Returns ------- exposure : `RawExposureData` An updated version of the input structure, with `RawExposureData.dataId` and nested `RawFileData.dataId` attributes updated to data IDs for which `DataCoordinate.hasRecords` returns `True`.
Definition at line 345 of file ingest.py.
RawFileData lsst.obs.base.ingest.RawIngestTask.extractMetadata | ( | self, | |
str | filename | ||
) |
Extract and process metadata from a single raw file. Parameters ---------- filename : `str` Path to the file. Returns ------- data : `RawFileData` A structure containing the metadata extracted from the file, as well as the original filename. All fields will be populated, but the `RawFileData.dataId` attribute will be a minimal (unexpanded) `DataCoordinate` instance. Notes ----- Assumes that there is a single dataset associated with the given file. Instruments using a single file to store multiple datasets must implement their own version of this method.
Reimplemented in lsst.obs.decam.ingest.DecamRawIngestTask.
Definition at line 207 of file ingest.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.
def lsst.obs.base.ingest.RawIngestTask.getDatasetType | ( | self | ) |
Return the DatasetType of the datasets ingested by this Task.
|
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.
|
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.
List[RawExposureData] lsst.obs.base.ingest.RawIngestTask.groupByExposure | ( | self, | |
Iterable[RawFileData] | files | ||
) |
Group an iterable of `RawFileData` by exposure. Parameters ---------- files : iterable of `RawFileData` File-level information to group. Returns ------- exposures : `list` of `RawExposureData` A list of structures that group the file-level information by exposure. All fields will be populated. The `RawExposureData.dataId` attributes will be minimal (unexpanded) `DataCoordinate` instances.
Definition at line 320 of file ingest.py.
List[DatasetRef] lsst.obs.base.ingest.RawIngestTask.ingestExposureDatasets | ( | self, | |
RawExposureData | exposure, | ||
*Optional[str] | run = None |
||
) |
Ingest all raw files in one exposure. Parameters ---------- exposure : `RawExposureData` A structure containing information about the exposure to be ingested. Must have `RawExposureData.records` populated and all data ID attributes expanded. run : `str`, optional Name of a RUN-type collection to write to, overriding ``self.butler.run``. Returns ------- refs : `list` of `lsst.daf.butler.DatasetRef` Dataset references for ingested raws.
Definition at line 457 of file ingest.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.
Iterator[RawExposureData] lsst.obs.base.ingest.RawIngestTask.prep | ( | self, | |
files, | |||
*Optional[Pool] | pool = None , |
||
int | processes = 1 |
||
) |
Perform all ingest preprocessing steps that do not involve actually modifying the database. Parameters ---------- files : iterable over `str` or path-like objects Paths to the files to be ingested. Will be made absolute if they are not already. 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`. Yields ------ exposure : `RawExposureData` Data structures containing dimension records, filenames, and data IDs to be ingested (one structure for each exposure). bad_files : `list` of `str` List of all the files that could not have metadata extracted.
def lsst.obs.base.ingest.RawIngestTask.run | ( | self, | |
files, | |||
*Optional[Pool] | pool = None , |
||
int | processes = 1 , |
||
Optional[str] | run = None |
||
) |
Ingest files into a Butler data repository. This creates any new exposure or visit Dimension entries needed to identify the ingested files, creates new Dataset entries in the Registry and finally ingests the files themselves into the Datastore. Any needed instrument, detector, and physical_filter Dimension entries must exist in the Registry before `run` is called. Parameters ---------- files : iterable over `str` or path-like objects Paths to the files to be ingested. Will be made absolute if they are not already. 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`. run : `str`, optional Name of a RUN-type collection to write to, overriding the default derived from the instrument name. Returns ------- refs : `list` of `lsst.daf.butler.DatasetRef` Dataset references for ingested raws. Notes ----- This method inserts all datasets for an exposure within a transaction, guaranteeing that partial exposures are never ingested. The exposure dimension record is inserted with `Registry.syncDimensionData` first (in its own transaction), which inserts only if a record with the same primary key does not already exist. This allows different files within the same exposure to be incremented in different runs.
Definition at line 483 of file ingest.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.
|
static |