TemplateSpatialModel

class gammapy.modeling.models.TemplateSpatialModel(map, norm=<Quantity 1.>, meta=None, normalize=True, interp_kwargs=None, filename=None)[source]

Bases: gammapy.modeling.models.SpatialModel

Spatial sky map template model (2D).

This is for a 2D image. The unit of the map has to be equivalent to sr-1.

Use SkyDiffuseCube for 3D cubes with an energy axis.

For more information see Template Spatial Model.

Parameters
mapMap

Map template. The unit has to be equivalent to sr-1.

normfloat

Norm parameter (multiplied with map values)

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

norm

A model parameter.

parameters

Parameters (Parameters)

phi_0

position

SkyCoord

position_error

Get 95% containment position error as (EllipseSkyRegion)

tag

Methods Summary

__call__(lon, lat)

Call evaluate method

copy()

A deep copy.

create(tag[, model_type])

Create a model instance.

evaluate(lon, lat, norm)

Evaluate model.

evaluate_geom(geom)

Evaluate model on 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

read(filename[, normalize])

Read spatial template model from FITS image.

to_dict()

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
norm

A model parameter.

Note that the parameter value has been split into a factor and scale like this:

value = factor x scale

Users should interact with the value, quantity or min and max properties and consider the fact that there is a factor` and scale an implementation detail.

That was introduced for numerical stability in parameter and error estimation methods, only in the Gammapy optimiser interface do we interact with the factor, factor_min and factor_max properties, i.e. the optimiser “sees” the well-scaled problem.

Parameters
namestr

Name

valuefloat or Quantity

Value

scalefloat, optional

Scale (sometimes used in fitting)

unitUnit or str, optional

Unit

minfloat, optional

Minimum (sometimes used in fitting)

maxfloat, optional

Maximum (sometimes used in fitting)

frozenbool, optional

Frozen? (used in fitting)

parameters

Parameters (Parameters)

phi_0
position

SkyCoord

position_error

Get 95% containment position error as (EllipseSkyRegion)

tag = ['TemplateSpatialModel', 'template']

Methods Documentation

__call__(lon, lat)

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, norm)[source]

Evaluate model.

evaluate_geom(geom)

Evaluate model on Geom.

classmethod from_dict(data)[source]
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

classmethod read(filename, normalize=True, **kwargs)[source]

Read spatial template model from FITS image.

The unit of the map has to be equivalent to sr-1. If no unit 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()[source]

Create dict for YAML serilisation

to_region(**kwargs)[source]

Model outline (PolygonSkyRegion).