|
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, pos) |
| Examine and ingest a single file. More...
|
|
def | ingestFiles (self, fileList) |
|
Task that generates registry for human curated calibration products
in a standardized text file format
Definition at line 30 of file ingestCuratedCalibs.py.
◆ expandFiles()
def lsst.pipe.tasks.ingest.IngestTask.expandFiles |
( |
|
self, |
|
|
|
fileNameList |
|
) |
| |
|
inherited |
Expand a set of filenames and globs, returning a list of filenames.
- Parameters
-
fileNameList | A list of files and glob patterns |
N.b. globs obey Posix semantics, so a pattern that matches nothing is returned unchanged
Definition at line 531 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 452 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 606 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 506 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 519 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 402 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 408 of file ingest.py.
◆ run()
def lsst.pipe.tasks.ingestCuratedCalibs.IngestCuratedCalibsTask.run |
( |
|
self, |
|
|
|
args |
|
) |
| |
◆ runFile()
def lsst.pipe.tasks.ingest.IngestTask.runFile |
( |
|
self, |
|
|
|
infile, |
|
|
|
registry, |
|
|
|
args, |
|
|
|
pos |
|
) |
| |
|
inherited |
Examine and ingest a single file.
- Parameters
-
infile | File to process |
registry | Registry into which to insert Butler metadata, or None |
args | Parsed command-line arguments |
pos | Position number of this file in the input list |
- Returns
- parsed information from FITS HDUs if registry is None; or None
Definition at line 550 of file ingest.py.
◆ ArgumentParser
lsst.pipe.tasks.ingestCuratedCalibs.IngestCuratedCalibsTask.ArgumentParser |
|
static |
◆ ConfigClass
lsst.pipe.tasks.ingestCuratedCalibs.IngestCuratedCalibsTask.ConfigClass |
|
static |
The documentation for this class was generated from the following file: