EllipticalComponentConfig¶

class lsst.multiprofit.EllipticalComponentConfig(*args, **kw)¶

Bases: ShapePriorConfig

Configuration for an elliptically-symmetric component.

This class can be initialized but cannot implement make_component.

Attributes Summary

`flux`	Flux parameter(s) config (`FluxParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.FluxParameterConfig'>`)
`fluxfrac`	Fractional flux parameter(s) config (`FluxFractionParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.FluxFractionParameterConfig'>`)
`history`
`prior_axrat_mean`	Prior mean for axis ratio (prior ignored if not >0) (`float`, default `0.7`)
`prior_axrat_stddev`	Prior std.
`prior_size_mean`	Prior mean for size_major (`float`, default `1`)
`prior_size_stddev`	Prior std.
`rho`	Rho parameter config (`ParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.ParameterConfig'>`)
`size_x`	x-axis size parameter config (`ParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.ParameterConfig'>`)
`size_y`	y-axis size parameter config (`ParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.ParameterConfig'>`)
`transform_flux_name`	The name of the reference transform for flux parameters (`str`, default `'log10'`)
`transform_fluxfrac_name`	The name of the reference transform for flux fraction parameters (`str`, default `'logit_fluxfrac'`)
`transform_rho_name`	The name of the reference transform for rho parameters (`str`, default `'logit_rho'`)
`transform_size_name`	The name of the reference transform for size parameters (`str`, default `'log10'`)

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.
`format_label`(label, name_channel)	Format a label for a band-dependent parameter.
`freeze`()	Make this config, and all subconfigs, read-only.
`get_integral_label_default`()	Return the default integral label.
`get_size_label`()	Return the label for the component's size parameters.
`get_transform_flux`()
`get_transform_fluxfrac`()
`get_transform_rho`()
`get_transform_size`()
`get_type_name`()	Return a descriptive component name.
`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.
`make_component`(centroid, integral_model)	Make a Component reflecting the current configuration.
`make_flux_parameter`(value[, label])	Make a single IntegralParameterD from this object's configuration.
`make_fluxfrac_parameter`(value[, label])
`make_gaussianparametricellipse`()	Make a GaussianParametericEllipse from this object's configuration.
`make_linear_integral_model`(fluxes[, ...])	Make an lsst.gauss2d.fit.LinearIntegralModel for this component.
`make_shape_prior`(ellipse)	Make a prior on ellipse (shape) parameters.
`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.
`set_rho`(component, rho)	Set the rho parameter value for a component.
`set_size_x`(component, size_x)	Set the x-axis size parameter value for a component.
`set_size_y`(component, size_y)	Set the y-axis size parameter value for a component.
`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

flux¶: Flux parameter(s) config (FluxParameterConfig, default <class 'lsst.multiprofit.componentconfig.FluxParameterConfig'>)

fluxfrac¶: Fractional flux parameter(s) config (FluxFractionParameterConfig, default <class 'lsst.multiprofit.componentconfig.FluxFractionParameterConfig'>)

history¶: Read-only history.

prior_axrat_mean¶: Prior mean for axis ratio (prior ignored if not >0) (float, default 0.7)

prior_axrat_stddev¶: Prior std. dev. on axis ratio (float, default 0)

prior_size_mean¶: Prior mean for size_major (float, default 1)

prior_size_stddev¶: Prior std. dev. on size_major (prior ignored if not >0) (float, default 0)

rho¶: Rho parameter config (ParameterConfig, default <class 'lsst.multiprofit.componentconfig.ParameterConfig'>)

size_x¶: x-axis size parameter config (ParameterConfig, default <class 'lsst.multiprofit.componentconfig.ParameterConfig'>)

size_y¶: y-axis size parameter config (ParameterConfig, default <class 'lsst.multiprofit.componentconfig.ParameterConfig'>)

transform_flux_name¶: The name of the reference transform for flux parameters (str, default 'log10')

transform_fluxfrac_name¶: The name of the reference transform for flux fraction parameters (str, default 'logit_fluxfrac')

transform_rho_name¶: The name of the reference transform for rho parameters (str, default 'logit_rho')

transform_size_name¶: The name of the reference transform for size parameters (str, default 'log10')

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.

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.

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

format_label(label: str, name_channel: str) → str¶

Format a label for a band-dependent parameter.

Parameters:

label: The label to format.
name_channel: The name of the channel to format with.

Returns:

label_formmated: The formatted label.

freeze()¶: Make this config, and all subconfigs, read-only.

static get_integral_label_default() → str¶: Return the default integral label.

abstract get_size_label() → str¶: Return the label for the component’s size parameters.

get_transform_flux() → TransformD | None¶

get_transform_fluxfrac() → TransformD | None¶

get_transform_rho() → TransformD | None¶

get_transform_size() → TransformD | None¶

abstract get_type_name() → str¶: Return a descriptive component name.

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

abstract make_component(centroid: CentroidParameters, integral_model: IntegralModel) → ComponentData¶

Make a Component reflecting the current configuration.

Parameters:

centroid: Centroid parameters for the component.
integral_model: The integral_model for this component.

Returns:

component_data: An appropriate ComponentData including the initialized component.

Notes

The default gauss2d.fit.LinearIntegralModel can be populated with unit fluxes (gauss2d.fit.IntegralParameterD instances) to prepare for linear least squares fitting.

make_flux_parameter(value: float | None, label: str | None = None, **kwargs: Any) → IntegralParameterD¶

Make a single IntegralParameterD from this object’s configuration.

Parameters:

value

The initial value. Default is self.flux.value_initial.

label

The label for the parameter. Default empty string.

**kwargs

Other keyword arguments to pass to the IntegralParameterD: constructor.

Returns:

param: The constructed IntegralParameterD.

make_fluxfrac_parameter(value: float | None, label: str | None = None, **kwargs: Any) → ProperFractionParameterD¶

make_gaussianparametricellipse() → GaussianParametricEllipse¶

Make a GaussianParametericEllipse from this object’s configuration.

Returns:

ellipse: The configured ellipse.

make_linear_integral_model(fluxes: dict[lsst.gauss2d.fit._gauss2d_fit.Channel, float], label_integral: str | None = None, **kwargs: Any) → IntegralModel¶

Make an lsst.gauss2d.fit.LinearIntegralModel for this component.

Parameters:

fluxes: Configurations, including initial values, for the flux parameters by channel.
label_integral: A label to apply to integral parameters. Can reference the relevant channel with e.g. {channel.name}.
**kwargs: Additional keyword arguments to pass to make_flux_parameter. Some parameters cannot be overriden from their configs.

Returns:

integral_model: The requested lsst.gauss2d.fit.IntegralModel.

make_shape_prior(ellipse: ParametricEllipse) → ShapePrior | None¶

Make a prior on ellipse (shape) parameters.

Parameters:

ellipse: The ellipse to make a prior for.

Returns:

prior: The prior, or None if no positive stddev configured.

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.

static set_rho(component: EllipticalComponent, rho: float) → None¶

Set the rho parameter value for a component.

Parameters:

component: The component to set the size for.
rho: The value to set.

static set_size_x(component: EllipticalComponent, size_x: float) → None¶

Set the x-axis size parameter value for a component.

Parameters:

component: The component to set the size for.
size_x: The value to set.

static set_size_y(component: EllipticalComponent, size_y: float) → None¶

Set the y-axis size parameter value for a component.

Parameters:

component: The component to set the size for.
size_y: The value to set.

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

EllipticalComponentConfig¶