MatchProbabilisticConfig

class lsst.meas.astrom.MatchProbabilisticConfig

Bases: lsst.pex.config.Config

Configuration for the MatchProbabilistic matcher.

Attributes Summary

column_order	Column to sort fit by.
column_ref_coord1	The reference table column for the first spatial coordinate (usually x or ra).
column_ref_coord2	The reference table column for the second spatial coordinate (usually y or dec).Units must match column_ref_coord1.
column_target_coord1	The target table column for the first spatial coordinate (usually x or ra).Units must match column_ref_coord1.
column_target_coord2	The target table column for the second spatial coordinate (usually y or dec).Units must match column_ref_coord2.
columns_in_ref
columns_in_target
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_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 match candidates (List, default ('merge_peak_sky',))
columns_target_select_true	Target table columns to require to be True for selecting match candidates (List, default ('detect_isPrimary',))
coords_ref_factor	Multiplicative factor for reference catalog coordinates.If coords_spherical is true, this must be the number of degrees per unit increment of column_ref_coord[12].
coords_ref_to_convert	Dict mapping sky coordinate columns to be converted to tract pixel columns (Dict)
coords_spherical	Whether column_*_coord[12] are spherical coordinates (ra/dec) or not (pixel x/y) (bool, default True)
coords_target_factor	Multiplicative factor for target catalog coordinates.If coords_spherical is true, this must be the number of degrees per unit increment of column_target_coord[12].
history
mag_brightest_ref	Bright magnitude cutoff for selecting reference sources to match.
mag_faintest_ref	Faint magnitude cutoff for selecting reference sources to match.
mag_zeropoint_ref	Magnitude zeropoint for computing reference source magnitudes for selection.
match_dist_max	Maximum match distance.
match_n_finite_min	Minimum number of columns with a finite value to measure match likelihood (int, default 3)
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_order (should be False if the column is a flux and True if it is a magnitude.

Methods Summary

compare(other[, shortcut, rtol, atol, output])	Compare this configuration to another Config for equality.
formatHistory(name, **kwargs)	Format a configuration field’s history to a human-readable format.
freeze()	Make this config, and all subconfigs, read-only.
items()	Get configurations as (field name, field value) pairs.
iteritems()	Iterate over (field name, field value) pairs.
iterkeys()	Iterate over field names
itervalues()	Iterate over field values.
keys()	Get field names.
load(filename[, root])	Modify this config in place by executing the Python code in a configuration file.
loadFromStream(stream[, root, filename])	Modify this Config in place by executing the Python code in the provided stream.
names()	Get all the field names in the config, recursively.
save(filename[, root])	Save a Python script to the named file, which, when loaded, reproduces this config.
saveToStream(outfile[, root, skipImports])	Save a configuration file to a stream, which, when loaded, reproduces this config.
setDefaults()	Subclass hook for computing defaults.
toDict()	Make a dictionary of field names and their values.
update(**kw)	Update values of fields specified by the keyword arguments.
validate()	Validate the Config, raising an exception if invalid.
values()	Get field values.

Attributes Documentation

column_order

Column to sort fit by. Derived from columns_flux if not set. (str, default None)

column_ref_coord1

The reference table column for the first spatial coordinate (usually x or ra). (str, default 'ra')

column_ref_coord2

The reference table column for the second spatial coordinate (usually y or dec).Units must match column_ref_coord1. (str, default 'dec')

column_target_coord1

The target table column for the first spatial coordinate (usually x or ra).Units must match column_ref_coord1. (str, default 'coord_ra')

column_target_coord2

The target table column for the second spatial coordinate (usually y or dec).Units must match column_ref_coord2. (str, default 'coord_dec')

columns_in_ref

columns_in_target

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_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 match candidates (List, default ('merge_peak_sky',))

columns_target_select_true

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

coords_ref_factor

Multiplicative factor for reference catalog coordinates.If coords_spherical is true, this must be the number of degrees per unit increment of column_ref_coord[12]. Otherwise, it must convert the coordinate to the same units as the target coordinates. (float, default 1.0)

coords_ref_to_convert

Dict mapping sky coordinate columns to be converted to tract pixel columns (Dict)

coords_spherical

Whether column_*_coord[12] are spherical coordinates (ra/dec) or not (pixel x/y) (bool, default True)

coords_target_factor

Multiplicative factor for target catalog coordinates.If coords_spherical is true, this must be the number of degrees per unit increment of column_target_coord[12]. Otherwise, it must convert the coordinate to the same units as the reference coordinates. (float, default 1.0)

history

mag_brightest_ref

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

mag_faintest_ref

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

mag_zeropoint_ref

Magnitude zeropoint for computing reference source magnitudes for selection. Ignored if column_order is None. (float, default 31.4)

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 3)

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_order (should be False if the column is a flux and True if it is a magnitude. (bool, default False)

Methods Documentation

compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)

Compare this configuration to another Config for equality.

Parameters:

other : lsst.pex.config.Config

Other Config object to compare against this config.

shortcut : bool, optional

If True, return as soon as an inequality is found. Default is True.

rtol : float, optional

Relative tolerance for floating point comparisons.

atol : float, optional

Absolute tolerance for floating point comparisons.

output : callable, optional

A callable that takes a string, used (possibly repeatedly) to report inequalities.

Returns:

isEqual : bool

True when the two lsst.pex.config.Config instances are equal. False if there is an inequality.

See also

lsst.pex.config.compareConfigs

Notes

Unselected targets of RegistryField fields and unselected choices of ConfigChoiceField fields are not considered by this method.

Floating point comparisons are performed by numpy.allclose.

formatHistory(name, **kwargs)

Format a configuration field’s history to a human-readable format.

Parameters:

name : str

Name of a Field in this config.

kwargs

Keyword arguments passed to lsst.pex.config.history.format.

Returns:

history : str

A string containing the formatted history.

See also

lsst.pex.config.history.format

freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

Returns:

items : list

List of tuples for each configuration. Tuple items are:

0. Field name.
1. Field value.

See also

lsst.pex.config.Config.iteritems

iteritems()

Iterate over (field name, field value) pairs.

Yields:

item : tuple

Tuple items are:

0. Field name.
1. Field value.

See also

lsst.pex.config.Config.items

iterkeys()

Iterate over field names

Yields:

key : str

A field’s key (attribute name).

See also

lsst.pex.config.Config.values

itervalues()

Iterate over field values.

Yields:

value : obj

A field value.

See also

lsst.pex.config.Config.values

keys()

Get field names.

Returns:

names : list

List of lsst.pex.config.Field names.

See also

lsst.pex.config.Config.iterkeys

load(filename, root='config')

Modify this config in place by executing the Python code in a configuration file.

Parameters:

filename : str

Name of the configuration file. A configuration file is Python module.

root : str, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

Deprecated: For backwards compatibility, older config files that use root="root" instead of root="config" will be loaded with a warning printed to sys.stderr. This feature will be removed at some point.

See also

lsst.pex.config.Config.loadFromStream, lsst.pex.config.Config.save, lsst.pex.config.Config.saveFromStream

loadFromStream(stream, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided stream.

Parameters:

stream : file-like object, str, or compiled string

Stream containing configuration override code.

root : str, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

Deprecated: For backwards compatibility, older config files that use root="root" instead of root="config" will be loaded with a warning printed to sys.stderr. This feature will be removed at some point.

filename : str, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

See also

lsst.pex.config.Config.load, lsst.pex.config.Config.save, lsst.pex.config.Config.saveFromStream

names()

Get all the field names in the config, recursively.

Returns:

names : list of str

Field names.

save(filename, root='config')

Save a Python script to the named file, which, when loaded, reproduces this config.

Parameters:

filename : str

Desination filename of this configuration.

root : str, optional

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

See also

lsst.pex.config.Config.saveToStream, lsst.pex.config.Config.load, lsst.pex.config.Config.loadFromStream

saveToStream(outfile, root='config', skipImports=False)

Save a configuration file to a stream, which, when loaded, reproduces this config.

Parameters:

outfile : file-like object

Destination file object write the config into. Accepts strings not bytes.

root

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

skipImports : bool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

See also

lsst.pex.config.Config.save, lsst.pex.config.Config.load, lsst.pex.config.Config.loadFromStream

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

toDict()

Make a dictionary of field names and their values.

Returns:

dict_ : dict

Dictionary with keys that are Field names. Values are Field values.

See also

lsst.pex.config.Field.toDict

Notes

This method uses the toDict method of individual fields. Subclasses of Field may need to implement a toDict method for this method to work.

update(**kw)

Update values of fields specified by the keyword arguments.

Parameters:

kw

Keywords are configuration field names. Values are configuration field values.

Notes

The __at and __label keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert a Config instance’s history.

Examples

This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc='Field A', dtype=int, default=42)
...     fieldB = Field(doc='Field B', dtype=bool, default=True)
...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
...
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update fieldA and fieldC:

>>> config.update(fieldA=13, fieldC='Updated!')

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 13
fieldB: True
fieldC: 'Updated!'

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.

values()

Get field values.

Returns:

values : list

List of field values.

See also

lsst.pex.config.Config.itervalues