EstimateZernikesTieConfig¶
- class lsst.ts.wep.task.EstimateZernikesTieConfig(*args, **kw)¶
Bases:
EstimateZernikesBaseConfig
TIE-specific configuration parameters for Zernike estimation.
Attributes Summary
Whether to use a binary template when centering the image.
Maximum absolute change in any Zernike coefficient (in meters) for which the images will be recentered.
Gain used to update Zernikes for image compensation.
Max Noll index to compensate during each iteration of TIE.
The maximum absolute change in any Zernike amplitude (in meters) between subsequent TIE iterations below which convergence is declared.
Path to a instrument configuration file to override the instrument configuration.
Dictionary of mask keyword arguments to pass to mask creation.
Maximum number of iterations for the TIE loop.
The maximum Zernike Noll index estimated.
The optical model to use for mapping between the image and pupilplanes.
If True, the returned Zernike coefficients start with Noll index 4.
If True, returns wavefront deviation.
Whether to save the algorithm history in the task metadata.
Whether to start Zernike estimation from the intrinsic Zernikes.
Units in which the Zernike coefficients are returned.
Whether to estimate Zernike coefficients from pairs of donut stamps.
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.
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
- centerBinary¶
Whether to use a binary template when centering the image. (the default is True) (
bool
, defaultTrue
)
- centerTol¶
Maximum absolute change in any Zernike coefficient (in meters) for which the images will be recentered. If 0, the images are recentered on every iteration. (the default is 1e-9) (
float
, default1e-09
)
- compGain¶
Gain used to update Zernikes for image compensation. (the default is 0.6) (
float
, default0.6
)
- compSequence¶
Max Noll index to compensate during each iteration of TIE. Once the end of the sequence is reached, all Zernike coefficients are used during compensation. (the default is [4, 4, 6, 6, 13, 13, 13, 13, 22, 22, 22, 22]) (
List
, default[4, 4, 6, 6, 13, 13, 13, 13, 22, 22, 22, 22]
)
- convergeTol¶
The maximum absolute change in any Zernike amplitude (in meters) between subsequent TIE iterations below which convergence is declared. (the default is 1e-9) (
float
, default1e-09
)
- history¶
Read-only history.
- 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
, defaultNone
)
- maskKwargs¶
Dictionary of mask keyword arguments to pass to mask creation. To see possibilities, see docstring for lsst.ts.wep.imageMapper.ImageMapper.createPupilMasks(). (the default is an emtpy dictionary) (
Dict
, default{}
)
- opticalModel¶
The optical model to use for mapping between the image and pupilplanes. Can be ‘offAxis’, ‘onAxis’, or ‘paraxial’. offAxis is anumerical model that is valid for all optical systems, but requiresan accurate Batoid model. onAxis is an analytic model that is validfor all optical systems near the optical axis. paraxial is ananalytic model that is valid for slow optical systems near theoptical axis. offAxis is recommended when you have a Batoid modeland onAxis is recommended when you do not. paraxial is primarilymeant for testing (the default is ‘offAxis’) (
str
, default'offAxis'
)Allowed values:
'offAxis'
Numerical model fit by Batoid telescope model.
'onAxis'
Analytic model only suitable for small field angles.
'paraxial'
Analytic model only suitable for slow optical systems.
'None'
Field is optional
- return4Up¶
If True, the returned Zernike coefficients start with Noll index 4. If False, they follow the Galsim convention of starting with index 0 (which is meaningless), so the array index of the output corresponds to the Noll index. In this case, indices 0-3 are always set to zero, because they are not estimated by our pipeline. (
bool
, defaultTrue
)
- returnWfDev¶
If True, returns wavefront deviation. If False, returns full OPD. (
bool
, defaultFalse
)
- saveHistory¶
Whether to save the algorithm history in the task metadata. Depending on the algorithm, saving the history might slow down estimation, but doing so will provide intermediate products from the estimation process. (
bool
, defaultFalse
)
- startWithIntrinsic¶
Whether to start Zernike estimation from the intrinsic Zernikes. (
bool
, defaultTrue
)
- units¶
Units in which the Zernike coefficients are returned. (
str
, default'um'
)Allowed values:
'm'
meters
'um'
microns
'nm'
nanometers
'arcsec'
quadrature contribution to the PSF FWHM in arcseconds
'None'
Field is optional
- usePairs¶
Whether to estimate Zernike coefficients from pairs of donut stamps. If False, Zernikes are estimated from individual donuts. Note the TIE algorithm requires pairs of donuts. (
bool
, defaultTrue
)
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 isTrue
.- rtol
float
, optional Relative tolerance for floating point comparisons.
- atol
float
, optional Absolute tolerance for floating point comparisons.
- outputcallable, optional
A callable that takes a string, used (possibly repeatedly) to report inequalities.
- other
- Returns:
See also
lsst.pex.config.compareConfigs
Notes
Unselected targets of
RegistryField
fields and unselected choices ofConfigChoiceField
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
.
- name
- Returns:
- history
str
A string containing the formatted history.
- 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
ItemsView
Iterator of tuples for each configuration. Tuple items are:
Field name.
Field value.
- items
- 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 to5
.
- filename
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
, orCodeType
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 to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.- extraLocals
dict
ofstr
toobject
, optional Any extra variables to include in local scope when loading.
- streamfile-like object,
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
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, extraLocals=None)¶
Modify this Config in place by executing the Python code in the provided string.
- Parameters:
- code
str
,bytes
, orCodeType
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 to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.- extraLocals
dict
ofstr
toobject
, optional Any extra variables to include in local scope when loading.
- code
- 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
- save(filename, root='config')¶
Save a Python script to the named file, which, when loaded, reproduces this config.
- Parameters:
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.
- 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
).- skipImports
bool
, optional If
True
then do not includeimport
statements in output, this is to support human-oriented output frompipetask
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:
- Returns:
- code
str
A code string readable by
loadFromString
.
- code
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 theField
instances’s defaults should do so here. To correctly use inherited defaults, implementations ofsetDefaults
must call their base class’ssetDefaults
.
- toDict()¶
Make a dictionary of field names and their values.
- Returns:
- dict_
dict
Dictionary with keys that are
Field
names. Values areField
values.
- dict_
See also
lsst.pex.config.Field.toDict
Notes
This method uses the
toDict
method of individual fields. Subclasses ofField
may need to implement atoDict
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 aConfig
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
andfieldC
:>>> 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
andConfigChoiceField
) are defined inlsst.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
ValuesView
Iterator of field values.
- values