MatchProbabilisticTask¶
- class lsst.meas.astrom.MatchProbabilisticTask(**kwargs)¶
Bases:
Task
Run MatchProbabilistic on a reference and target catalog covering the same tract.
Attributes Summary
Methods Summary
Empty (clear) the metadata for this Task and all sub-Tasks.
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 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.match
(catalog_ref, catalog_target[, ...])Match sources in a reference tract catalog with a target catalog.
run
(catalog_ref, catalog_target[, wcs])Match sources in a reference tract catalog with a target catalog.
timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Attributes Documentation
- columns_in_ref¶
- columns_in_target¶
Methods Documentation
- 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
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
See also
getFullName
Get the full name of the 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.
- taskDict
- 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
.
- match(catalog_ref: DataFrame, catalog_target: DataFrame, select_ref: array = None, select_target: array = None, wcs: SkyWcs = None, logger: Logger = None, logging_n_rows: int = None) Tuple[DataFrame, DataFrame, Dict[int, str]] ¶
Match sources in a reference tract catalog with a target catalog.
- Parameters:
- catalog_ref
pandas.DataFrame
A reference catalog to match objects/sources from.
- catalog_target
pandas.DataFrame
A target catalog to match reference objects/sources to.
- select_ref
numpy.array
A boolean array of the same length as
catalog_ref
selecting the sources that can be matched.- select_target
numpy.array
A boolean array of the same length as
catalog_target
selecting the sources that can be matched.- wcs
lsst.afw.image.SkyWcs
A coordinate system to convert catalog positions to sky coordinates. Only used if
self.config.coords_ref_to_convert
is set.- logger
logging.Logger
A Logger for logging.
- logging_n_rows
int
Number of matches to make before outputting incremental log message.
- catalog_ref
- Returns:
- catalog_out_ref
pandas.DataFrame
Reference matched catalog with indices of target matches.
- catalog_out_target
pandas.DataFrame
Reference matched catalog with indices of target matches.
- catalog_out_ref
- run(catalog_ref: DataFrame, catalog_target: DataFrame, wcs: SkyWcs = None, **kwargs) Struct ¶
Match sources in a reference tract catalog with a target catalog.
- Parameters:
- catalog_ref
pandas.DataFrame
A reference catalog to match objects/sources from.
- catalog_target
pandas.DataFrame
A target catalog to match reference objects/sources to.
- wcs
lsst.afw.image.SkyWcs
A coordinate system to convert catalog positions to sky coordinates. Only needed if
config.coords_ref_to_convert
is used to convert reference catalog sky coordinates to pixel positions.- kwargsAdditional keyword arguments to pass to
match
.
- catalog_ref
- Returns:
- retStruct
lsst.pipe.base.Struct
A struct with output_ref and output_target attribute containing the output matched catalogs, as well as a dict
- retStruct