DonutSourceSelectorTaskConfig

class lsst.ts.wep.task.DonutSourceSelectorTaskConfig(*args, **kw)

Bases: Config

Attributes Summary

history
isolatedMagDiff	Min.
magMax	Maximum magnitude for selection.
magMin	Minimum magnitude for selection.
maxBlended	Number of blended objects (defined by unblendedSeparation and isolatedMagDiff) allowed with a bright source.
maxFieldDist	Maximum distance from center of focal plane (in degrees).
minBlendedSeparation	Minimum separation in pixels between blended donut centers.
sourceLimit	Maximum number of desired sources (default is -1 which will give all in catalog).
unblendedSeparation	Distance in pixels between two donut centers for them to be considered unblended.
useCustomMagLimit	Apply user-defined magnitude limit? If this is False then the code will default to use the magnitude values in policy:magLimitStar.yaml.
xCoordField	Name of x-coordinate column.
yCoordField	Name of y-coordinate column.

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

Read-only history.

isolatedMagDiff

Min. difference in magnitude for ‘isolated’ star. (float, default 2)

magMax

Maximum magnitude for selection. Only used if useCustomMagLimit is True. (float, default 99.0)

magMin

Minimum magnitude for selection. Only used if useCustomMagLimit is True. (float, default -99.0)

maxBlended

Number of blended objects (defined by unblendedSeparation and isolatedMagDiff) allowed with a bright source. (int, default 0)

maxFieldDist

Maximum distance from center of focal plane (in degrees). (float, default 1.808)

minBlendedSeparation

Minimum separation in pixels between blended donut centers. This setting and unblendedSeparation will both be affected by the defocal distance. (int, default 120)

sourceLimit

Maximum number of desired sources (default is -1 which will give all in catalog). (int, default -1)

unblendedSeparation

Distance in pixels between two donut centers for them to be considered unblended. This setting and minBlendedSeparation will both be affected by the defocal distance. (int, default 160)

useCustomMagLimit

Apply user-defined magnitude limit? If this is False then the code will default to use the magnitude values in policy:magLimitStar.yaml. (bool, default False)

xCoordField

Name of x-coordinate column. (str, default 'centroid_x')

yCoordField

Name of y-coordinate column. (str, default 'centroid_y')

Methods Documentation

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

Compare this configuration to another Config for equality.

Parameters

otherlsst.pex.config.Config

Other Config object to compare against this config.

shortcutbool, optional

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

rtolfloat, optional

Relative tolerance for floating point comparisons.

atolfloat, optional

Absolute tolerance for floating point comparisons.

outputcallable, optional

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

Returns

isEqualbool

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

namestr

Name of a Field in this config.

**kwargs

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

Returns

historystr

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

itemsItemsView

Iterator of tuples for each configuration. Tuple items are:

0. Field name.

1. Field value.

keys()

Get field names.

Returns

namesKeysView

List of lsst.pex.config.Field names.

load(filename, root='config')

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

Parameters

filenamestr

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

rootstr, 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.

See Also

lsst.pex.config.Config.loadFromStream lsst.pex.config.Config.loadFromString lsst.pex.config.Config.save lsst.pex.config.Config.saveToStream lsst.pex.config.Config.saveToString

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

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

Parameters

streamfile-like object, str, bytes, or CodeType

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

rootstr, 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.

filenamestr, optional

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

extraLocalsdict of str to object, optional

Any extra variables to include in local scope when loading.

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.

See Also

lsst.pex.config.Config.load lsst.pex.config.Config.loadFromString lsst.pex.config.Config.save lsst.pex.config.Config.saveToStream lsst.pex.config.Config.saveToString

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

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

Parameters

codestr, bytes, or CodeType

Stream containing configuration override code.

rootstr, 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.

filenamestr, optional

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

extraLocalsdict of str to object, optional

Any extra variables to include in local scope when loading.

Raises

ValueError

Raised if a key in extraLocals is the same value as the value of the root argument.

See Also

lsst.pex.config.Config.load lsst.pex.config.Config.loadFromStream lsst.pex.config.Config.save lsst.pex.config.Config.saveToStream lsst.pex.config.Config.saveToString

names()

Get all the field names in the config, recursively.

Returns

nameslist of str

Field names.

save(filename, root='config')

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

Parameters

filenamestr

Desination filename of this configuration.

rootstr, 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.saveToString lsst.pex.config.Config.load lsst.pex.config.Config.loadFromStream lsst.pex.config.Config.loadFromString

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

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

Parameters

outfilefile-like object

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

rootstr, optional

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

skipImportsbool, 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.saveToString lsst.pex.config.Config.load lsst.pex.config.Config.loadFromStream lsst.pex.config.Config.loadFromString

saveToString(skipImports=False)

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

Parameters

skipImportsbool, 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

codestr

A code string readable by loadFromString.

See Also

lsst.pex.config.Config.save lsst.pex.config.Config.saveToStream lsst.pex.config.Config.load lsst.pex.config.Config.loadFromStream lsst.pex.config.Config.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.

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

valuesValuesView

Iterator of field values.