lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig Class Reference
Inheritance diagram for lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig:
Public Member Functions | |
| format_catalogs (self, astropy.table.Table catalog_ref, astropy.table.Table catalog_target, np.array select_ref=None, np.array select_target=None, Callable radec_to_xy_func=None, **kwargs) | |
Detailed Description
Configuration for the MatchProbabilistic matcher.
Definition at line 132 of file matcher_probabilistic.py.
Member Function Documentation
◆ format_catalogs()
| lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig.format_catalogs | ( | self, | |
| astropy.table.Table | catalog_ref, | ||
| astropy.table.Table | catalog_target, | ||
| np.array | select_ref = None, | ||
| np.array | select_target = None, | ||
| Callable | radec_to_xy_func = None, | ||
| ** | kwargs ) |
Format matched catalogs that may require coordinate conversions.
Parameters
----------
catalog_ref : `astropy.table.Table`
A reference catalog for comparison to `catalog_target`.
catalog_target : `astropy.table.Table`
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`).
kwargs
Additional keyword arguments to pass to radec_to_xy_func.
Returns
-------
compcat_ref, compcat_target : `ComparableCatalog`
Comparable catalogs corresponding to the input reference and target.
Definition at line 187 of file matcher_probabilistic.py.
Member Data Documentation
◆ column_ref_coord1
|
static |
Initial value:
= pexConfig.Field[str](
default='ra',
doc='The reference table column for the first spatial coordinate (usually x or ra).',
)
Definition at line 135 of file matcher_probabilistic.py.
◆ column_ref_coord2
|
static |
Initial value:
= pexConfig.Field[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 139 of file matcher_probabilistic.py.
◆ column_target_coord1
|
static |
Initial value:
= pexConfig.Field[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 144 of file matcher_probabilistic.py.
◆ column_target_coord2
|
static |
Initial value:
= pexConfig.Field[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 149 of file matcher_probabilistic.py.
◆ coords_ref_factor
|
static |
Initial value:
= pexConfig.Field[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 158 of file matcher_probabilistic.py.
◆ coords_ref_to_convert
|
static |
Initial value:
= pexConfig.DictField[str, str](
default=None,
optional=True,
dictCheck=lambda x: len(x) == 2,
doc='Dict mapping sky coordinate columns to be converted to pixel columns.',
)
Definition at line 172 of file matcher_probabilistic.py.
◆ coords_spherical
|
static |
Initial value:
= pexConfig.Field[bool](
default=True,
doc='Whether column_*_coord[12] are spherical coordinates (ra/dec) or not (pixel x/y).',
)
Definition at line 154 of file matcher_probabilistic.py.
◆ coords_target_factor
|
static |
Initial value:
= pexConfig.Field[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 165 of file matcher_probabilistic.py.
◆ mag_zeropoint_ref
|
static |
Initial value:
= pexConfig.Field[float](
default=31.4,
doc='Magnitude zeropoint for reference catalog.',
)
Definition at line 178 of file matcher_probabilistic.py.
◆ return_converted_coords
|
static |
Initial value:
= pexConfig.Field[float](
default=True,
doc='Whether to return converted coordinates for matching or only write them.',
)
Definition at line 182 of file matcher_probabilistic.py.
The documentation for this class was generated from the following file:
- python/lsst/meas/astrom/matcher_probabilistic.py
Generated on for lsst.meas.astrom by
1.17.0