CutOutDonutsUnpairedTaskConfig¶

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

Bases: CutOutDonutsBaseTaskConfig

Attributes Summary

`badPixelMaskDefinitions`	List of mask values flagged as 'bad' for Zernike estimation.
`bkgDilationIter`	How many iterations of binary dilation to run on the image mask to calculate the background variance (The default is 3).
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`donutStampSize`	Size of donut stamps in pixels (`int`, default `160`)
`history`
`initialCutoutPadding`	Additional padding in pixels on each side of the initial postage stamp of donutStampSize to make sure we have a stamp of donutStampSize after recentroiding donut.
`instConfigFile`	Path to a instrument configuration file to override the instrument configuration.
`maxRecenterDistance`	Maximum distance (in pixels) to shift donut stamp centroid when performing recentering step with convolution.
`opticalModel`	Specify the optical model (offAxis, onAxis).
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`sourceErosionIter`	How many iterations of binary erosion to run on the image mask to calculate mean donut signal (The default is 1).
`subtractBackground`	Task to perform background subtraction.

Methods Summary

`applyConfigOverrides`(instrument, ...)	Apply config overrides to this config instance.
`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

badPixelMaskDefinitions¶: List of mask values flagged as ‘bad’ for Zernike estimation. (List, default ['SAT', 'BAD', 'NO_DATA', 'INTRP'])

bkgDilationIter¶: How many iterations of binary dilation to run on the image mask to calculate the background variance (The default is 3). (int, default 3)

connections: pexConfig.ConfigField¶: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

donutStampSize¶: Size of donut stamps in pixels (int, default 160)

history¶: Read-only history.

initialCutoutPadding¶: Additional padding in pixels on each side of the initial postage stamp of donutStampSize to make sure we have a stamp of donutStampSize after recentroiding donut. Also used as the padding of the donut template for centroiding. (int, default 5)

instConfigFile¶: Path to a instrument configuration file to override the instrument configuration. If begins with ‘policy:’ the path will be understood as relative to the ts_wep policy directory. If not provided, the default instrument for the camera will be loaded, and the defocal offset will be determined from the focusZ value in the exposure header. (str, default None)

maxRecenterDistance¶: Maximum distance (in pixels) to shift donut stamp centroid when performing recentering step with convolution. (int, default 20)

opticalModel¶: Specify the optical model (offAxis, onAxis). (str, default 'offAxis')

saveLogOutput¶: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

sourceErosionIter¶: How many iterations of binary erosion to run on the image mask to calculate mean donut signal (The default is 1). (int, default 1)

subtractBackground¶: Task to perform background subtraction. (ConfigurableInstance, default <class 'lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig'>)

Methods Documentation

applyConfigOverrides(instrument: lsst.pipe.base._instrument.Instrument | None, taskDefaultName: str, pipelineConfigs: collections.abc.Iterable[lsst.pipe.base.pipelineIR.ConfigIR] | None, parameters: ParametersIR, label: str) → None¶

Apply config overrides to this config instance.

Parameters¶

instrumentInstrument or None: An instance of the Instrument specified in a pipeline. If None then the pipeline did not specify and instrument.
taskDefaultNamestr: The default name associated with the Task class. This may be used with instrumental overrides.
pipelineConfigsIterable of ConfigIR: An iterable of ConfigIR objects that contain overrides to apply to this config instance.
parametersParametersIR: Parameters defined in a Pipeline which are used in formatting of config values across multiple Task in a pipeline.
labelstr: The label associated with this class’s Task in a pipeline.

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.

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.

Returns¶

itemsItemsView

Iterator of tuples for each configuration. Tuple items are:

Field name.
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.

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.

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.

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

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.

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.

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¶

valuesValuesView: Iterator of field values.

CutOutDonutsUnpairedTaskConfig¶

Parameters¶

Parameters¶

Returns¶

See Also¶

Notes¶

Parameters¶

Returns¶

See Also¶

Returns¶

Returns¶

Parameters¶

See Also¶

Parameters¶

Notes¶

See Also¶

Parameters¶

Raises¶

See Also¶

Returns¶

Parameters¶

See Also¶

Parameters¶

See Also¶

Parameters¶

Returns¶

See Also¶

Notes¶

Returns¶

See Also¶

Notes¶

Parameters¶

Notes¶

Examples¶

Raises¶

Notes¶

Returns¶

On this page

Navigation

CutOutDonutsUnpairedTaskConfig¶

Parameters¶

Parameters¶

Returns¶

See Also¶

Notes¶

Parameters¶

Returns¶

See Also¶

Returns¶

Returns¶

Parameters¶

See Also¶

Parameters¶

Notes¶

See Also¶

Parameters¶

Raises¶

See Also¶

Returns¶

Parameters¶

See Also¶

Parameters¶

See Also¶

Parameters¶

Returns¶

See Also¶

Notes¶

Returns¶

See Also¶

Notes¶

Parameters¶

Notes¶

Examples¶

Raises¶

Notes¶

Returns¶