SpatialModel¶

class gammapy.modeling.models.SpatialModel(**kwargs)[source]¶

Bases: gammapy.modeling.models.core.Model

Spatial model base class.

Attributes Summary

`covariance`
`default_parameters`
`evaluation_radius`	Evaluation radius
`evaluation_region`	Evaluation region
`frozen`	Frozen status of a model, True if all parameters are frozen
`is_energy_dependent`
`parameters`	Parameters (`Parameters`)
`phi_0`
`position`	Spatial model center position
`position_error`	Get 95% containment position error as (`EllipseSkyRegion`)
`type`

Methods Summary

`__call__`(lon, lat[, energy])	Call evaluate method
`copy`()	A deep copy.
`create`(tag[, model_type])	Create a model instance.
`evaluate_geom`(geom)	Evaluate model on `Geom`
`freeze`()	Freeze all parameters
`from_dict`(data)
`from_parameters`(parameters, **kwargs)	Create model from parameter list
`from_position`(position, **kwargs)	Define the position of the model using a sky coord
`integrate_geom`(geom)	Integrate model on `Geom` or `RegionGeom`.
`plot`([ax, geom])	Plot spatial model.
`plot_error`([ax])	Plot position error
`plot_grid`([geom])	Plot spatial model energy slices in a grid.
`plot_interative`([ax, geom])	Plot spatial model.
`reassign`(datasets_names, new_datasets_names)	Reassign a model from one dataset to another
`to_dict`([full_output])	Create dict for YAML serilisation
`unfreeze`()	Restore parameters frozen status to default

Attributes Documentation

covariance¶

default_parameters = <gammapy.modeling.parameter.Parameters object>¶

evaluation_radius¶: Evaluation radius

evaluation_region¶: Evaluation region

frozen¶: Frozen status of a model, True if all parameters are frozen

is_energy_dependent¶

parameters¶: Parameters (Parameters)

phi_0¶

position¶: Spatial model center position

position_error¶: Get 95% containment position error as (EllipseSkyRegion)

type¶

Methods Documentation

__call__(lon, lat, energy=None)[source]¶: Call evaluate method

copy()¶: A deep copy.

static create(tag, model_type=None, *args, **kwargs)¶

Create a model instance.

Examples

>>> from gammapy.modeling.models import Model
>>> spectral_model = Model.create("pl-2", model_type="spectral", amplitude="1e-10 cm-2 s-1", index=3)
>>> type(spectral_model)
<class 'gammapy.modeling.models.spectral.PowerLaw2SpectralModel'>

evaluate_geom(geom)[source]¶

Evaluate model on Geom

Parameters

geomWcsGeom

Returns

Map

freeze()¶: Freeze all parameters

classmethod from_dict(data)¶

classmethod from_parameters(parameters, **kwargs)¶

Create model from parameter list

Parameters

parametersParameters: Parameters for init

Returns

modelModel: Model instance

classmethod from_position(position, **kwargs)[source]¶

Define the position of the model using a sky coord

Parameters

positionSkyCoord: Position

Returns

modelSpatialModel: Spatial model

integrate_geom(geom)[source]¶

Integrate model on Geom or RegionGeom.

Parameters

geomWcsGeom or RegionGeom

Returns

Map or gammapy.maps.RegionNDMap, containing: the integral value in each spatial bin.

plot(ax=None, geom=None, **kwargs)[source]¶

Plot spatial model.

Parameters

axAxes, optional: Axis
geomWcsGeom, optional: Geom to use for plotting.
**kwargsdict: Keyword arguments passed to plot()

Returns

axAxes, optional: Axis

plot_error(ax=None, **kwargs)[source]¶

Plot position error

Parameters

axAxes, optional: Axis
**kwargsdict: Keyword arguments passed to plot()

Returns

axAxes, optional: Axis

plot_grid(geom=None, **kwargs)[source]¶

Plot spatial model energy slices in a grid.

Parameters

geomWcsGeom, optional: Geom to use for plotting.
**kwargsdict: Keyword arguments passed to plot()

Returns

axAxes, optional: Axis

plot_interative(ax=None, geom=None, **kwargs)[source]¶

Plot spatial model.

Parameters

axAxes, optional: Axis
geomWcsGeom, optional: Geom to use for plotting.
**kwargsdict: Keyword arguments passed to plot()

Returns

axAxes, optional: Axis

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 lenght, as the reassignment is element-wise.

Returns

modelModel: Reassigned model.

to_dict(full_output=False)[source]¶: Create dict for YAML serilisation

unfreeze()¶: Restore parameters frozen status to default