LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
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:
lsst.pipe.tasks.match_tract_catalog_probabilistic.MatchTractCatalogProbabilisticConfig

Public Member Functions

Set[str] columns_in_ref (self)
 
Set[str] columns_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)

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
290 return set(columns_all)
291
daf::base::PropertySet * set
Definition fits.cc:931

◆ 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)
306 return set(columns_all)
307

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=[],
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 321 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 331 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 326 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 336 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 347 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 343 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 356 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 351 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 361 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 365 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 371 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 377 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 389 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 383 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 395 of file matcher_probabilistic.py.


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