HighResolutionHipsTask

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

Bases: lsst.pipe.base.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 = True

Methods Documentation

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

Generate a QuantumGraph for running just this task.

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

Parameters:

task_def : lsst.pipe.base.TaskDef

Task definition.

registry : lsst.daf.butler.Registry

Client for the butler database. May be read-only.

constraint_order : int

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_ranges : lsst.sphgeom.RangeSet

RangeSet which describes constraint pixels (HEALPix NEST, with order constraint_order) to constrain generated quanta.

where : str, 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.

collections : str or Iterable [ str ], optional

Collection or collections to search for input datasets, in order. If not provided, registry.defaults.collections will be searched.

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:

argv : Sequence [ str ]

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

emptyMetadata() → None

Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() → lsst.pipe.base._task_metadata.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.

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

getName() → str

Get the name of the task.

Returns:

taskName : str

Name of the task.

See also

getFullName

getResourceConfig() → Optional[ResourceConfig]

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, weakref.ReferenceType[lsst.pipe.base.task.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.

classmethod makeField(doc: str) → lsst.pex.config.configurableField.ConfigurableField

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

Parameters:

doc : str

Help text for the field.

Returns:

configurableField : lsst.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) → 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”.

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:

pixels : Iterable [ int ]

Iterable of healpix pixels (nest ordering) to warp to.

coadd_exposure_handles : list [lsst.daf.butler.DeferredDatasetHandle]

Handles for the coadd exposures.

Returns:

outputs : lsst.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:

butlerQC : ButlerQuantumContext

A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.

inputRefs : InputQuantizedConnection

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.

outputRefs : OutputQuantizedConnection

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:

name : str

Name of code being timed; data will be logged using item name: Start and End.

logLevel

A logging level constant.

See also

timer.logInfo

Examples

Creating a timer context:

with self.timer("someCodeToTime"):
    pass  # code to time