lsst.obs.base  19.0.0-18-g955d782+3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.ingest.RawIngestTask Class Reference
Inheritance diagram for lsst.obs.base.ingest.RawIngestTask:

Public Member Functions

def getDatasetType (self)
 
def __init__
 
def extractMetadata
 
def groupByExposure
 
def collectDimensionRecords
 
def expandDataIds
 
def prep
 
def insertDimensionData
 
def ingestExposureDatasets
 
def run
 

Public Attributes

 butler
 
 universe
 
 instrument
 
 camera
 
 datasetType
 

Static Public Attributes

 ConfigClass = RawIngestConfig
 

Detailed Description

Driver Task for ingesting raw data into Gen3 Butler repositories.

This Task is intended to be runnable from the command-line, but it doesn't
meet the other requirements of CmdLineTask or PipelineTask, and wouldn't
gain much from being one.  It also wouldn't really be appropriate as a
subtask of a CmdLineTask or PipelineTask; it's a Task essentially just to
leverage the logging and configurability functionality that provides.

Each instance of `RawIngestTask` writes to the same Butler.  Each
invocation of `RawIngestTask.run` ingests a list of files.

Parameters
----------
config : `RawIngestConfig`
    Configuration for the task.
butler : `~lsst.daf.butler.Butler`
    Butler instance.  Ingested Datasets will be created as part of
    ``butler.run`` and associated with its Collection.
kwds
    Additional keyword arguments are forwarded to the `lsst.pipe.base.Task`
    constructor.

Other keyword arguments are forwarded to the Task base class constructor.

Definition at line 172 of file ingest.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.ingest.RawIngestTask.__init__ (   self,
  config 
)

Definition at line 208 of file ingest.py.

Member Function Documentation

◆ collectDimensionRecords()

def lsst.obs.base.ingest.RawIngestTask.collectDimensionRecords (   self,
  exposure 
)

Definition at line 343 of file ingest.py.

◆ expandDataIds()

def lsst.obs.base.ingest.RawIngestTask.expandDataIds (   self,
  data 
)

Definition at line 398 of file ingest.py.

◆ extractMetadata()

def lsst.obs.base.ingest.RawIngestTask.extractMetadata (   self,
  filename 
)

Definition at line 220 of file ingest.py.

◆ getDatasetType()

def lsst.obs.base.ingest.RawIngestTask.getDatasetType (   self)
Return the DatasetType of the Datasets ingested by this Task.

Definition at line 202 of file ingest.py.

◆ groupByExposure()

def lsst.obs.base.ingest.RawIngestTask.groupByExposure (   self,
  files 
)

Definition at line 317 of file ingest.py.

◆ ingestExposureDatasets()

def lsst.obs.base.ingest.RawIngestTask.ingestExposureDatasets (   self,
  exposure 
)

Definition at line 533 of file ingest.py.

◆ insertDimensionData()

def lsst.obs.base.ingest.RawIngestTask.insertDimensionData (   self,
  records 
)

Definition at line 500 of file ingest.py.

◆ prep()

def lsst.obs.base.ingest.RawIngestTask.prep (   self,
  files,
  pool 
)

Definition at line 444 of file ingest.py.

◆ run()

def lsst.obs.base.ingest.RawIngestTask.run (   self,
  files,
  pool 
)

Definition at line 561 of file ingest.py.

Member Data Documentation

◆ butler

lsst.obs.base.ingest.RawIngestTask.butler

Definition at line 210 of file ingest.py.

◆ camera

lsst.obs.base.ingest.RawIngestTask.camera

Definition at line 217 of file ingest.py.

◆ ConfigClass

lsst.obs.base.ingest.RawIngestTask.ConfigClass = RawIngestConfig
static

Definition at line 198 of file ingest.py.

◆ datasetType

lsst.obs.base.ingest.RawIngestTask.datasetType

Definition at line 218 of file ingest.py.

◆ instrument

lsst.obs.base.ingest.RawIngestTask.instrument

Definition at line 212 of file ingest.py.

◆ universe

lsst.obs.base.ingest.RawIngestTask.universe

Definition at line 211 of file ingest.py.


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