Inheritance diagram for lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig:
Public Member Functions | |
| Set[str] | columns_in_ref (self) |
| Set[str] | columns_in_target (self) |
Detailed Description
Configuration for the MatchProbabilistic matcher.
Definition at line 264 of file matcher_probabilistic.py.
Member Function Documentation
◆ columns_in_ref()
| Set[str] lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_in_ref | ( | self | ) |
Reimplemented in lsst.pipe.tasks.match_tract_catalog_probabilistic.MatchTractCatalogProbabilisticConfig.
Definition at line 276 of file matcher_probabilistic.py.
276 def columns_in_ref(self) -> Set[str]:
277 columns_all = [
278 self.coord_format.column_ref_coord1,
279 self.coord_format.column_ref_coord2,
280 ]
281 for columns in (
282 self.columns_ref_flux,
283 self.columns_ref_meas,
284 self.columns_ref_select_false,
285 self.columns_ref_select_true,
286 self.columns_ref_copy,
287 ):
288 columns_all.extend(columns)
289
291
◆ columns_in_target()
| Set[str] lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_in_target | ( | self | ) |
Reimplemented in lsst.pipe.tasks.match_tract_catalog_probabilistic.MatchTractCatalogProbabilisticConfig.
Definition at line 293 of file matcher_probabilistic.py.
293 def columns_in_target(self) -> Set[str]:
294 columns_all = [
295 self.coord_format.column_target_coord1,
296 self.coord_format.column_target_coord2,
297 ]
298 for columns in (
299 self.columns_target_meas,
300 self.columns_target_err,
301 self.columns_target_select_false,
302 self.columns_target_select_true,
303 self.columns_target_copy,
304 ):
305 columns_all.extend(columns)
307
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 267 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 308 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 315 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 321 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 331 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 326 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 336 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 347 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 343 of file matcher_probabilistic.py.
◆ columns_target_select_false
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=('merge_peak_sky',),
doc='Target table columns to require to be False for selecting sources',
)
Definition at line 356 of file matcher_probabilistic.py.
◆ columns_target_select_true
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=('detect_isPrimary',),
doc='Target table columns to require to be True for selecting sources',
)
Definition at line 351 of file matcher_probabilistic.py.
◆ coord_format
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=ConvertCatalogCoordinatesConfig,
doc="Configuration for coordinate conversion",
)
Definition at line 361 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 365 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 371 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 377 of file matcher_probabilistic.py.
◆ match_n_finite_min
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
default=3,
optional=True,
doc='Minimum number of columns with a finite value to measure match likelihood',
)
Definition at line 389 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).',
)
Definition at line 383 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 395 of file matcher_probabilistic.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_astrom/gff1a9f87cc+fa3a7a026e/python/lsst/meas/astrom/matcher_probabilistic.py
