IsrMockConfig

class lsst.ip.isr.IsrMockConfig

Bases: lsst.pex.config.Config

Configuration parameters for isrMock.

These parameters produce generic fixed position signals from various sources, and combine them in a way that matches how those signals are combined to create real data. The camera used is the test camera defined by the afwUtils code.

Attributes Summary

biasLevel Background contribution to be generated from the bias offset in DN.
darkRate Background level contribution (in e-/s) to be generated from dark current.
darkTime Exposure time for the dark current contribution.
detectorIndex Index for the detector to use.
doAddBias Add bias signal to data.
doAddCrosstalk Apply simulated crosstalk to output image.
doAddDark Add dark signal to data.
doAddFlat Add flat signal to data.
doAddFringe Add fringe signal to data.
doAddOverscan If untrimmed, add overscan ramp to overscan and data regions.
doAddSky Apply ‘sky’ signal to output image.
doAddSource Add simulated source to output image.
doBrighterFatter Return a simulated brighter-fatter kernel.
doCrosstalkCoeffs Return the matrix of crosstalk coefficients.
doDataRef Return a simulated gen2 butler dataRef.
doDefects Return a simulated defect list.
doGenerateAmpDict Return a dict of exposure amplifiers instead of an afwImage.Exposure.
doGenerateData Return a non-image data structure if True.
doGenerateImage Return the generated output image if True.
doTransmissionCurve Return a simulated transmission curve.
expTime Exposure time for simulated data.
flatDrop Fractional flux drop due to flat from center to edge of detector along x-axis.
fringeScale Peak fluxes for the components of the fringe ripple in DN.
fringeX0 Center position for the fringe ripples.
fringeY0 Center position for the fringe ripples.
gain Gain for simulated data in e^-/DN.
history
isLsstLike If True, products have one raw image per amplifier, otherwise, one raw image per detector.
isTrimmed If True, amplifiers have been trimmed and mosaicked to remove regions outside the data BBox.
overscanScale Amplitude (in DN) of the ramp function to add to overscan data.
plateScale Plate scale used in constructing mock camera.
radialDistortion Radial distortion term used in constructing mock camera.
readNoise Read noise of the detector in e-.
rngSeed Seed for random number generator used to add noise.
skyLevel Background contribution to be generated from ‘the sky’ in DN.
sourceAmp Amplifier to place simulated ‘astronomical sources’.
sourceFlux Peak flux level (in DN) of simulated ‘astronomical sources’.
sourceX Peak position (in amplifier coordinates) of simulated ‘astronomical sources’.
sourceY Peak position (in amplifier coordinates) of simulated ‘astronomical 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

biasLevel

Background contribution to be generated from the bias offset in DN. (float, default 8000.0)

darkRate

Background level contribution (in e-/s) to be generated from dark current. (float, default 5.0)

darkTime

Exposure time for the dark current contribution. (float, default 5.0)

detectorIndex

Index for the detector to use. The default value uses a standard 2x4 array of amps. (int, default 20)

doAddBias

Add bias signal to data. (bool, default True)

doAddCrosstalk

Apply simulated crosstalk to output image. This cannot be corrected by ISR, as detector.hasCrosstalk()==False. (bool, default False)

doAddDark

Add dark signal to data. (bool, default True)

doAddFlat

Add flat signal to data. (bool, default True)

doAddFringe

Add fringe signal to data. (bool, default True)

doAddOverscan

If untrimmed, add overscan ramp to overscan and data regions. (bool, default True)

doAddSky

Apply ‘sky’ signal to output image. (bool, default True)

doAddSource

Add simulated source to output image. (bool, default True)

doBrighterFatter

Return a simulated brighter-fatter kernel. (bool, default False)

doCrosstalkCoeffs

Return the matrix of crosstalk coefficients. (bool, default False)

doDataRef

Return a simulated gen2 butler dataRef. (bool, default False)

doDefects

Return a simulated defect list. (bool, default False)

doGenerateAmpDict

Return a dict of exposure amplifiers instead of an afwImage.Exposure. (bool, default False)

doGenerateData

Return a non-image data structure if True. (bool, default False)

doGenerateImage

Return the generated output image if True. (bool, default False)

doTransmissionCurve

Return a simulated transmission curve. (bool, default False)

expTime

Exposure time for simulated data. (float, default 5.0)

flatDrop

Fractional flux drop due to flat from center to edge of detector along x-axis. (float, default 0.1)

fringeScale

Peak fluxes for the components of the fringe ripple in DN. (List, default [200.0])

fringeX0

Center position for the fringe ripples. (List, default [-100])

fringeY0

Center position for the fringe ripples. (List, default [0])

gain

Gain for simulated data in e^-/DN. (float, default 1.0)

history
isLsstLike

If True, products have one raw image per amplifier, otherwise, one raw image per detector. (bool, default False)

isTrimmed

If True, amplifiers have been trimmed and mosaicked to remove regions outside the data BBox. (bool, default True)

overscanScale

Amplitude (in DN) of the ramp function to add to overscan data. (float, default 100.0)

plateScale

Plate scale used in constructing mock camera. (float, default 20.0)

radialDistortion

Radial distortion term used in constructing mock camera. (float, default 0.925)

readNoise

Read noise of the detector in e-. (float, default 5.0)

rngSeed

Seed for random number generator used to add noise. (int, default 20000913)

skyLevel

Background contribution to be generated from ‘the sky’ in DN. (float, default 1000.0)

sourceAmp

Amplifier to place simulated ‘astronomical sources’. (List, default [0])

sourceFlux

Peak flux level (in DN) of simulated ‘astronomical sources’. (List, default [45000.0])

sourceX

Peak position (in amplifier coordinates) of simulated ‘astronomical sources’. (List, default [50.0])

sourceY

Peak position (in amplifier coordinates) of simulated ‘astronomical sources’. (List, default [25.0])

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.