HighResolutionHipsTask¶

class lsst.pipe.tasks.hips.HighResolutionHipsTask(**kwargs)¶

Bases: PipelineTask

Task for making high resolution HiPS images.

Attributes Summary

canMultiprocess

Methods Summary

`build_quantum_graph`(task_def, registry, ...)	Generate a `QuantumGraph` for running just this task.
`build_quantum_graph_cli`(argv)	A command-line interface entry point to `build_quantum_graph`.
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getFullMetadata`()	Get metadata for all tasks.
`getFullName`()	Get the task name as a hierarchical name including parent task names.
`getName`()	Get the name of the task.
`getResourceConfig`()	Return resource configuration for this task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`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.
`run`(pixels, coadd_exposure_handles)	Run the HighResolutionHipsTask.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Method to do butler IO and or transforms to provide in memory objects for tasks run method
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess: ClassVar[bool] = True¶

Methods Documentation

classmethod build_quantum_graph(task_def, registry, constraint_order, constraint_ranges, where=None, collections=None, metadata=None)¶

Generate a QuantumGraph for running just this task.

This is a temporary workaround for incomplete butler query support for HEALPix dimensions.

Parameters:

task_deflsst.pipe.base.TaskDef: Task definition.
registrylsst.daf.butler.Registry: Client for the butler database. May be read-only.
constraint_orderint: HEALPix order used to contrain which quanta are generated, via constraint_indices. This should be a coarser grid (smaller order) than the order used for the task’s quantum and output data IDs, and ideally something between the spatial scale of a patch or the data repository’s “common skypix” system (usually htm7).
constraint_rangeslsst.sphgeom.RangeSet: RangeSet which describes constraint pixels (HEALPix NEST, with order constraint_order) to constrain generated quanta.
wherestr, optional: A boolean str expression of the form accepted by Registry.queryDatasets to constrain input datasets. This may contain a constraint on tracts, patches, or bands, but not HEALPix indices. Constraints on tracts and patches should usually be unnecessary, however - existing coadds that overlap the given HEALpix indices will be selected without such a constraint, and providing one may reject some that should normally be included.
collectionsstr or Iterable [ str ], optional: Collection or collections to search for input datasets, in order. If not provided, registry.defaults.collections will be searched.
metadatadict [ str, Any ]: Graph metadata. It is required to contain “output_run” key with the name of the output RUN collection.

classmethod build_quantum_graph_cli(argv)¶

A command-line interface entry point to build_quantum_graph. This method provides the implementation for the build-high-resolution-hips-qg script.

Parameters:

argvSequence [ str ]: Command-line arguments (e.g. sys.argv[1:]).

emptyMetadata() → None¶: Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() → TaskMetadata¶

Get metadata for all tasks.

Returns:

metadataTaskMetadata: The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

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:

fullNamestr

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”.

getName() → str¶

Get the name of the task.

Returns:

taskNamestr: Name of the task.

See also

getFullName

getResourceConfig() → ResourceConfig | None¶

Return resource configuration for this task.

Returns:

Object of type ResourceConfig or None if resource
configuration is not defined for this task.

getTaskDict() → Dict[str, ReferenceType[Task]]¶

Get a dictionary of all tasks as a shallow copy.

Returns:

taskDictdict: Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

classmethod makeField(doc: str) → ConfigurableField¶

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:

docstr: Help text for the field.

Returns:

configurableFieldlsst.pex.config.ConfigurableField: A ConfigurableField for this task.

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:

namestr

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”.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

run(pixels, coadd_exposure_handles)¶

Run the HighResolutionHipsTask.

Parameters:

pixelsIterable [ int ]: Iterable of healpix pixels (nest ordering) to warp to.
coadd_exposure_handleslist [lsst.daf.butler.DeferredDatasetHandle]: Handles for the coadd exposures.

Returns:

outputslsst.pipe.base.Struct: hips_exposures is a dict with pixel (key) and hips_exposure (value)

runQuantum(butlerQC, inputRefs, outputRefs)¶

Method to do butler IO and or transforms to provide in memory objects for tasks run method

Parameters:

butlerQCButlerQuantumContext: A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.
inputRefsInputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.
outputRefsOutputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.

timer(name: str, logLevel: int = 10) → Iterator[None]¶

Context manager to log performance data for an arbitrary block of code.

Parameters:

namestr: Name of code being timed; data will be logged using item name: Start and End.
logLevel: A logging level constant.

Navigation

HighResolutionHipsTask¶