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. 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.
`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`)
`compute_radec_covariance`	Whether to compute the RA/dec covariance.
`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 pixel x/y centroid params to RA/dec (`bool`, default `True`)
`defer_radec_conversion`	Whether to defer conversion of pixel x/y centroid params to RA/dec to compute_model_radec_err.
`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`)
`fit_psmodel_final`	Fit a point source model after optimization (`bool`, default `False`)
`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.
`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. for defining priors) but not necessarily fit.
`requires_psf`()	Return whether the PSF action is not None.
`setDefaults`()	Subclass hook for computing defaults.

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)

compute_radec_covariance#: Whether to compute the RA/dec covariance. Ignore if convert_cen_xy_to_radec is False. (bool, default False)

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 pixel x/y centroid params to RA/dec (bool, default True)

defer_radec_conversion#: Whether to defer conversion of pixel x/y centroid params to RA/dec to compute_model_radec_err. Only effective if convert_cen_xy_to_radec and compute_errors is not NONE, and requires that the overloaded compute_model_radec_err method sets RA/dec values itself. (bool, default False)

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)

fit_psmodel_final#: Fit a point source model after optimization (bool, default False)

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)

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.

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

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.

MultiProFitSourceConfig#

Returns#

Notes#