ImageProfileEstimator

class gammapy.estimators.ImageProfileEstimator(x_edges=None, method='sum', axis='lon', center=None)

Bases: gammapy.estimators.core.Estimator

Estimate profile from image.

Parameters

x_edgesAngle, optional

Coordinate edges to define a custom measurement grid.

method{‘sum’, ‘mean’}

Compute sum or mean within profile bins. Default is ‘sum’.

axis{‘lon’, ‘lat’, ‘radial’}

Along which axis to estimate the profile. Default is ‘lon’.

centerSkyCoord, optional

Center coordinate for the radial profile option.

Examples

This example shows how to compute a counts profile for the Fermi galactic center region:

import matplotlib.pyplot as plt
from gammapy.estimators import ImageProfileEstimator
from gammapy.maps import Map
from astropy import units as u

# load example data
filename = '$GAMMAPY_DATA/fermi-3fhl-gc/fermi-3fhl-gc-counts.fits.gz'
fermi_cts = Map.read(filename)

# set up profile estimator and run
p = ImageProfileEstimator(axis='lon', method='sum')
profile = p.run(fermi_cts)

# smooth profile and plot
smoothed = profile.smooth(kernel='gauss')
smoothed.peek()
plt.show()

Attributes Summary

config_parameters	Configuration parameters.
selection_optional
tag

Methods Summary

copy()	Copy estimator.
run(image[, image_err, mask])	Run image profile estimator.

Attributes Documentation

config_parameters

Configuration parameters.

selection_optional

tag = 'ImageProfileEstimator'

Methods Documentation

copy()

Copy estimator.

run(image, image_err=None, mask=None)

Run image profile estimator.

Parameters

imageMap

Input image to run profile estimator on.

image_errMap, optional

Input error image to run profile estimator on. Default is None.

maskMap

Optional mask to exclude regions from the measurement.

Returns

profileImageProfile

Result image profile object.