lsst.pipe.tasks  19.0.0-12-g296864c0
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 lsst.pipe.tasks.ingestCuratedCalibs.IngestCuratedCalibsTask

Public Member Functions

def run (self, args)
 
def parseAndRun (cls)
 
def prepareTask (cls, root=None, dryrun=False, mode="move", create=False, ignoreIngested=False)
 
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...
 
def ingestFiles (self, fileList)
 

Static Public Attributes

 ConfigClass
 
 ArgumentParser
 

Detailed Description

Task that generates registry for calibration images

Definition at line 212 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 546 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 474 of file ingest.py.

◆ ingestFiles()

def lsst.pipe.tasks.ingest.IngestTask.ingestFiles (   self,
  fileList 
)
inherited
Ingest specified file or list of files and add them to the registry.

This method can only be called if `prepareTask` was used.

Parameters
----------
fileList : `str` or `list` [`str`]
    Pathname or list of pathnames of files to ingest.

Definition at line 617 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 521 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 534 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 424 of file ingest.py.

◆ prepareTask()

def lsst.pipe.tasks.ingest.IngestTask.prepareTask (   cls,
  root = None,
  dryrun = False,
  mode = "move",
  create = False,
  ignoreIngested = False 
)
inherited
Prepare for running the task repeatedly with `ingestFiles`.

Saves the parsed arguments, including the Butler and log, as a
private instance variable.

Parameters
----------
root : `str`, optional
    Repository root pathname.  If None, run the Task using the
    command line arguments, ignoring all other arguments below.
dryrun : `bool`, optional
    If True, don't perform any action; log what would have happened.
mode : `str`, optional
    How files are delivered to their destination.  Default is "move",
    unlike the command-line default of "link".
create : `bool`, optional
    If True, create a new registry, clobbering any old one present.
ignoreIngested : `bool`, optional
    If True, do not complain if the file is already present in the
    registry (and do nothing else).

Returns
-------
task : `IngestTask`
    If `root` was provided, the IngestTask instance

Definition at line 431 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 218 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 565 of file ingest.py.

Member Data Documentation

◆ ArgumentParser

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

Definition at line 215 of file ingestCalibs.py.

◆ ConfigClass

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

Definition at line 214 of file ingestCalibs.py.


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