|
Set[str] | columns_in_ref (self) |
|
Set[str] | columns_in_target (self) |
|
Tuple[pd.DataFrame, pd.DataFrame, Dict[int, str]] | match (self, pd.DataFrame catalog_ref, pd.DataFrame catalog_target, np.array select_ref=None, np.array select_target=None, afwGeom.SkyWcs wcs=None, logging.Logger logger=None, int logging_n_rows=None) |
|
pipeBase.Struct | run (self, pd.DataFrame catalog_ref, pd.DataFrame catalog_target, afwGeom.SkyWcs wcs=None, **kwargs) |
|
| __init__ (self, **kwargs) |
|
|
np.array | _apply_select_bool (pd.DataFrame catalog, List[str] columns_true, List[str] columns_false, Optional[np.array] selection) |
|
Run MatchProbabilistic on a reference and target catalog covering the same tract.
Definition at line 42 of file match_probabilistic_task.py.
◆ __init__()
lsst.meas.astrom.match_probabilistic_task.MatchProbabilisticTask.__init__ |
( |
|
self, |
|
|
** |
kwargs |
|
) |
| |
◆ _apply_select_bool()
np.array lsst.meas.astrom.match_probabilistic_task.MatchProbabilisticTask._apply_select_bool |
( |
pd.DataFrame |
catalog, |
|
|
List[str] |
columns_true, |
|
|
List[str] |
columns_false, |
|
|
Optional[np.array] |
selection |
|
) |
| |
|
staticprotected |
Apply additional boolean selection columns.
catalog : `pandas.DataFrame`
The catalog to select from.
columns_true : `list` [`str`]
Columns that must be True for selection.
columns_false : `list` [`str`]
Columns that must be False for selection.
selection : `numpy.array`
A prior selection array. Default all true.
Returns
-------
selection : `numpy.array`
The final selection array.
Definition at line 49 of file match_probabilistic_task.py.
◆ columns_in_ref()
Set[str] lsst.meas.astrom.match_probabilistic_task.MatchProbabilisticTask.columns_in_ref |
( |
|
self | ) |
|
◆ columns_in_target()
Set[str] lsst.meas.astrom.match_probabilistic_task.MatchProbabilisticTask.columns_in_target |
( |
|
self | ) |
|
◆ match()
Tuple[pd.DataFrame, pd.DataFrame, Dict[int, str]] lsst.meas.astrom.match_probabilistic_task.MatchProbabilisticTask.match |
( |
|
self, |
|
|
pd.DataFrame |
catalog_ref, |
|
|
pd.DataFrame |
catalog_target, |
|
|
np.array |
select_ref = None , |
|
|
np.array |
select_target = None , |
|
|
afwGeom.SkyWcs |
wcs = None , |
|
|
logging.Logger |
logger = None , |
|
|
int |
logging_n_rows = None |
|
) |
| |
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.
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.
Definition at line 90 of file match_probabilistic_task.py.
◆ run()
pipeBase.Struct lsst.meas.astrom.match_probabilistic_task.MatchProbabilisticTask.run |
( |
|
self, |
|
|
pd.DataFrame |
catalog_ref, |
|
|
pd.DataFrame |
catalog_target, |
|
|
afwGeom.SkyWcs |
wcs = None , |
|
|
** |
kwargs |
|
) |
| |
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.
kwargs : Additional keyword arguments to pass to `match`.
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
Definition at line 176 of file match_probabilistic_task.py.
◆ _DefaultName
str lsst.meas.astrom.match_probabilistic_task.MatchProbabilisticTask._DefaultName = "matchProbabilistic" |
|
staticprotected |
◆ ConfigClass
◆ matcher
lsst.meas.astrom.match_probabilistic_task.MatchProbabilisticTask.matcher |
The documentation for this class was generated from the following file: