|
def | makeVisitInfo (self, headers, exposureId) |
|
def | extractVisitEntry (self, file, headers, dataId, associated) |
|
def | extractExposureEntry (self, file, headers, dataId, associated) |
|
def | getDatasetType (cls) |
|
def | run (self, files) |
|
def | readHeaders (self, file) |
|
def | ensureDataUnits (self, file) |
|
def | ingestFile (self, file, headers, dataId, run=None) |
|
def | processFile (self, file) |
|
def | extractDataId (self, file, headers) |
|
def | getFormatter (self, file, headers, dataId) |
|
An intermediate base class of RawIngestTask for cameras that already
implement constructing a `afw.image.VisitInfo` object from raw data.
Subclasses must provide (at least) implementations of `extractDataId` and
the new `makeVisitInfo` method; the latter is used to provide concrete
implementations of `extractVisitEntry` and `extractExposureEntry`.
Definition at line 435 of file ingest.py.
def lsst.obs.base.gen3.ingest.RawIngestTask.extractDataId |
( |
|
self, |
|
|
|
file, |
|
|
|
headers |
|
) |
| |
|
inherited |
Return the Data ID dictionary that should be used to label a file.
Parameters
----------
file : `str` or path-like object
Absolute path to the file being ingested (prior to any transfers).
headers : `list` of `~lsst.daf.base.PropertyList`
All headers returned by `readHeaders()`.
Returns
-------
dataId : `dict`
Must include "camera", "sensor", and "exposure" keys. If the
Exposure is associated with a PhysicalFilter and/or Visit,
"physical_filter" and "visit" keys should be provided as well
(respectively).
Definition at line 343 of file ingest.py.
def lsst.obs.base.gen3.ingest.VisitInfoRawIngestTask.extractExposureEntry |
( |
|
self, |
|
|
|
file, |
|
|
|
headers, |
|
|
|
dataId, |
|
|
|
associated |
|
) |
| |
Create an Exposure DataUnit entry from raw file metadata.
Parameters
----------
file : `str` or path-like object
Absolute path to the file being ingested (prior to any transfers).
headers : `list` of `~lsst.daf.base.PropertyList`
All headers returned by `readHeaders()`.
dataId : `dict`
The data ID for this file. Implementations are permitted to
modify this dictionary (generally by stripping off "sensor" and
adding new metadata key-value pairs) and return it.
associated : `dict`
A dictionary containing other associated DataUnit entries.
Guaranteed to have "Camera", "Sensor", "PhysicalFilter", and
"Visit" keys, but the latter two may map to ``None`` if
`extractDataId` did not contain keys for these or mapped them to
``None``. May also contain additional keys added by
`extractVisitEntry`.
Returns
-------
entry : `dict`
Dictionary corresponding to an Exposure database table row.
Must have all non-null columns in the Exposure table as keys.
Definition at line 490 of file ingest.py.
def lsst.obs.base.gen3.ingest.VisitInfoRawIngestTask.extractVisitEntry |
( |
|
self, |
|
|
|
file, |
|
|
|
headers, |
|
|
|
dataId, |
|
|
|
associated |
|
) |
| |
Create a Visit DataUnit entry from raw file metadata.
Parameters
----------
file : `str` or path-like object
Absolute path to the file being ingested (prior to any transfers).
headers : `list` of `~lsst.daf.base.PropertyList`
All headers returned by `readHeaders()`.
dataId : `dict`
The data ID for this file. Implementations are permitted to
modify this dictionary (generally by stripping off "sensor" and
"exposure" and adding new metadata key-value pairs) and return it.
associated : `dict`
A dictionary containing other associated DataUnit entries.
Guaranteed to have "Camera", "Sensor", and "PhysicalFilter" keys,
but the last may map to ``None`` if `extractDataId` either did not
contain a "physical_filter" key or mapped it to ``None``.
Also adds a "VisitInfo" key containing an `afw.image.VisitInfo`
object for use by `extractExposureEntry`.
Returns
-------
entry : `dict`
Dictionary corresponding to an Visit database table row.
Must have all non-null columns in the Visit table as keys.
Definition at line 457 of file ingest.py.
def lsst.obs.base.gen3.ingest.RawIngestTask.run |
( |
|
self, |
|
|
|
files |
|
) |
| |
|
inherited |
Ingest files into a Butler data repository.
This creates any new Exposure or Visit DataUnit 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 Camera, Sensor, and PhysicalFilter DataUnit 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.
Definition at line 148 of file ingest.py.