DecamIngestTask¶
- class lsst.obs.decam.DecamIngestTask(*args, **kwargs)¶
Bases:
IngestTask
Gen2 DECam file ingest task.
Methods Summary
Empty (clear) the metadata for this Task and all sub-Tasks.
expandFiles
(fileNameList)!Expand a set of filenames and globs, returning a list of filenames
Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Get the schemas generated by this task.
Get a dictionary of all tasks as a shallow copy.
ingest
(infile, outfile[, mode, dryrun])Ingest a file into the image repository.
ingestFiles
(fileList)Ingest specified file or list of files and add them to the registry.
isBadFile
(filename, badFileList)Return whether the file qualifies as bad
isBadId
(info, badIdList)Return whether the file information qualifies as bad
makeField
(doc)Make a
lsst.pex.config.ConfigurableField
for this task.makeSubtask
(name, **keyArgs)Create a subtask as a new instance as the
name
attribute of this task.Parse the command-line arguments and run the Task.
prepareTask
([root, dryrun, mode, create, ...])Prepare for running the task repeatedly with
ingestFiles
.run
(args)Ingest all specified files and add them to the registry
runFile
(infile, registry, args, pos)!Examine and ingest a single file
timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Methods Documentation
- expandFiles(fileNameList)¶
!Expand a set of filenames and globs, returning a list of filenames
@param fileNameList A list of files and glob patterns
N.b. globs obey Posix semantics, so a pattern that matches nothing is returned unchanged
- getAllSchemaCatalogs() Dict[str, Any] ¶
Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
- Returns:
- schemacatalogs
dict
Keys are butler dataset type, values are a empty catalog (an instance of the appropriate
lsst.afw.table
Catalog type) for all tasks in the hierarchy, from the top-level task down through all subtasks.
- schemacatalogs
Notes
This method may be called on any task in the hierarchy; it will return the same answer, regardless.
The default implementation should always suffice. If your subtask uses schemas the override
Task.getSchemaCatalogs
, not this method.
- getFullMetadata() TaskMetadata ¶
Get metadata for all tasks.
- Returns:
- metadata
TaskMetadata
The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.
- metadata
Notes
The returned metadata includes timing information (if
@timer.timeMethod
is used) and any metadata set by the task. The name of each item consists of the full task name with.
replaced by:
, followed by.
and the name of the item, e.g.:topLevelTaskName:subtaskName:subsubtaskName.itemName
using
:
in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.
- getFullName() str ¶
Get the task name as a hierarchical name including parent task names.
- Returns:
- fullName
str
The full name consists of the name of the parent task and each subtask separated by periods. For example:
The full name of top-level task “top” is simply “top”.
The full name of subtask “sub” of top-level task “top” is “top.sub”.
The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.
- fullName
- getSchemaCatalogs() Dict[str, Any] ¶
Get the schemas generated by this task.
- Returns:
- schemaCatalogs
dict
Keys are butler dataset type, values are an empty catalog (an instance of the appropriate
lsst.afw.table
Catalog type) for this task.
- schemaCatalogs
See also
Task.getAllSchemaCatalogs
Notes
Warning
Subclasses that use schemas must override this method. The default implementation returns an empty dict.
This method may be called at any time after the Task is constructed, which means that all task schemas should be computed at construction time, not when data is actually processed. This reflects the philosophy that the schema should not depend on the data.
Returning catalogs rather than just schemas allows us to save e.g. slots for SourceCatalog as well.
- getTaskDict() Dict[str, ReferenceType[Task]] ¶
Get a dictionary of all tasks as a shallow copy.
- Returns:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- ingest(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
- ingestFiles(fileList)¶
Ingest specified file or list of files and add them to the registry.
This method can only be called if
prepareTask
was used.
- isBadFile(filename, badFileList)¶
Return whether the file qualifies as bad
We match against the list of bad file patterns.
- isBadId(info, badIdList)¶
Return whether the file information qualifies as bad
We match against the list of bad data identifiers.
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
Examples
Provides a convenient way to specify this task is a subtask of another task.
Here is an example of use:
class OtherTaskConfig(lsst.pex.config.Config): aSubtask = ATaskClass.makeField("brief description of task")
- makeSubtask(name: str, **keyArgs: Any) None ¶
Create a subtask as a new instance as the
name
attribute of this task.- Parameters:
- name
str
Brief name of the subtask.
- keyArgs
Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:
“config”.
“parentTask”.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- classmethod parseAndRun()¶
Parse the command-line arguments and run the Task.
- classmethod prepareTask(root=None, dryrun=False, mode='move', create=False, ignoreIngested=False)¶
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).
- root
- Returns:
- task
IngestTask
If
root
was provided, the IngestTask instance
- task
- run(args)¶
Ingest all specified files and add them to the registry
- runFile(infile, registry, args, pos)¶
!Examine and ingest a single file
@param infile: File to process @param registry: Registry into which to insert Butler metadata, or None @param args: Parsed command-line arguments @param pos: Position number of this file in the input list @return parsed information from FITS HDUs if registry is None; or None