A probabilistic, greedy catalog matcher.
Parameters
----------
config: `MatchProbabilisticConfig`
A configuration instance.
Definition at line 402 of file matcher_probabilistic.py.
◆ __init__()
◆ match()
def lsst.meas.astrom.matcher_probabilistic.MatcherProbabilistic.match |
( |
|
self, |
|
|
pd.DataFrame |
catalog_ref, |
|
|
pd.DataFrame |
catalog_target, |
|
|
np.array |
select_ref = None , |
|
|
np.array |
select_target = None , |
|
|
logging.Logger |
logger = None , |
|
|
int |
logging_n_rows = None , |
|
|
** |
kwargs |
|
) |
| |
Match catalogs.
Parameters
----------
catalog_ref : `pandas.DataFrame`
A reference catalog to match in order of a given column (i.e. greedily).
catalog_target : `pandas.DataFrame`
A target catalog for matching sources from `catalog_ref`. Must contain measurements with errors.
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.
logger : `logging.Logger`
A Logger for logging.
logging_n_rows : `int`
The number of sources to match before printing a log message.
kwargs
Additional keyword arguments to pass to `format_catalogs`.
Returns
-------
catalog_out_ref : `pandas.DataFrame`
A catalog of identical length to `catalog_ref`, containing match information for rows selected by
`select_ref` (including the matching row index in `catalog_target`).
catalog_out_target : `pandas.DataFrame`
A catalog of identical length to `catalog_target`, containing the indices of matching rows in
`catalog_ref`.
exceptions : `dict` [`int`, `Exception`]
A dictionary keyed by `catalog_target` row number of the first exception caught when matching.
Definition at line 418 of file matcher_probabilistic.py.
◆ config
lsst.meas.astrom.matcher_probabilistic.MatcherProbabilistic.config |
The documentation for this class was generated from the following file: