MultiProFitSourceConfig¶

class lsst.meas.extensions.multiprofit.fit_coadd_multiband.MultiProFitSourceConfig(*args, **kw)¶

Bases: CatalogSourceFitterConfig, CoaddMultibandFitSubConfig

Configuration for the MultiProFit profile fitter.

Attributes Summary

`action_initializer`	The action to return an initializer (`MakeInitializerActionBase`, default `<class 'lsst.meas.extensions.multiprofit.fit_coadd_multiband.MakeCachedBasicInitializerAction'>`)
`action_psf`	The action to return PSF component values from catalogs, if implemented (`PsfComponentsActionBase`, default `<class 'lsst.meas.extensions.multiprofit.fit_coadd_multiband.PsfComponentsActionBase'>`)
`bands_fit`	list of bandpass filters to fit (`List`, default `[]`)
`centroid_pixel_offset`	Number to add to MultiProFit centroids (bottom-left corner is 0,0) to convert to catalog coordinates (e.g.
`column_id`	Catalog index column key (`str`, default `'id'`)
`columns_copy`	Mapping of input/output column names to copy from the inputmultiband catalog to the output fit catalog.
`compute_errors`	Whether/how to compute sqrt(variances) of each free parameter (`str`, default `'INV_HESSIAN_BESTFIT'`)
`compute_errors_from_jacobian`	Whether to estimate the Hessian from the Jacobian first, with finite differencing as a backup (`bool`, default `True`)
`compute_errors_no_covar`	Whether to compute parameter errors independently, ignoring covariances (`bool`, default `True`)
`config_fit`	Fitter configuration (`ModelFitConfig`, default `<class 'lsst.multiprofit.modeller.ModelFitConfig'>`)
`config_model`	Source model configuration (`ModelConfig`, default `<class 'lsst.multiprofit.modelconfig.ModelConfig'>`)
`convert_cen_xy_to_radec`	Convert cen x/y params to RA/dec (`bool`, default `True`)
`fit_centroid`	Fit centroid parameters (`bool`, default `True`)
`fit_linear_final`	Fit linear parameters after optimization (`bool`, default `True`)
`fit_linear_init`	Fit linear parameters after initialization (`bool`, default `True`)
`flag_errors`	Flag column names to set, keyed by name of exception to catch (`Dict`, default `{}`)
`float_fill_value`	Fill value for float fields when creating the output table.
`history`
`integer_fill_value`	Fill value for integer fields when creating the output table.
`mask_names_zero`	Mask bits to mask out (`List`, default `['BAD', 'EDGE', 'SAT', 'NO_DATA']`)
`naming_scheme`	Naming scheme for column names (`str`, default `'default'`)
`prefix_column`	Column name prefix (`str`, default `'mpf_'`)
`prior_cen_x_stddev`	Prior std.
`prior_cen_y_stddev`	Prior std.
`psf_sigma_subtract`	PSF x/y sigma value to subtract in quadrature from best-fit values (`float`, default `0.1`)
`size_priors`	Per-component magnitude-dependent size prior configurations.
`suffix_error`	Default suffix for error columns.
`unit_flux`	Flux unit (`str`, default `None`)

Methods Summary

`bands_read_only`()	Return the set of bands that the Task needs to read (e.g.
`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.
`get_key_cen`()	Get the key for centroid columns.
`get_key_flux`(band[, label])	Get the key for a flux column.
`get_key_reff`()	Get the key for Sersic effective radius columns.
`get_key_rho`()	Get the key for ellipse rho columns.
`get_key_sersicindex`()	Get the key for Sersic index columns.
`get_key_sigma`()	Get the key for Gaussian sigma columns.
`get_key_size`(label_size)	Get the key for a size column by its label.
`get_prefixed_label`(label, prefix)	Get a prefixed label with redundant underscores removed.
`get_suffix_dec`()	Get the suffix for declination columns.
`get_suffix_ra`()	Get the suffix for right ascension columns.
`get_suffix_x`()	Get the suffix for x-axis columns.
`get_suffix_y`()	Get the suffix for y-axis columns.
`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_catalog`(n_rows, **kwargs)	Make a catalog with default-initialized column values.
`make_model_data`(idx_row, catexps)	Make data and psf_models for a catalog row.
`make_sources`(channels[, source_fluxes])	Make initialized sources given channels using `self.config_model`.
`names`()	Get all the field names in the config, recursively.
`requires_psf`()	Return whether the PSF action is not None.
`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.
`schema`([bands])	Return the schema as an ordered list of columns.
`schema_configurable`()
`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

action_initializer¶: The action to return an initializer (MakeInitializerActionBase, default <class 'lsst.meas.extensions.multiprofit.fit_coadd_multiband.MakeCachedBasicInitializerAction'>)

action_psf¶: The action to return PSF component values from catalogs, if implemented (PsfComponentsActionBase, default <class 'lsst.meas.extensions.multiprofit.fit_coadd_multiband.PsfComponentsActionBase'>)

bands_fit¶: list of bandpass filters to fit (List, default [])

centroid_pixel_offset¶: Number to add to MultiProFit centroids (bottom-left corner is 0,0) to convert to catalog coordinates (e.g. set to -0.5 if the bottom-left corner is -0.5, -0.5) (float, default 0)

column_id¶: Catalog index column key (str, default 'id')

columns_copy¶: Mapping of input/output column names to copy from the inputmultiband catalog to the output fit catalog. (Dict, default {})

compute_errors¶

Whether/how to compute sqrt(variances) of each free parameter (str, default 'INV_HESSIAN_BESTFIT')

Allowed values:

'NONE': no errors computed
'INV_HESSIAN': inverse hessian using noisy image as data
'INV_HESSIAN_BESTFIT': inverse hessian using best-fit model as data
'None': Field is optional

compute_errors_from_jacobian¶: Whether to estimate the Hessian from the Jacobian first, with finite differencing as a backup (bool, default True)

compute_errors_no_covar¶: Whether to compute parameter errors independently, ignoring covariances (bool, default True)

config_fit¶: Fitter configuration (ModelFitConfig, default <class 'lsst.multiprofit.modeller.ModelFitConfig'>)

config_model¶: Source model configuration (ModelConfig, default <class 'lsst.multiprofit.modelconfig.ModelConfig'>)

convert_cen_xy_to_radec¶: Convert cen x/y params to RA/dec (bool, default True)

fit_centroid¶: Fit centroid parameters (bool, default True)

fit_linear_final¶: Fit linear parameters after optimization (bool, default True)

fit_linear_init¶: Fit linear parameters after initialization (bool, default True)

flag_errors¶: Flag column names to set, keyed by name of exception to catch (Dict, default {})

float_fill_value¶: Fill value for float fields when creating the output table. (float, default nan)

history¶: Read-only history.

integer_fill_value¶: Fill value for integer fields when creating the output table. (int, default -1)

mask_names_zero¶: Mask bits to mask out (List, default ['BAD', 'EDGE', 'SAT', 'NO_DATA'])

naming_scheme¶

Naming scheme for column names (str, default 'default')

Allowed values:

'default': snake_case with {component_name}[_{band}]_{parameter}[_err]
'camel': CamelCase with {component_name}[_{band}]_{parameter}[Err]
'lsst': snake_case with [{band}_]{component_name}_{parameter}[Err]
'None': Field is optional

prefix_column¶: Column name prefix (str, default 'mpf_')

prior_cen_x_stddev¶: Prior std. dev. on x centroid (ignored if not >0) (float, default 0)

prior_cen_y_stddev¶: Prior std. dev. on y centroid (ignored if not >0) (float, default 0)

psf_sigma_subtract¶: PSF x/y sigma value to subtract in quadrature from best-fit values (float, default 0.1)

size_priors¶: Per-component magnitude-dependent size prior configurations. Will be added to component with existing configs. (ConfigDict, default {})

suffix_error¶: Default suffix for error columns. Can be overridden by naming_scheme. (str, default '_err')

unit_flux¶: Flux unit (str, default None)

Methods Documentation

bands_read_only() → set[str]¶

Return the set of bands that the Task needs to read (e.g. for defining priors) but not necessarily fit.

Returns:

The set of such bands.

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

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

get_key_cen() → str¶: Get the key for centroid columns.

get_key_flux(band: str, label: str = '') → str¶

Get the key for a flux column.

Parameters:

band: The band of the flux column.
label: A label for this flux, e.g. a component name.

Returns:

key_flux: The flux column key.

get_key_reff() → str¶: Get the key for Sersic effective radius columns.

get_key_rho() → str¶: Get the key for ellipse rho columns.

get_key_sersicindex() → str¶: Get the key for Sersic index columns.

get_key_sigma() → str¶: Get the key for Gaussian sigma columns.

get_key_size(label_size: str) → str¶

Get the key for a size column by its label.

Parameters:

label_size: The label of the size, usually specified in a ComponentConfig.

Returns:

key_size: The size column key.

get_prefixed_label(label: str, prefix: str) → str¶

Get a prefixed label with redundant underscores removed.

Parameters:

label: The label to format.
prefix: The prefix to prepend.

Returns:

label_prefixed: The prefixed label, with redundant underscores removed.

get_suffix_dec() → str¶: Get the suffix for declination columns.

get_suffix_ra() → str¶: Get the suffix for right ascension columns.

get_suffix_x() → str¶: Get the suffix for x-axis columns.

get_suffix_y() → str¶: Get the suffix for y-axis columns.

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

make_catalog(n_rows: int, **kwargs)¶

Make a catalog with default-initialized column values.

Parameters:

n_rows: The number of rows to create.
**kwargs: Keyword arguments to pass to self.schema.

Returns:

catalog: The initialized catalog.
columns: The columns as returned by self.schema.

make_model_data(idx_row: int, catexps: list[lsst.multiprofit.fitting.fit_source.CatalogExposureSourcesABC]) → tuple[lsst.gauss2d.fit._gauss2d_fit.DataD, list[lsst.gauss2d.fit._gauss2d_fit.PsfModel]]¶

Make data and psf_models for a catalog row.

Parameters:

idx_row: The index of the row in each catalog.
catexps: Catalog-exposure pairs to initialize observations from.

Returns:

data: The resulting data object.
psf_models: A list of psf_models, one per catexp.

Notes

Only observations with good data and valid PSF models will be returned; bad data will be excluded from the return values.

make_sources(channels: Iterable[Channel], source_fluxes: list[list[list[dict[lsst.gauss2d.fit._gauss2d_fit.Channel, float]]]] | None = None) → tuple[list[lsst.gauss2d.fit._gauss2d_fit.Source], list[lsst.gauss2d.fit._gauss2d_fit.Prior]]¶

Make initialized sources given channels using self.config_model.

Parameters:

channels: The channels to initialize fluxes for.
source_fluxes: A list of fluxes by channel for each component group in each source. The default is to initialize using ComponentGroupConfig.get_fluxes_default.

Returns:

sources: The list of initialized sources.
priors: The list of priors.

names()¶

Get all the field names in the config, recursively.

Returns:

nameslist of str: Field names.

requires_psf()¶: Return whether the PSF action is not None.

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

schema(bands: list[str] | None = None) → list[lsst.multiprofit.fitting.fit_catalog.ColumnInfo]¶

Return the schema as an ordered list of columns.

Parameters:

bands: A list of band names to prefix band-dependent columns with. Band prefixes should not be used if None.

Returns:

schema: An ordered list of ColumnInfo instances.

schema_configurable() → list[lsst.multiprofit.fitting.fit_catalog.ColumnInfo]¶

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

MultiProFitSourceConfig¶