TemplateSpatialModel

class gammapy.modeling.models.TemplateSpatialModel(map, meta=None, normalize=True, interp_kwargs=None, filename=None)

Bases: gammapy.modeling.models.SpatialModel

Spatial sky map template model.

For more information see Template Spatial Model.

Parameters

mapMap

Map template.

metadict, optional

Meta information, meta[‘filename’] will be used for serialization

normalizebool

Normalize the input map so that it integrates to unity.

interp_kwargsdict

Interpolation keyword arguments passed to gammapy.maps.Map.interp_by_coord. Default arguments are {‘interp’: ‘linear’, ‘fill_value’: 0}.

Attributes Summary

covariance
default_parameters
evaluation_radius	Evaluation radius (Angle).
frame
is_energy_dependent
parameters	Parameters (Parameters)
phi_0
position	SkyCoord
position_error	Get 95% containment position error as (EllipseSkyRegion)
tag
type

Methods Summary

__call__(lon, lat[, energy])	Call evaluate method
copy()	A deep copy.
create(tag[, model_type])	Create a model instance.
evaluate(lon, lat[, energy])
evaluate_geom(geom)
from_dict(data)
from_parameters(parameters, **kwargs)	Create model from parameter list
integrate_geom(geom)	Integrate model on Geom.
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.
read(filename[, normalize])	Read spatial template model from FITS image.
to_dict([full_output])	Create dict for YAML serilisation
to_region(**kwargs)	Model outline (PolygonSkyRegion).

Attributes Documentation

covariance

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

evaluation_radius

Evaluation radius (Angle).

Set to half of the maximal dimension of the map.

frame

is_energy_dependent

parameters

Parameters (Parameters)

phi_0

position

SkyCoord

position_error

Get 95% containment position error as (EllipseSkyRegion)

tag = ['TemplateSpatialModel', 'template']

type

Methods Documentation

__call__(lon, lat, energy=None)

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)
gammapy.modeling.models.spectral.PowerLaw2SpectralModel

evaluate(lon, lat, energy=None)

evaluate_geom(geom)

classmethod from_dict(data)

classmethod from_parameters(parameters, **kwargs)

Create model from parameter list

Parameters

parametersParameters

Parameters for init

Returns

modelModel

Model instance

integrate_geom(geom)

Integrate model on Geom.

plot(ax=None, geom=None, **kwargs)

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)

Plot position error

Parameters

axAxes, optional

Axis

**kwargsdict

Keyword arguments passed to plot()

Returns

axAxes, optional

Axis

plot_grid(geom=None, **kwargs)

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)

Plot spatial model.

Parameters

axAxes, optional

Axis

geomWcsGeom, optional

Geom to use for plotting.

**kwargsdict

Keyword arguments passed to plot()

Returns

axAxes, optional

Axis

classmethod read(filename, normalize=True, **kwargs)

Read spatial template model from FITS image. If unit is not given in the FITS header the default is sr-1.

Parameters

filenamestr

FITS image filename.

normalizebool

Normalize the input map so that it integrates to unity.

kwargsdict

Keyword arguments passed to Map.read().

to_dict(full_output=False)

Create dict for YAML serilisation

to_region(**kwargs)

Model outline (PolygonSkyRegion).