lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig Class Reference
Inheritance diagram for lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig:
Public Member Functions | |
| set[str] | columns_in_ref (self) |
| dict[str, None] | columns_ordered_in_ref (self) |
| set[str] | columns_in_target (self) |
| dict[str, None] | columns_ordered_in_target (self) |
| validate (self) | |
Public Attributes | |
| columns_ordered_in_ref | |
| columns_ordered_in_target | |
Detailed Description
Configuration for the MatchProbabilistic matcher.
Definition at line 263 of file matcher_probabilistic.py.
Member Function Documentation
◆ columns_in_ref()
| set[str] lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_in_ref | ( | self | ) |
Definition at line 275 of file matcher_probabilistic.py.
◆ columns_in_target()
| set[str] lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_in_target | ( | self | ) |
Definition at line 298 of file matcher_probabilistic.py.
◆ columns_ordered_in_ref()
| dict[str, None] lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_ordered_in_ref | ( | self | ) |
Definition at line 279 of file matcher_probabilistic.py.
◆ columns_ordered_in_target()
| dict[str, None] lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_ordered_in_target | ( | self | ) |
Definition at line 302 of file matcher_probabilistic.py.
◆ validate()
| lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.validate | ( | self | ) |
Definition at line 414 of file matcher_probabilistic.py.
Member Data Documentation
◆ column_ref_order
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
default=None,
optional=True,
doc='Name of column in reference catalog specifying order for matching'
' Derived from columns_ref_flux if not set.',
)
Definition at line 266 of file matcher_probabilistic.py.
◆ columns_ordered_in_ref
| lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_ordered_in_ref |
Definition at line 276 of file matcher_probabilistic.py.
◆ columns_ordered_in_target
| lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_ordered_in_target |
Definition at line 299 of file matcher_probabilistic.py.
◆ columns_ref_copy
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
listCheck=lambda x: len(set(x)) == len(x),
optional=True,
doc='Reference table columns to copy unchanged into both match tables',
)
Definition at line 317 of file matcher_probabilistic.py.
◆ columns_ref_flux
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
optional=True,
doc="List of reference flux columns to nansum total magnitudes from if column_order is None",
)
Definition at line 324 of file matcher_probabilistic.py.
◆ columns_ref_meas
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
doc='The reference table columns to compute match likelihoods from '
'(usually centroids and fluxes/magnitudes)',
)
Definition at line 330 of file matcher_probabilistic.py.
◆ columns_ref_select_false
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=tuple(),
doc='Reference table columns to require to be False for selecting sources',
)
Definition at line 340 of file matcher_probabilistic.py.
◆ columns_ref_select_true
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=tuple(),
doc='Reference table columns to require to be True for selecting sources',
)
Definition at line 335 of file matcher_probabilistic.py.
◆ columns_target_copy
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
listCheck=lambda x: len(set(x)) == len(x),
optional=True,
doc='Target table columns to copy unchanged into both match tables',
)
Definition at line 345 of file matcher_probabilistic.py.
◆ columns_target_err
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
doc='Target table columns with standard errors (sigma) corresponding to columns_ref_meas',
)
Definition at line 356 of file matcher_probabilistic.py.
◆ columns_target_meas
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
doc='Target table columns with measurements corresponding to columns_ref_meas',
)
Definition at line 352 of file matcher_probabilistic.py.
◆ columns_target_select_false
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
doc='Target table columns to require to be False for selecting sources',
)
Definition at line 365 of file matcher_probabilistic.py.
◆ columns_target_select_true
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
doc='Target table columns to require to be True for selecting sources',
)
Definition at line 360 of file matcher_probabilistic.py.
◆ coord_format
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=ConvertCatalogCoordinatesConfig,
doc="Configuration for coordinate conversion",
)
Definition at line 370 of file matcher_probabilistic.py.
◆ mag_brightest_ref
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=-np.inf,
doc='Bright magnitude cutoff for selecting reference sources to match.'
' Ignored if column_ref_order is None.'
)
Definition at line 374 of file matcher_probabilistic.py.
◆ mag_faintest_ref
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=np.inf,
doc='Faint magnitude cutoff for selecting reference sources to match.'
' Ignored if column_ref_order is None.'
)
Definition at line 380 of file matcher_probabilistic.py.
◆ match_dist_max
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=0.5,
doc='Maximum match distance. Units must be arcseconds if coords_spherical, '
'or else match those of column_*_coord[12] multiplied by coords_*_factor.',
)
Definition at line 386 of file matcher_probabilistic.py.
◆ match_n_finite_min
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
default=2,
optional=True,
doc='Minimum number of columns with a finite value to measure match likelihood',
check=lambda x: x >= 2,
)
Definition at line 399 of file matcher_probabilistic.py.
◆ match_n_max
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
default=10,
optional=True,
doc='Maximum number of spatial matches to consider (in ascending distance order).',
check=lambda x: x >= 1,
)
Definition at line 392 of file matcher_probabilistic.py.
◆ order_ascending
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
optional=True,
doc='Whether to order reference match candidates in ascending order of column_ref_order '
'(should be False if the column is a flux and True if it is a magnitude.',
)
Definition at line 406 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