lsst.pipe.tasks  20.0.0-21-g7fb4cbd3+74c724a5d3
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.ingestCalibs.CalibsParseTask Class Reference
Inheritance diagram for lsst.pipe.tasks.ingestCalibs.CalibsParseTask:
lsst.pipe.tasks.ingest.ParseTask

Public Member Functions

def getCalibType (self, filename)
 
def getDestination (self, butler, info, filename)
 
def getInfo (self, filename)
 
def getInfoFromMetadata (self, md, info=None)
 
def translate_date (self, md)
 
def translate_filter (self, md)
 

Static Public Member Functions

def getExtensionName (md)
 

Static Public Attributes

 ConfigClass
 

Detailed Description

Task that will parse the filename and/or its contents to get the
required information to populate the calibration registry.

Definition at line 17 of file ingestCalibs.py.

Member Function Documentation

◆ getCalibType()

def lsst.pipe.tasks.ingestCalibs.CalibsParseTask.getCalibType (   self,
  filename 
)
Return a a known calibration dataset type using
the observation type in the header keyword OBSTYPE

@param filename: Input filename

Definition at line 21 of file ingestCalibs.py.

◆ getDestination()

def lsst.pipe.tasks.ingestCalibs.CalibsParseTask.getDestination (   self,
  butler,
  info,
  filename 
)
Get destination for the file

@param butler      Data butler
@param info        File properties, used as dataId for the butler
@param filename    Input filename
@return Destination filename

Reimplemented from lsst.pipe.tasks.ingest.ParseTask.

Definition at line 54 of file ingestCalibs.py.

◆ getExtensionName()

def lsst.pipe.tasks.ingest.ParseTask.getExtensionName (   md)
staticinherited
Get the name of a FITS extension.

Parameters
----------
md : `lsst.daf.base.PropertySet`
    FITS header metadata.

Returns
-------
result : `str` or `None`
    The string from the EXTNAME header card if it exists. None otherwise.

Definition at line 106 of file ingest.py.

◆ getInfo()

def lsst.pipe.tasks.ingest.ParseTask.getInfo (   self,
  filename 
)
inherited
Get information about the image from the filename and its contents

Here, we open the image and parse the header, but one could also look at the filename itself
and derive information from that, or set values from the configuration.

@param filename    Name of file to inspect
@return File properties; list of file properties for each extension

Definition at line 71 of file ingest.py.

◆ getInfoFromMetadata()

def lsst.pipe.tasks.ingest.ParseTask.getInfoFromMetadata (   self,
  md,
  info = None 
)
inherited
Attempt to pull the desired information out of the header

This is done through two mechanisms:
* translation: a property is set directly from the relevant header keyword
* translator: a property is set with the result of calling a method

The translator methods receive the header metadata and should return the
appropriate value, or None if the value cannot be determined.

@param md      FITS header
@param info    File properties, to be supplemented
@return info

Definition at line 125 of file ingest.py.

◆ translate_date()

def lsst.pipe.tasks.ingest.ParseTask.translate_date (   self,
  md 
)
inherited
Convert a full DATE-OBS to a mere date

Besides being an example of a translator, this is also generally useful.
It will only be used if listed as a translator in the configuration.

Definition at line 162 of file ingest.py.

◆ translate_filter()

def lsst.pipe.tasks.ingest.ParseTask.translate_filter (   self,
  md 
)
inherited
Translate a full filter description into a mere filter name

Besides being an example of a translator, this is also generally useful.
It will only be used if listed as a translator in the configuration.

Definition at line 174 of file ingest.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.ingest.ParseTask.ConfigClass
staticinherited

Definition at line 69 of file ingest.py.


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