MatchProbabilisticTask

class lsst.meas.astrom.MatchProbabilisticTask(**kwargs)

Bases: Task

Run MatchProbabilistic on a reference and target catalog covering the same tract.

Attributes Summary

columns_in_ref
columns_in_target

Methods Summary

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.

Attributes Documentation

columns_in_ref

columns_in_target

Methods Documentation

match(catalog_ref: Table, catalog_target: Table, select_ref: array = None, select_target: array = None, wcs: SkyWcs = None, logger: Logger = None, logging_n_rows: int = None) → Tuple[Table, Table, Dict[int, str]]

Match sources in a reference tract catalog with a target catalog.

Parameters

catalog_refastropy.table.Table

A reference catalog to match objects/sources from.

catalog_targetastropy.table.Table

A target catalog to match reference objects/sources to.

select_refnumpy.array

A boolean array of the same length as catalog_ref selecting the sources that can be matched.

select_targetnumpy.array

A boolean array of the same length as catalog_target selecting the sources that can be matched.

wcslsst.afw.image.SkyWcs

A coordinate system to convert catalog positions to sky coordinates. Only used if self.config.coords_ref_to_convert is set.

loggerlogging.Logger

A Logger for logging.

logging_n_rowsint

Number of matches to make before outputting incremental log message.

Returns

catalog_out_refastropy.table.Table

Reference matched catalog with indices of target matches.

catalog_out_targetastropy.table.Table

Reference matched catalog with indices of target matches.

run(catalog_ref: Table, catalog_target: Table, wcs: SkyWcs = None, **kwargs) → Struct

Match sources in a reference tract catalog with a target catalog.

Parameters

catalog_refastropy.table.Table

A reference catalog to match objects/sources from.

catalog_targetastropy.table.Table

A target catalog to match reference objects/sources to.

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

kwargs : Additional keyword arguments to pass to match.

Returns

retStructlsst.pipe.base.Struct

A struct with output_ref and output_target attribute containing the output matched catalogs, as well as a dict