MatchPessimisticBConfig

class lsst.meas.astrom.MatchPessimisticBConfig

Bases: lsst.pex.config.Config

Configuration for MatchPessimisticBTask

Attributes Summary

history
matcherIterations Number of softening iterations in matcher.
maxOffsetPix Maximum allowed shift of WCS, due to matching (pixel).
maxRefObjects Maximum number of reference objects to use for the matcher.
maxRotationDeg Rotation angle allowed between sources and position reference objects (degrees).
minFracMatchedPairs Minimum number of matched pairs as a fraction of the smaller of the number of reference stars or the number of good sources; the actual minimum is the smaller of this value or minMatchedPairs.
minMatchDistPixels Distance in units of pixels to always consider a source-reference pair a match.
minMatchedPairs Minimum number of matched pairs; see also minFracMatchedPairs.
numBrightStars Number of bright stars to use.
numPatternConsensus Number of implied shift/rotations from patterns that must agree before it a given shift/rotation is accepted.
numPointsForShape Number of points to define a shape for matching.
numPointsForShapeAttempt Number of points to try for creating a shape.
numRefRequireConsensus If the available reference objects exceeds this number, consensus/pessimistic mode will enforced regardless of the number of available sources.

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.
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.
loadFromString(code[, root, filename]) Modify this Config in place by executing the Python code in the provided string.
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.
saveToString([skipImports]) Return the Python script form of this configuration as an executable string.
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

history
matcherIterations

Number of softening iterations in matcher. (int, default 5)

Valid Range = [1,inf)

maxOffsetPix

Maximum allowed shift of WCS, due to matching (pixel). When changing this value, the LoadReferenceObjectsConfig.pixelMargin should also be updated. (int, default 250)

Valid Range = [-inf,4000)

maxRefObjects

Maximum number of reference objects to use for the matcher. The absolute maximum allowed for is 2 ** 16 for memory reasons. (int, default 65536)

Valid Range = [0,65537)

maxRotationDeg

Rotation angle allowed between sources and position reference objects (degrees). (float, default 1.0)

Valid Range = [-inf,6.0)

minFracMatchedPairs

Minimum number of matched pairs as a fraction of the smaller of the number of reference stars or the number of good sources; the actual minimum is the smaller of this value or minMatchedPairs. (float, default 0.3)

Valid Range = [0,1)

minMatchDistPixels

Distance in units of pixels to always consider a source-reference pair a match. This prevents the astrometric fitter from over-fitting and removing stars that should be matched and allows for inclusion of new matches as the wcs improves. (float, default 1.0)

Valid Range = [0.0,6.0)

minMatchedPairs

Minimum number of matched pairs; see also minFracMatchedPairs. (int, default 30)

Valid Range = [2,inf)

numBrightStars

Number of bright stars to use. Sets the max number of patterns that can be tested. (int, default 200)

Valid Range = [2,inf)

numPatternConsensus

Number of implied shift/rotations from patterns that must agree before it a given shift/rotation is accepted. This is only used after the first softening iteration fails and if both the number of reference and source objects is greater than numBrightStars. (int, default 3)

numPointsForShape

Number of points to define a shape for matching. (int, default 6)

numPointsForShapeAttempt

Number of points to try for creating a shape. This value should be greater than or equal to numPointsForShape. Besides loosening the signal to noise cut in the ‘matcher’ SourceSelector, increasing this number will solve CCDs where no match was found. (int, default 6)

numRefRequireConsensus

If the available reference objects exceeds this number, consensus/pessimistic mode will enforced regardless of the number of available sources. Below this optimistic mode (exit at first match rather than requiring numPatternConsensus to be matched) can be used. If more sources are required to match, decrease the signal to noise cut in the sourceSelector. (int, default 1000)

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.

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.

freeze()

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

items()

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

Returns:
items : dict_items

Iterator of tuples for each configuration. Tuple items are:

  1. Field name.
  2. Field value.
keys()

Get field names.

Returns:
names : dict_keys

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.

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, bytes, or compiled string

Stream containing configuration override code. If this is a code object, it should be compiled with mode="exec".

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.

filename : str, optional

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

Notes

For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use loadFromString instead for most of these types.

loadFromString(code, root='config', filename=None)

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

Parameters:
code : str, bytes, 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.

filename : str, optional

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

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

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.

saveToString(skipImports=False)

Return the Python script form of this configuration as an executable string.

Parameters:
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.

Returns:
code : str

A code string readable by loadFromString.

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.

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 : dict_values

Iterator of field values.