ModelFitting

class jdaviz.configs.default.plugins.model_fitting.model_fitting.ModelFitting(*args, **kwargs)

Bases: PluginTemplateMixin, DatasetSelectMixin, SpectralSubsetSelectMixin, DatasetSpectralSubsetValidMixin, NonFiniteUncertaintyMismatchMixin, AddResultsMixin, TableMixin

See the Model Fitting Plugin Documentation for more details.

Only the following attributes and methods are available through the public plugin API:

• show()

• open_in_tray()

• close_in_tray()

• dataset (DatasetSelect): Dataset to fit the model.

• spatial_subset (SubsetSelect): Only exposed for Cubeviz. Spatially collapsed spectrum to use to fit the model.

• spectral_subset (SubsetSelect)

• model_component (SelectPluginComponent)

• poly_order

• model_component_label (AutoTextField)

• create_model_component()

• remove_model_component()

• model_components()

• valid_model_components()

• get_model_component()

• set_model_component()

• reestimate_model_parameters()

• equation (AutoTextField)

• equation_components()

• cube_fit Only exposed for Cubeviz. Whether to fit the model to the cube instead of to the collapsed spectrum.

• add_results (AddResults)

• residuals_calculate (bool) Whether to calculate and expose the residuals (model minus data).

• residuals (AutoTextField) Label of the residuals to apply when calling calculate_fit() if residuals_calculate is True.

• calculate_fit()

Public constructor

Attributes Summary

comp_label	A trait for unicode strings.
comp_label_auto	A boolean (True, False) trait.
comp_label_default	A trait for unicode strings.
comp_label_invalid_msg	A trait for unicode strings.
component_models	An instance of a Python list.
cube_fit	A boolean (True, False) trait.
dialog	A boolean (True, False) trait.
display_order	A boolean (True, False) trait.
eq_error	A boolean (True, False) trait.
equation_components	List of the labels of model components in the current equation
form_valid_model_component	A boolean (True, False) trait.
model_comp_items	An instance of a Python list.
model_comp_selected	A trait for unicode strings.
model_components	List of the labels of existing model components
model_equation	A trait for unicode strings.
model_equation_auto	A boolean (True, False) trait.
model_equation_default	A trait for unicode strings.
model_equation_invalid_msg	A trait for unicode strings.
poly_order	Mixin to handle empty integer field.
residuals_calculate	A boolean (True, False) trait.
residuals_label	A trait for unicode strings.
residuals_label_auto	A boolean (True, False) trait.
residuals_label_default	A trait for unicode strings.
residuals_label_invalid_msg	A trait for unicode strings.
spatial_subset_items	An instance of a Python list.
spatial_subset_selected	A trait for unicode strings.
template_file
user_api
valid_model_components	List of the labels of existing valid (due to display units) model components

Methods Summary

calculate_fit(*args, **kwargs)
create_model_component([model_component, ...])	Add a new model component to the list of available model components
get_model_component(model_component_label[, ...])	Get a (read-only) dictionary representation of an existing model component.
reestimate_model_parameters([...])	Re-estimate all free parameters in a given model component given the currently selected data and subset selections.
remove_model_component(model_component_label)	Remove an existing model component.
set_model_component(model_component_label, ...)	Set the value or fixed attribute of a parameter in an existing model component.
vue_add_model(event)
vue_apply(event)
vue_reestimate_model_parameters([...])
vue_remove_model(event)

Attributes Documentation

comp_label

A trait for unicode strings.

comp_label_auto

A boolean (True, False) trait.

comp_label_default

A trait for unicode strings.

comp_label_invalid_msg

A trait for unicode strings.

component_models

An instance of a Python list.

cube_fit

A boolean (True, False) trait.

dialog

A boolean (True, False) trait.

display_order

A boolean (True, False) trait.

eq_error

A boolean (True, False) trait.

equation_components

List of the labels of model components in the current equation

form_valid_model_component

A boolean (True, False) trait.

model_comp_items

An instance of a Python list.

model_comp_selected

A trait for unicode strings.

model_components

List of the labels of existing model components

model_equation

A trait for unicode strings.

model_equation_auto

A boolean (True, False) trait.

model_equation_default

A trait for unicode strings.

model_equation_invalid_msg

A trait for unicode strings.

poly_order

Mixin to handle empty integer field.

residuals_calculate

A boolean (True, False) trait.

residuals_label

A trait for unicode strings.

residuals_label_auto

A boolean (True, False) trait.

residuals_label_default

A trait for unicode strings.

residuals_label_invalid_msg

A trait for unicode strings.

spatial_subset_items

An instance of a Python list.

spatial_subset_selected

A trait for unicode strings.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/latest/lib/python3.11/site-packages/jdaviz/configs/default/plugins/model_fitting/model_fitting.py', 'model_fitting.vue')

user_api

valid_model_components

List of the labels of existing valid (due to display units) model components

Methods Documentation

calculate_fit(*args, **kwargs)

create_model_component(model_component=None, model_component_label=None, poly_order=None)

Add a new model component to the list of available model components

Parameters:

model_componentstr

Type of model component to add. If not provided, will default according to model_component.

model_component_labelstr

Name of the model component to add. If not provided, will default according to model_component_label (if model_component_label.auto is True and model_component is passed as an argument, then the default label will be recomputed rather than applying the current value).

poly_orderint

Order of the polynomial if model_component is (or defaults to) “Polynomial1D”. Will raise an error if provided and model_component is not “Polynomial1D”. If not provided, will default according to poly_order.

get_model_component(model_component_label, parameter=None)

Get a (read-only) dictionary representation of an existing model component.

Parameters:

model_component_labelstr

The label given to the existing model component

parameterstr

Optional. The name of a valid parameter in the model component, in which case only the information on that parameter is returned.

reestimate_model_parameters(model_component_label=None)

Re-estimate all free parameters in a given model component given the currently selected data and subset selections.

Parameters:

model_component_labelstr or None.

The label given to the existing model component. If None, will iterate over all model components.

remove_model_component(model_component_label)

Remove an existing model component.

Parameters:

model_component_labelstr

The label given to the existing model component

set_model_component(model_component_label, parameter, value=None, fixed=None)

Set the value or fixed attribute of a parameter in an existing model component.

Parameters:

model_component_labelstr

The label given to the existing model component

parameterstr

The name of a valid parameter in the model component.

valuefloat

Optional. The new initial value of the parameter. If not provided or None, will remain unchanged.

fixedbool

Optional. The new state of the fixed attribute of the parameter. If not provided or None, will remain unchanged.

Returns:

updated dictionary of the parameter representation

vue_add_model(event)

vue_apply(event)

vue_reestimate_model_parameters(model_component_label=None, **kwargs)

vue_remove_model(event)