FgcmLoadReferenceCatalogTask¶

class lsst.fgcmcal.FgcmLoadReferenceCatalogTask(refObjLoader=None, refCatName=None, **kwargs)¶

Bases: lsst.pipe.base.Task

Load multi-band reference objects from a reference catalog.

Parameters:	refObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader` Reference object loader. refCatName : `str` Name of reference catalog (for color term lookups).

Methods Summary

`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getFgcmReferenceStarsHealpix`(nside, pixel, …)	Get a reference catalog that overlaps a healpix pixel, using multiple filters.
`getFgcmReferenceStarsSkyCircle`(ra, dec, …)	Get a reference catalog that overlaps a circular sky region, using multiple filters.
`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.
`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.
`timer`(name, logLevel)	Context manager to log performance data for an arbitrary block of code.

Methods Documentation

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

getFgcmReferenceStarsHealpix(nside, pixel, filterList, nest=False)¶

Get a reference catalog that overlaps a healpix pixel, using multiple filters. In addition, apply colorterms if available.

Return format is a numpy recarray for use with fgcm, with the format:

dtype = ([(‘ra’, np.float64),: (‘dec’, np.float64), (‘refMag’, np.float32, len(filterList)), (‘refMagErr’, np.float32, len(filterList)])

Reference magnitudes (AB) will be 99 for non-detections.

Parameters:	nside: `int` Healpix nside of pixel to load pixel: `int` Healpix pixel of pixel to load filterList: `list` list of `str` of camera filter names. nest: `bool`, optional Is the pixel in nest format? Default is False.
Returns:	fgcmRefCat: `np.recarray`

getFgcmReferenceStarsSkyCircle(ra, dec, radius, filterList)¶

Get a reference catalog that overlaps a circular sky region, using multiple filters. In addition, apply colorterms if available.

Return format is a numpy recarray for use with fgcm.

dtype = ([(‘ra’, np.float64),: (‘dec’, np.float64), (‘refMag’, np.float32, len(filterList)), (‘refMagErr’, np.float32, len(filterList)])

Reference magnitudes (AB) will be 99 for non-detections.

Parameters:	ra: `float` ICRS right ascension, degrees. dec: `float` ICRS declination, degrees. radius: `float` Radius to search, degrees. filterList: `list` list of `str` of camera filter names.
Returns:	fgcmRefCat: `np.recarray`

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

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.

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.

Navigation

FgcmLoadReferenceCatalogTask¶