FoVBackgroundModel#
- class gammapy.modeling.models.FoVBackgroundModel(spectral_model=None, dataset_name=None)[source]#
Bases:
gammapy.modeling.models.core.ModelBase
Field of view background model
The background model holds the correction parameters applied to the instrumental background attached to a
MapDataset
orSpectrumDataset
.- Parameters
- spectral_model
SpectralModel
Normalized spectral model.
- dataset_namestr
Dataset name
- spectral_model
Attributes Summary
Frozen status of a model, True if all parameters are frozen
Model name
Model parameters
Spectral norm model
Methods Summary
contributes
(*args, **kwargs)FoV background models always contribute
copy
(**kwargs)evaluate
(energy)Evaluate model
evaluate_geom
(geom)Evaluate map
freeze
([model_type])Freeze model parameters
from_dict
(data)Create model from dict
from_parameters
(parameters, **kwargs)Create model from parameter list
reassign
(datasets_names, new_datasets_names)Reassign a model from one dataset to another
Reset parameter values to default
to_dict
([full_output])Create dict for YAML serialisation
unfreeze
([model_type])Restore parameters frozen status to default
Attributes Documentation
- covariance#
- default_parameters = <gammapy.modeling.parameter.Parameters object>#
- frozen#
Frozen status of a model, True if all parameters are frozen
- name#
Model name
- parameters#
Model parameters
- spectral_model#
Spectral norm model
- tag = ['FoVBackgroundModel', 'fov-bkg']#
- type#
Methods Documentation
- copy(**kwargs)#
- classmethod from_parameters(parameters, **kwargs)#
Create model from parameter list
- Parameters
- parameters
Parameters
Parameters for init
- parameters
- Returns
- model
Model
Model instance
- model
- reassign(datasets_names, new_datasets_names)#
Reassign a model from one dataset to another
- Parameters
- datasets_namesstr or list
Name of the datasets where the model is currently defined
- new_datasets_namesstr or list
Name of the datasets where the model should be defined instead. If multiple names are given the two list must have the save length, as the reassignment is element-wise.
- Returns
- model
Model
Reassigned model.
- model