ForcedGaapFluxConfig

class lsst.meas.extensions.gaap.ForcedGaapFluxConfig(*args, **kw)

Bases: BaseGaapFluxConfig, ForcedPluginConfig

Config for ForcedGaapFluxPlugin.

Attributes Summary

doMeasure

whether to run this plugin in single-object mode (bool, default True)

doMeasureN

doOptimalPhotometry

Perform optimal photometry with near maximal SNR using an adaptive elliptical aperture? This requires a shape algorithm to have been run previously.

doPsfPhotometry

Perform PSF photometry after PSF-Gaussianization to validate Gaussianization accuracy? This does not produce consistent color estimates.

gaussianizationMethod

Type of convolution to use for PSF-Gaussianization.

history

registerForApCorr

Register measurements for aperture correction? The aperture correction registration is done when the plugin is instatiated and not during import because the column names are derived from the configuration rather than being static.

scaleByFwhm

Config parameter of the PSF Matching task.

scalingFactors

List of factors with which the seeing should be scaled to obtain the sigma values of the target Gaussian PSF.

sigmas

List of sigmas (in arcseconds) of circular Gaussian apertures to apply on pre-seeing galaxy images.

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.

getAllGaapResultNames([name])

Generate the base names for all of the GAaP fields.

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

doMeasure

whether to run this plugin in single-object mode (bool, default True)

doMeasureN = False
doOptimalPhotometry

Perform optimal photometry with near maximal SNR using an adaptive elliptical aperture? This requires a shape algorithm to have been run previously. (bool, default True)

doPsfPhotometry

Perform PSF photometry after PSF-Gaussianization to validate Gaussianization accuracy? This does not produce consistent color estimates. If setting it to True, it must be done so prior to registering the plugin for aperture correction if registerForApCorr is also True. (bool, default False)

gaussianizationMethod

Type of convolution to use for PSF-Gaussianization.

history

Read-only history.

registerForApCorr

Register measurements for aperture correction? The aperture correction registration is done when the plugin is instatiated and not during import because the column names are derived from the configuration rather than being static. Sometimes you want to turn this off, e.g., when you use aperture corrections derived from somewhere else through a ‘proxy’ mechanism. (bool, default True)

scaleByFwhm

Config parameter of the PSF Matching task. Scale kernelSize, alardGaussians by input Fwhm?

scalingFactors

List of factors with which the seeing should be scaled to obtain the sigma values of the target Gaussian PSF. The factor should not be less than unity to avoid the PSF matching task to go into deconvolution mode and should ideally be slightly greater than unity. The runtime of the plugin scales linearly with the number of elements in the list. (List, default [1.15])

sigmas

List of sigmas (in arcseconds) of circular Gaussian apertures to apply on pre-seeing galaxy images. These should be somewhat larger than the PSF (determined by scalingFactors) to avoid measurement failures. (List, default [0.7, 1.0])

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.

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.

freeze()

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

getAllGaapResultNames(name: Optional[str] = 'ext_gaap_GaapFlux') Generator[str]

Generate the base names for all of the GAaP fields.

For example, if the plugin is configured with scalingFactors = [1.15] and sigmas = [0.7, 1.0] the returned expression would yield (“ext_gaap_GaapFlux_1_15x_0_7”, “ext_gaap_GaapFlux_1_15x_1_0”) when called with name = “ext_gaap_GaapFlux”. It will also generate “ext_gaap_GaapFlux_1_15x_PsfFlux” if doPsfPhotometry is True.

Parameters:
namestr, optional

The exact registered name of the GAaP plugin, typically either “ext_gaap_GaapFlux” or “undeblended_ext_gaap_GaapFlux”. If name is None, then only the middle parts ((“1_15x_0_7”, “1_15x_1_0”), for example) without the leading underscores are returned.

Returns:
baseNamesgenerator

A generator expression yielding all the base names.

items()

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

Returns:
itemsdict_items

Iterator of tuples for each configuration. Tuple items are:

  1. Field name.

  2. Field value.

keys()

Get field names.

Returns:
namesdict_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:
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.

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

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

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

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.

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

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.

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

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

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.

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.

setDefaults() None

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

Iterator of field values.