MultiProFitSourceConfig¶
- class lsst.meas.extensions.multiprofit.fit_coadd_multiband.MultiProFitSourceConfig(*args, **kw)¶
Bases:
CatalogSourceFitterConfig
,CoaddMultibandFitSubConfig
Configuration for the MultiProFit profile fitter.
Attributes Summary
The action to return PSF component values from catalogs, if implemented (
PsfComponentsActionBase
, default<class 'lsst.meas.extensions.multiprofit.fit_coadd_multiband.PsfComponentsActionBase'>
)list of bandpass filters to fit (
List
, default[]
)Number to add to MultiProFit centroids (bottom-left corner is 0,0) to convert to catalog coordinates (e.g.
Catalog index column key (
str
, default'id'
)Mapping of input/output column names to copy from the inputmultiband catalog to the output fit catalog.
Whether/how to compute sqrt(variances) of each free parameter (
str
, default'INV_HESSIAN_BESTFIT'
)Whether to estimate the Hessian from the Jacobian first, with finite differencing as a backup (
bool
, defaultTrue
)Whether to compute parameter errors independently, ignoring covariances (
bool
, defaultTrue
)Fitter configuration (
ModelFitConfig
, default<class 'lsst.multiprofit.modeller.ModelFitConfig'>
)Source model configuration (
ModelConfig
, default<class 'lsst.multiprofit.modelconfig.ModelConfig'>
)Convert cen x/y params to RA/dec (
bool
, defaultTrue
)Fit centroid parameters (
bool
, defaultTrue
)Fit linear parameters after optimization (
bool
, defaultTrue
)Fit linear parameters after initialization (
bool
, defaultTrue
)Flag column names to set, keyed by name of exception to catch (
Dict
, default{}
)Mask bits to mask out (
List
, default['BAD', 'EDGE', 'SAT', 'NO_DATA']
)Column name prefix (
str
, default'mpf_'
)Prior std.
Prior std.
PSF x/y sigma value to subtract in quadrature from best-fit values (
float
, default0.1
)Flux unit (
str
, defaultNone
)Methods Summary
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.
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_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.
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.
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_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
, default0
)
- columns_copy¶
Mapping of input/output column names to copy from the inputmultiband catalog to the output fit catalog. (
Dict
, default{'base_ClassificationExtendedness_value': 'refExtendedness', 'base_ClassificationExtendedness_flag': 'refExtendedness_flag', 'detect_isPatchInner': 'detect_isPatchInner', 'detect_isPrimary': 'detect_isPrimary'}
)
- 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
, defaultTrue
)
- compute_errors_no_covar¶
Whether to compute parameter errors independently, ignoring covariances (
bool
, defaultTrue
)
- config_fit¶
Fitter configuration (
ModelFitConfig
, default<class 'lsst.multiprofit.modeller.ModelFitConfig'>
)
- config_model¶
Source model configuration (
ModelConfig
, default<class 'lsst.multiprofit.modelconfig.ModelConfig'>
)
- flag_errors¶
Flag column names to set, keyed by name of exception to catch (
Dict
, default{}
)
- history¶
Read-only history.
- mask_names_zero¶
Mask bits to mask out (
List
, default['BAD', 'EDGE', 'SAT', 'NO_DATA']
)
- psf_sigma_subtract¶
PSF x/y sigma value to subtract in quadrature from best-fit values (
float
, default0.1
)
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:
- 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 isTrue
.- rtol
float
, optional Relative tolerance for floating point comparisons.
- atol
float
, optional Absolute tolerance for floating point comparisons.
- outputcallable, optional
A callable that takes a string, used (possibly repeatedly) to report inequalities.
- other
- Returns:
- isEqual
bool
True
when the twolsst.pex.config.Config
instances are equal.False
if there is an inequality.
- isEqual
See also
Notes
Unselected targets of
RegistryField
fields and unselected choices ofConfigChoiceField
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
.
- name
- Returns:
- history
str
A string containing the formatted history.
- history
See also
- freeze()¶
Make this config, and all subconfigs, read-only.
- items()¶
Get configurations as
(field name, field value)
pairs.- Returns:
- items
ItemsView
Iterator of tuples for each configuration. Tuple items are:
Field name.
Field value.
- items
- keys()¶
Get field names.
- Returns:
- names
KeysView
List of
lsst.pex.config.Field
names.
- names
- 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 to5
.
- filename
- 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
, orCodeType
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 to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.- extraLocals
dict
ofstr
toobject
, optional Any extra variables to include in local scope when loading.
- streamfile-like object,
See also
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:
- code
str
,bytes
, orCodeType
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 to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.- extraLocals
dict
ofstr
toobject
, optional Any extra variables to include in local scope when loading.
- code
- Raises:
- ValueError
Raised if a key in extraLocals is the same value as the value of the root argument.
- 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.
- requires_psf()¶
- 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
).
- filename
- 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
str
, optional 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 includeimport
statements in output, this is to support human-oriented output frompipetask
where additional clutter is not useful.
- saveToString(skipImports=False)¶
Return the Python script form of this configuration as an executable string.
- Parameters:
- Returns:
- code
str
A code string readable by
loadFromString
.
- code
- 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.
- setDefaults()¶
Subclass hook for computing defaults.
Notes
Derived
Config
classes that must compute defaults rather than using theField
instances’s defaults should do so here. To correctly use inherited defaults, implementations ofsetDefaults
must call their base class’ssetDefaults
.
- toDict()¶
Make a dictionary of field names and their values.
See also
Notes
This method uses the
toDict
method of individual fields. Subclasses ofField
may need to implement atoDict
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 aConfig
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
andfieldC
:>>> 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
andConfigChoiceField
) are defined inlsst.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
ValuesView
Iterator of field values.
- values