lsst.meas.astrom g51277c4d12+189ae2df2e
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig Class Reference
Inheritance diagram for lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig:

Public Member Functions

Set[strcolumns_in_ref (self)
 
Set[strcolumns_in_target (self)
 

Static Public Attributes

 column_ref_order
 
 columns_ref_copy
 
 columns_ref_flux
 
 columns_ref_meas
 
 columns_ref_select_true
 
 columns_ref_select_false
 
 columns_target_copy
 
 columns_target_meas
 
 columns_target_err
 
 columns_target_select_true
 
 columns_target_select_false
 
 coord_format
 
 mag_brightest_ref
 
 mag_faintest_ref
 
 match_dist_max
 
 match_n_max
 
 match_n_finite_min
 
 order_ascending
 

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)

Definition at line 276 of file matcher_probabilistic.py.

◆ columns_in_target()

Set[str] lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_in_target (   self)

Definition at line 293 of file matcher_probabilistic.py.

Member Data Documentation

◆ column_ref_order

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_ref_flux
static
Initial value:
= pexConfig.ListField(
dtype=str,
default=[],
listCheck=lambda x: len(set(x)) == len(x),
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

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 322 of file matcher_probabilistic.py.

◆ columns_ref_select_false

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 332 of file matcher_probabilistic.py.

◆ columns_ref_select_true

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 327 of file matcher_probabilistic.py.

◆ columns_target_copy

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 337 of file matcher_probabilistic.py.

◆ columns_target_err

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 348 of file matcher_probabilistic.py.

◆ columns_target_meas

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.columns_target_meas
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc='Target table columns with measurements corresponding to columns_ref_meas',
)

Definition at line 344 of file matcher_probabilistic.py.

◆ columns_target_select_false

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 357 of file matcher_probabilistic.py.

◆ columns_target_select_true

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 352 of file matcher_probabilistic.py.

◆ coord_format

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.coord_format
static
Initial value:
= pexConfig.ConfigField(
dtype=ConvertCatalogCoordinatesConfig,
doc="Configuration for coordinate conversion",
)

Definition at line 362 of file matcher_probabilistic.py.

◆ mag_brightest_ref

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 366 of file matcher_probabilistic.py.

◆ mag_faintest_ref

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 372 of file matcher_probabilistic.py.

◆ match_dist_max

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 378 of file matcher_probabilistic.py.

◆ match_n_finite_min

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 390 of file matcher_probabilistic.py.

◆ match_n_max

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 384 of file matcher_probabilistic.py.

◆ order_ascending

lsst.meas.astrom.matcher_probabilistic.MatchProbabilisticConfig.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 396 of file matcher_probabilistic.py.


The documentation for this class was generated from the following file: