ModelExtendednessColumnAction¶

class lsst.pipe.tasks.postprocess.ModelExtendednessColumnAction(*args, **kw)¶

Bases: ExtendednessColumnActionBase

Attributes Summary

`bands`	The bands to make single-band outputs for.
`bands_combined`	Multiband classification column specialization.
`fluxerr_coefficent`	The coefficient to multiply the flux error by when adding to the model flux.
`fluxerr_stretch`	The factor to multiply flux error-scaled ratios by to derive extendedness.
`good_sn_min`	Minimum PSF S/N to include objects if min_n_good_to_shift_flux_ratio is > 0; ignored otherwise.
`history`
`identity`	If a configurable action is assigned to a `ConfigurableActionField`, or a `ConfigurableActionStructField` the name of the field will be bound to this variable when it is retrieved.
`max_reff_compact`	The maximum effective radius in pixels below which an object is classified as not extended, regardless of other parameter values.
`min_n_good_to_shift_flux_ratio`	Minimum number of objects with PSF S/N > good_sn_min and with size larger than max_reff_compact to use to compute the median PSF-to-model flux ratio, which is assumed to be 1 otherwise.
`model_column_flux`	The model flux column to use for computing the difference to to the S/N flux.
`model_column_flux_err`	The model flux error column to use for computing the difference to the S/N flux.
`model_flux_name`	The extended object model to use to compared to PSF model fluxes (`str`, default `'sersic'`)
`output_column`	Name of the output column.
`psf_column_flux`	The name of the PSF flux column.
`psf_column_flux_err`	The name of the PSF flux error column.
`size_column`	The column to use for applying size cuts.

Methods Summary

`__call__`(table)	This method must return a dict of computed columns.
`compare`(other[, shortcut, rtol, atol, output])	Compare this configuration to another `Config` for equality.
`copy`()	Return a deep copy of this config.
`formatHistory`(name, **kwargs)	Format a configuration field's history to a human-readable format.
`freeze`()	Make this config, and all subconfigs, read-only.
`getInputSchema`()	Return the required inputs for this action.
`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

bands¶: The bands to make single-band outputs for. (List, default ['u', 'g', 'r', 'i', 'z', 'y'])

bands_combined¶: Multiband classification column specialization. Keys specify the name of the column and values are a comma-separated list of bands, all of which must be contained in the bands listed. (Dict, default {'griz': 'g,r,i,z'})

fluxerr_coefficent¶: The coefficient to multiply the flux error by when adding to the model flux. (float, default 0.5)

fluxerr_stretch¶: The factor to multiply flux error-scaled ratios by to derive extendedness. (float, default 5.0)

good_sn_min¶: Minimum PSF S/N to include objects if min_n_good_to_shift_flux_ratio is > 0; ignored otherwise. (float, default 10.0)

history¶: Read-only history.

identity: str | None = None¶: If a configurable action is assigned to a ConfigurableActionField, or a ConfigurableActionStructField the name of the field will be bound to this variable when it is retrieved.

max_reff_compact¶: The maximum effective radius in pixels below which an object is classified as not extended, regardless of other parameter values. (float, default 0.25)

min_n_good_to_shift_flux_ratio¶: Minimum number of objects with PSF S/N > good_sn_min and with size larger than max_reff_compact to use to compute the median PSF-to-model flux ratio, which is assumed to be 1 otherwise. If this value is not >0, the median flux ratio will be kept 1. (int, default 0)

model_column_flux¶: The model flux column to use for computing the difference to to the S/N flux. Must contain the {band} and {model} templates. (str, default '{band}_{model}Flux')

model_column_flux_err¶: The model flux error column to use for computing the difference to the S/N flux. Must contain the {band} and {model} templates. (str, default '{band}_{model}FluxErr')

model_flux_name¶: The extended object model to use to compared to PSF model fluxes (str, default 'sersic')

output_column¶: Name of the output column. Must contain the {band} template (str, default '{band}_model_extendedness')

psf_column_flux¶: The name of the PSF flux column. Must contain the {band} template. (str, default '{band}_psfFlux')

psf_column_flux_err¶: The name of the PSF flux error column. Must contain the {band} template. (str, default '{band}_psfFluxErr')

size_column¶: The column to use for applying size cuts. Must contain the {axis} template. (str, default 'exponential_reff_{axis}')

Methods Documentation

__call__(table: Table) → dict[str, numpy.ndarray[tuple[Any, ...], numpy.dtype[_ScalarT]]]¶: This method must return a dict of computed columns.

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.

copy() → ConfigurableAction¶

Return a deep copy of this config.

Notes

The returned config object is not frozen, even if the original was. If a nested config object is copied, it retains the name from its original hierarchy.

Nested objects are only shared between the new and old configs if they are not possible to modify via the config’s interfaces (e.g. entries in the the history list are not copied, but the lists themselves are, so modifications to one copy do not modify the other).

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.

getInputSchema() → Iterable[tuple[str, type[numpy.ndarray[tuple[Any, ...], numpy.dtype[_ScalarT]]]]]¶

Return the required inputs for this action.

This function is meant to be compatible with

items()¶

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

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.

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.

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:

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.

Navigation

ModelExtendednessColumnAction¶