|
| format_catalogs (self, pd.DataFrame catalog_ref, pd.DataFrame catalog_target, np.array select_ref=None, np.array select_target=None, Callable radec_to_xy_func=None, bool return_converted_columns=False, **kwargs) |
|
Configuration for the MatchProbabilistic matcher.
Definition at line 120 of file matcher_probabilistic.py.
◆ format_catalogs()
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.format_catalogs |
( |
| self, |
|
|
pd.DataFrame | catalog_ref, |
|
|
pd.DataFrame | catalog_target, |
|
|
np.array | select_ref = None, |
|
|
np.array | select_target = None, |
|
|
Callable | radec_to_xy_func = None, |
|
|
bool | return_converted_columns = False, |
|
|
** | kwargs ) |
Format matched catalogs that may require coordinate conversions.
Parameters
----------
catalog_ref : `pandas.DataFrame`
A reference catalog for comparison to `catalog_target`.
catalog_target : `pandas.DataFrame`
A target catalog with measurements for comparison to `catalog_ref`.
select_ref : `numpy.ndarray`, (Nref,)
A boolean array of len `catalog_ref`, True for valid match candidates.
select_target : `numpy.ndarray`, (Ntarget,)
A boolean array of len `catalog_target`, True for valid match candidates.
radec_to_xy_func : `typing.Callable`
Function taking equal-length ra, dec arrays and returning an ndarray of
- ``x``: current parameter (`float`).
- ``extra_args``: additional arguments (`dict`).
return_converted_columns : `bool`
Whether to return converted columns in the `coord1` and `coord2`
attributes, rather than keep the original values.
kwargs
Returns
-------
compcat_ref, compcat_target : `ComparableCatalog`
Comparable catalogs corresponding to the input reference and target.
Definition at line 181 of file matcher_probabilistic.py.
◆ column_ref_coord1
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.column_ref_coord1 |
|
static |
Initial value:= pexConfig.Field(
dtype=str,
default='ra',
doc='The reference table column for the first spatial coordinate (usually x or ra).',
)
Definition at line 123 of file matcher_probabilistic.py.
◆ column_ref_coord2
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.column_ref_coord2 |
|
static |
Initial value:= pexConfig.Field(
dtype=str,
default='dec',
doc='The reference table column for the second spatial coordinate (usually y or dec).'
'Units must match column_ref_coord1.',
)
Definition at line 128 of file matcher_probabilistic.py.
◆ column_target_coord1
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.column_target_coord1 |
|
static |
Initial value:= pexConfig.Field(
dtype=str,
default='coord_ra',
doc='The target table column for the first spatial coordinate (usually x or ra).'
'Units must match column_ref_coord1.',
)
Definition at line 134 of file matcher_probabilistic.py.
◆ column_target_coord2
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.column_target_coord2 |
|
static |
Initial value:= pexConfig.Field(
dtype=str,
default='coord_dec',
doc='The target table column for the second spatial coordinate (usually y or dec).'
'Units must match column_ref_coord2.',
)
Definition at line 140 of file matcher_probabilistic.py.
◆ coords_ref_factor
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.coords_ref_factor |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
default=1.0,
doc='Multiplicative factor for reference catalog coordinates.'
'If coords_spherical is true, this must be the number of degrees per unit increment of '
'column_ref_coord[12]. Otherwise, it must convert the coordinate to the same units'
' as the target coordinates.',
)
Definition at line 151 of file matcher_probabilistic.py.
◆ coords_ref_to_convert
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.coords_ref_to_convert |
|
static |
Initial value:= pexConfig.DictField(
default=None,
optional=True,
keytype=str,
itemtype=str,
dictCheck=lambda x: len(x) == 2,
doc='Dict mapping sky coordinate columns to be converted to pixel columns',
)
Definition at line 167 of file matcher_probabilistic.py.
◆ coords_spherical
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.coords_spherical |
|
static |
Initial value:= pexConfig.Field(
dtype=bool,
default=True,
doc='Whether column_*_coord[12] are spherical coordinates (ra/dec) or not (pixel x/y)',
)
Definition at line 146 of file matcher_probabilistic.py.
◆ coords_target_factor
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.coords_target_factor |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
default=1.0,
doc='Multiplicative factor for target catalog coordinates.'
'If coords_spherical is true, this must be the number of degrees per unit increment of '
'column_target_coord[12]. Otherwise, it must convert the coordinate to the same units'
' as the reference coordinates.',
)
Definition at line 159 of file matcher_probabilistic.py.
◆ mag_zeropoint_ref
lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.mag_zeropoint_ref |
|
static |
Initial value:= pexConfig.Field(
dtype=float,
default=31.4,
doc='Magnitude zeropoint for reference catalog.',
)
Definition at line 175 of file matcher_probabilistic.py.
The documentation for this class was generated from the following file: