TemplateSpatialModel#

class gammapy.modeling.models.TemplateSpatialModel(map, meta=None, normalize=True, interp_kwargs=None, filename=None, copy_data=True)[source]#

Bases: gammapy.modeling.models.spatial.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 {‘method’: ‘linear’, ‘fill_value’: 0, “values_scale”: “log”}.
Filenamestr: Name of the map file
copy_databool: Create a deepcopy of the map data or directly use the original. True by default, can be turned to False to save memory in case of large maps.

Attributes Summary

`covariance`
`default_parameters`
`evaluation_bin_size_min`
`evaluation_radius`	Evaluation radius (`Angle`).
`evaluation_region`	Evaluation region
`frame`
`frozen`	Frozen status of a model, True if all parameters are frozen
`is_energy_dependent`
`map`	Template map (`Map`)
`parameters`	Parameters (`Parameters`)
`phi_0`
`position`	`SkyCoord`
`position_error`	Get 95% containment position error as (`EllipseSkyRegion`)
`position_lonlat`	Spatial model center position `(lon, lat)` in rad and frame of the model
`tag`
`type`

Methods Summary

`__call__`(lon, lat[, energy])	Call evaluate method
`copy`(**kwargs)
`evaluate`(lon, lat[, energy])	Evaluate the model at given coordinates.
`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[, oversampling_factor])	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.
`read`(filename[, normalize])	Read spatial template model from FITS image.
`reassign`(datasets_names, new_datasets_names)	Reassign a model from one dataset to another
`to_dict`([full_output])	Create dict for YAML serilisation
`to_region`(**kwargs)	Model outline from template map boundary (`RectangleSkyRegion`).
`unfreeze`()	Restore parameters frozen status to default
`write`([overwrite])

Attributes Documentation

covariance#

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

evaluation_bin_size_min#

evaluation_radius#

Evaluation radius (Angle).

Set to half of the maximal dimension of the map.

evaluation_region#: Evaluation region

frame#

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

is_energy_dependent#

map#: Template map (Map)

parameters#: Parameters (Parameters)

phi_0#

position#: SkyCoord

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

position_lonlat#: Spatial model center position (lon, lat) in rad and frame of the model

tag = ['TemplateSpatialModel', 'template']#

type#

Methods Documentation

__call__(lon, lat, energy=None)#: Call evaluate method

copy(**kwargs)#

evaluate(lon, lat, energy=None)[source]#: Evaluate the model at given coordinates. Note that, if the map data assume negative values, these are clipped to zero.

evaluate_geom(geom)#

Evaluate model on Geom

Parameters

geomWcsGeom

Returns

Map

freeze()#: Freeze all parameters

classmethod from_dict(data)[source]#

classmethod from_parameters(parameters, **kwargs)#

Create model from parameter list

Parameters

parametersParameters: Parameters for init

Returns

modelModel: Model instance

classmethod from_position(position, **kwargs)#

Define the position of the model using a sky coord

Parameters

positionSkyCoord: Position

Returns

modelSpatialModel: Spatial model

integrate_geom(geom, oversampling_factor=None)#

Integrate model on Geom or RegionGeom.

Integration is performed by simple rectangle approximation, the pixel center model value is multiplied by the pixel solid angle. An oversampling factor can be used for precision. By default, this parameter is set to None and an oversampling factor is automatically estimated based on the model estimation maximal bin width.

For a RegionGeom, the model is integrated on a tangent WCS projection in the region.

Parameters

geomWcsGeom or RegionGeom: The geom on which the integration is performed
oversampling_factorint or None: The oversampling factor to use for integration. Default is None: the factor is estimated from the model minimimal bin size

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)#

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)[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

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

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().

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

modelModel: Reassigned model.

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

to_region(**kwargs)[source]#: Model outline from template map boundary (RectangleSkyRegion).

unfreeze()#: Restore parameters frozen status to default

write(overwrite=False)[source]#