lsst.pipe.tasks  18.1.0-21-gb3d55290+15
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.ingest.IngestTask Class Reference
Inheritance diagram for lsst.pipe.tasks.ingest.IngestTask:
lsst.pipe.tasks.ingestCalibs.IngestCalibsTask lsst.pipe.tasks.ingestPgsql.PgsqlIngestTask lsst.pipe.tasks.ingestDefects.IngestDefectsTask

Public Member Functions

def __init__ (self, args, kwargs)
 
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...
 
def run (self, args)
 

Static Public Attributes

 ConfigClass
 
 ArgumentParser
 

Detailed Description

Task that will ingest images into the data repository

Definition at line 407 of file ingest.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.ingest.IngestTask.__init__ (   self,
  args,
  kwargs 
)

Definition at line 413 of file ingest.py.

Member Function Documentation

◆ expandFiles()

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

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 499 of file ingest.py.

◆ ingest()

def lsst.pipe.tasks.ingest.IngestTask.ingest (   self,
  infile,
  outfile,
  mode = "move",
  dryrun = False 
)
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 427 of file ingest.py.

◆ isBadFile()

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

We match against the list of bad file patterns.

Definition at line 474 of file ingest.py.

◆ isBadId()

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

We match against the list of bad data identifiers.

Definition at line 487 of file ingest.py.

◆ parseAndRun()

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

Definition at line 419 of file ingest.py.

◆ run()

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

Definition at line 547 of file ingest.py.

◆ runFile()

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

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 518 of file ingest.py.

Member Data Documentation

◆ ArgumentParser

lsst.pipe.tasks.ingest.IngestTask.ArgumentParser
static

Definition at line 410 of file ingest.py.

◆ ConfigClass

lsst.pipe.tasks.ingest.IngestTask.ConfigClass
static

Definition at line 409 of file ingest.py.


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