LabelMapAxis

class gammapy.maps.LabelMapAxis(labels, name='')

Bases: object

Map axis using labels

Parameters

labelslist of str

Labels to be used for the axis nodes.

namestr

Name of the axis.

Attributes Summary

append	Deprecated since version 1.1.
as_plot_center	Plot labels
as_plot_edges	Plot labels
as_plot_labels	Plot labels
as_plot_xerr	Plot labels
bin_width	Bin width is unity
center	Center of the label axis
edges	Edges of the label axis
edges_max	Edges of the label axis
edges_min	Edges of the label axis
name	Name of the axis
nbin	Number of bins
node_type
unit	Unit

Methods Summary

assert_name(required_name)	Assert axis name if a specific one is required.
concatenate(axis)	Concatenate another LabelMapAxis to this LabelMapAxis into a new LabelMapAxis object.
coord_to_idx(coord, **kwargs)	Transform labels to indices
coord_to_pix(coord)	Transform from axis labels to pixel coordinates.
copy()	Copy axis
downsample(*args, **kwargs)	Downsample axis
format_plot_xaxis(ax)	Format plot axis.
from_stack(axes)	Create a label map axis by merging a list of axis.
from_table(table[, format, idx])	Create time map axis from table
is_allclose(other, **kwargs)	Check if other map axis is all close.
pad(*args, **kwargs)	Resample axis
pix_to_coord(pix)	Transform from pixel to axis coordinates.
pix_to_idx(pix[, clip])	Convert pix to idx
resample(*args, **kwargs)	Resample axis
slice(idx)	Create a new axis object by extracting a slice from this axis.
squash()	Create a new axis object by squashing the axis into one bin.
to_header([format, idx])	Create FITS header
upsample(*args, **kwargs)	Upsample axis

Attributes Documentation

append

Deprecated since version 1.1: The append attribute is deprecated and may be removed in a future version. Use concatenate instead.

as_plot_center

Plot labels

as_plot_edges

Plot labels

as_plot_labels

Plot labels

as_plot_xerr

Plot labels

bin_width

Bin width is unity

center

Center of the label axis

edges

Edges of the label axis

edges_max

Edges of the label axis

edges_min

Edges of the label axis

name

Name of the axis

nbin

Number of bins

node_type = 'label'

unit

Unit

Methods Documentation

assert_name(required_name)

Assert axis name if a specific one is required.

Parameters

required_namestr

Required

concatenate(axis)

Concatenate another LabelMapAxis to this LabelMapAxis into a new LabelMapAxis object.

Names must agree between the axes. labels must be unique.

Parameters

axisLabelMapAxis

Axis to concatenate with.

Returns

axisLabelMapAxis

Concatenation of the two axis.

coord_to_idx(coord, **kwargs)

Transform labels to indices

If the label is not present an error is raised.

Parameters

coordTime

Array of axis coordinate values.

Returns

idxndarray

Array of bin indices.

coord_to_pix(coord)

Transform from axis labels to pixel coordinates.

Parameters

coordndarray

Array of axis label values.

Returns

pixndarray

Array of pixel coordinate values.

copy()

Copy axis

downsample(*args, **kwargs)

Downsample axis

format_plot_xaxis(ax)

Format plot axis.

Parameters

axAxis

Plot axis to format.

Returns

axAxis

Formatted plot axis.

classmethod from_stack(axes)

Create a label map axis by merging a list of axis.

Returns

axisLabelMapAxis

Merged axis.

classmethod from_table(table, format='gadf', idx=0)

Create time map axis from table

Parameters

tableTable

Bin table HDU

format{“gadf”}

Format to use.

Returns

axisTimeMapAxis

Time map axis.

is_allclose(other, **kwargs)

Check if other map axis is all close.

Parameters

otherLabelMapAxis

Other map axis

Returns

is_allclosebool

Whether other axis is allclose

pad(*args, **kwargs)

Resample axis

pix_to_coord(pix)

Transform from pixel to axis coordinates.

Parameters

pixndarray

Array of pixel coordinate values.

Returns

coordndarray

Array of axis coordinate values.

pix_to_idx(pix, clip=False)

Convert pix to idx

Parameters

pixtuple of ndarray

Pixel coordinates.

clipbool

Choose whether to clip indices to the valid range of the axis. If false then indices for coordinates outside the axi range will be set -1.

Returns

idxtuple ndarray

Pixel indices.

resample(*args, **kwargs)

Resample axis

slice(idx)

Create a new axis object by extracting a slice from this axis.

Parameters

idxslice

Slice object selecting a subselection of the axis.

Returns

axisLabelMapAxis

Sliced axis object.

squash()

Create a new axis object by squashing the axis into one bin.

The label of the new axis is given as “first-label…last-label”.

Returns

axisMapAxis

Sliced axis object.

to_header(format='gadf', idx=0)

Create FITS header

Parameters

format{“ogip”}

Format specification

idxint

Column index of the axis.

Returns

headerHeader

Header to extend.

upsample(*args, **kwargs)

Upsample axis