ImageProfileEstimator

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

Bases: object

Estimate profile from image.

Parameters:

x_edges : Angle

Coordinate edges to define a custom measument grid (optional).

method : [‘sum’, ‘mean’]

Compute sum or mean within profile bins.

axis : [‘lon’, ‘lat’, ‘radial’]

Along which axis to estimate the profile.

center : SkyCoord

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.image import ImageProfileEstimator
from gammapy.maps import Map
from astropy import units as u

# load example data
filename = '$GAMMAPY_DATA/tests/unbundled/fermi/fermi_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()

Methods Summary

run(image[, image_err, mask])

Run image profile estimator.

Methods Documentation

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

Run image profile estimator.

Parameters:

image : Map

Input image to run profile estimator on.

image_err : Map

Input error image to run profile estimator on.

mask : Map

Optional mask to exclude regions from the measurement.

Returns:

profile : ImageProfile

Result image profile object.