lsst.pipe.tasks  16.0-14-g9428de4d+6
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.ingestCalibs.IngestCalibsTask Class Reference
Inheritance diagram for lsst.pipe.tasks.ingestCalibs.IngestCalibsTask:
lsst.pipe.tasks.ingest.IngestTask

Public Member Functions

def run (self, args)
 
def parseAndRun (cls)
 
def ingest (self, infile, outfile, mode="move", dryrun=False)
 
def isBadFile (self, filename, badFileList)
 
def isBadId (self, info, badIdList)
 
def expandFiles (self, fileNameList)
 Expand a set of filenames and globs, returning a list of filenames. More...
 
def runFile (self, infile, registry, args)
 Examine and ingest a single file. More...
 

Static Public Attributes

 ConfigClass = IngestCalibsConfig
 
 ArgumentParser = IngestCalibsArgumentParser
 

Detailed Description

Task that generates registry for calibration images

Definition at line 207 of file ingestCalibs.py.

Member Function Documentation

◆ expandFiles()

def lsst.pipe.tasks.ingest.IngestTask.expandFiles (   self,
  fileNameList 
)
inherited

Expand a set of filenames and globs, returning a list of filenames.

Parameters
fileNameListA list of files and glob patterns

N.b. globs obey Posix semantics, so a pattern that matches nothing is returned unchanged

Definition at line 469 of file ingest.py.

◆ ingest()

def lsst.pipe.tasks.ingest.IngestTask.ingest (   self,
  infile,
  outfile,
  mode = "move",
  dryrun = False 
)
inherited
Ingest a file into the image repository.

@param infile  Name of input file
@param outfile Name of output file (file in repository)
@param mode    Mode of ingest (copy/link/move/skip)
@param dryrun  Only report what would occur?
@param Success boolean

Definition at line 397 of file ingest.py.

◆ isBadFile()

def lsst.pipe.tasks.ingest.IngestTask.isBadFile (   self,
  filename,
  badFileList 
)
inherited
Return whether the file qualifies as bad

We match against the list of bad file patterns.

Definition at line 444 of file ingest.py.

◆ isBadId()

def lsst.pipe.tasks.ingest.IngestTask.isBadId (   self,
  info,
  badIdList 
)
inherited
Return whether the file information qualifies as bad

We match against the list of bad data identifiers.

Definition at line 457 of file ingest.py.

◆ parseAndRun()

def lsst.pipe.tasks.ingest.IngestTask.parseAndRun (   cls)
inherited
Parse the command-line arguments and run the Task

Definition at line 389 of file ingest.py.

◆ run()

def lsst.pipe.tasks.ingestCalibs.IngestCalibsTask.run (   self,
  args 
)
Ingest all specified files and add them to the registry

Definition at line 213 of file ingestCalibs.py.

◆ runFile()

def lsst.pipe.tasks.ingest.IngestTask.runFile (   self,
  infile,
  registry,
  args 
)
inherited

Examine and ingest a single file.

Parameters
infileFile to process
argsParsed command-line arguments
Returns
parsed information from FITS HDUs or None

Definition at line 488 of file ingest.py.

Member Data Documentation

◆ ArgumentParser

lsst.pipe.tasks.ingestCalibs.IngestCalibsTask.ArgumentParser = IngestCalibsArgumentParser
static

Definition at line 210 of file ingestCalibs.py.

◆ ConfigClass

lsst.pipe.tasks.ingestCalibs.IngestCalibsTask.ConfigClass = IngestCalibsConfig
static

Definition at line 209 of file ingestCalibs.py.


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