RingBackgroundMaker#

class gammapy.makers.RingBackgroundMaker(r_in, width, exclusion_mask=None)[source]#

Bases: gammapy.makers.core.Maker

Perform a local renormalisation of the existing background template, using a ring kernel. Expected signal regions should be removed by passing an exclusion mask

Parameters
r_inQuantity

Inner ring radius

widthQuantity

Ring width

exclusion_maskWcsNDMap

Exclusion mask

See also

AdaptiveRingBackgroundEstimator

Examples

See: For a usage example, see ring_background.html # noqa: E501

Attributes Summary

tag

Methods Summary

kernel(image)

Ring kernel.

make_maps_off(dataset)

Make off maps

run(dataset[, observation])

Run ring background maker

Attributes Documentation

tag = 'RingBackgroundMaker'#

Methods Documentation

kernel(image)[source]#

Ring kernel.

Parameters
imageWcsNDMap

Input Map

Returns
ringRing2DKernel

Ring kernel.

make_maps_off(dataset)[source]#

Make off maps

Parameters
datasetMapDataset

Input map dataset.

Returns
maps_offdict of WcsNDMap

Dictionary containing counts_off and acceptance_off maps.

run(dataset, observation=None)[source]#

Run ring background maker

Parameters
datasetMapDataset

Input map dataset.

Returns
dataset_on_offMapDatasetOnOff

On off dataset.