MatchProbabilisticConfig

class lsst.meas.astrom.MatchProbabilisticConfig(*args, **kw)

Bases: Config

Configuration for the MatchProbabilistic matcher.

Attributes Summary

column_ref_order	Name of column in reference catalog specifying order for matching Derived from columns_ref_flux if not set.
columns_in_ref
columns_in_target
columns_ref_copy	Reference table columns to copy unchanged into both match tables (List, default [])
columns_ref_flux	List of reference flux columns to nansum total magnitudes from if column_order is None (List, default [])
columns_ref_meas	The reference table columns to compute match likelihoods from (usually centroids and fluxes/magnitudes) (List)
columns_ref_select_false	Reference table columns to require to be False for selecting sources (List, default ())
columns_ref_select_true	Reference table columns to require to be True for selecting sources (List, default ())
columns_target_copy	Target table columns to copy unchanged into both match tables (List, default [])
columns_target_err	Target table columns with standard errors (sigma) corresponding to columns_ref_meas (List)
columns_target_meas	Target table columns with measurements corresponding to columns_ref_meas (List)
columns_target_select_false	Target table columns to require to be False for selecting sources (List, default ('merge_peak_sky',))
columns_target_select_true	Target table columns to require to be True for selecting sources (List, default ('detect_isPrimary',))
coord_format	Configuration for coordinate conversion (ConvertCatalogCoordinatesConfig, default <class 'lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig'>)
mag_brightest_ref	Bright magnitude cutoff for selecting reference sources to match.
mag_faintest_ref	Faint magnitude cutoff for selecting reference sources to match.
match_dist_max	Maximum match distance.
match_n_finite_min	Minimum number of columns with a finite value to measure match likelihood (int, default 2)
match_n_max	Maximum number of spatial matches to consider (in ascending distance order).
order_ascending	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.

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

column_ref_order

Name of column in reference catalog specifying order for matching Derived from columns_ref_flux if not set. (str, default None)

columns_in_ref

columns_in_target

columns_ref_copy

Reference table columns to copy unchanged into both match tables (List, default [])

columns_ref_flux

List of reference flux columns to nansum total magnitudes from if column_order is None (List, default [])

columns_ref_meas

The reference table columns to compute match likelihoods from (usually centroids and fluxes/magnitudes) (List)

columns_ref_select_false

Reference table columns to require to be False for selecting sources (List, default ())

columns_ref_select_true

Reference table columns to require to be True for selecting sources (List, default ())

columns_target_copy

Target table columns to copy unchanged into both match tables (List, default [])

columns_target_err

Target table columns with standard errors (sigma) corresponding to columns_ref_meas (List)

columns_target_meas

Target table columns with measurements corresponding to columns_ref_meas (List)

columns_target_select_false

Target table columns to require to be False for selecting sources (List, default ('merge_peak_sky',))

columns_target_select_true

Target table columns to require to be True for selecting sources (List, default ('detect_isPrimary',))

coord_format

Configuration for coordinate conversion (ConvertCatalogCoordinatesConfig, default <class 'lsst.meas.astrom.matcher_probabilistic.ConvertCatalogCoordinatesConfig'>)

mag_brightest_ref

Bright magnitude cutoff for selecting reference sources to match. Ignored if column_ref_order is None. (float, default -inf)

mag_faintest_ref

Faint magnitude cutoff for selecting reference sources to match. Ignored if column_ref_order is None. (float, default inf)

match_dist_max

Maximum match distance. Units must be arcseconds if coords_spherical, or else match those of column_*_coord[12] multiplied by coords_*_factor. (float, default 0.5)

match_n_finite_min

Minimum number of columns with a finite value to measure match likelihood (int, default 2)

match_n_max

Maximum number of spatial matches to consider (in ascending distance order). (int, default 10)

order_ascending

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. (bool, default False)

Methods Documentation

validate()

Validate the Config, raising an exception if invalid.

Raises

lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.