ConstantSpatialModel

class gammapy.modeling.models.ConstantSpatialModel

Bases: SpatialModel

Spatially constant (isotropic) spatial model.

For more information see Constant spatial model.

Parameters:

valueQuantity

Value. Default is 1 sr-1.

Attributes Summary

default_parameters
evaluation_radius
frame
position
tag
value	A model parameter.

Methods Summary

evaluate(lon, lat, value)	Evaluate model.
to_dict([full_output])	Create dictionary for YAML serilisation.
to_region(**kwargs)	Model outline as a RectangleSkyRegion.

Attributes Documentation

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

evaluation_radius = None

frame = 'icrs'

position = None

tag = ['ConstantSpatialModel', 'const']

value

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. Default is “”.

minfloat, str or quantity, optional

Minimum (sometimes used in fitting). If None, set to numpy.nan. Default is None.

maxfloat, str or quantity, optional

Maximum (sometimes used in fitting). Default is numpy.nan.

frozenbool, optional

Frozen (used in fitting). Default is False.

errorfloat, optional

Parameter error. Default is 0.

scan_minfloat, optional

Minimum value for the parameter scan. Overwrites scan_n_sigma. Default is None.

scan_maxfloat, optional

Maximum value for the parameter scan. Overwrites scan_n_sigma. Default is None.

scan_n_values: int, optional

Number of values to be used for the parameter scan. Default is 11.

scan_n_sigmaint, optional

Number of sigmas to scan. Default is 2.

scan_values: `numpy.array`, optional

Scan values. Overwrites all the scan keywords before. Default is None.

scale_method{‘scale10’, ‘factor1’, None}, optional

Method used to set factor and scale. Default is “scale10”.

interp{“lin”, “sqrt”, “log”}, optional

Parameter scaling to use for the scan. Default is “lin”.

priorPrior, optional

Prior set on the parameter. Default is None.

Methods Documentation

static evaluate(lon, lat, value)

Evaluate model.

to_dict(full_output=False)

Create dictionary for YAML serilisation.

to_region(**kwargs)

Model outline as a RectangleSkyRegion.

__init__(**kwargs)

classmethod __new__(*args, **kwargs)