AutoScaledWCSAxes

class cosmoplotian.AutoScaledWCSAxes(*args, header, obstime=None, **kwargs)[source] [edit on github]

Bases: astropy.visualization.wcsaxes.WCSAxes

Axes base class. The pixel scale is adjusted to the DPI of the image, and there are a variety of convenience methods.

Attributes Summary

header

name

Methods Summary

compass(x, y, size)

Add a compass to indicate the north and east directions.

connect_inset_axes(ax, loc, *args, **kwargs)

Connect a corner of another WCSAxes to the matching point inside this one.

contour_hpx(data[, hdu_in, order, nested, …])

Add contour levels for a HEALPix data set.

contourf_hpx(data[, hdu_in, order, nested, …])

Add filled contour levels for a HEALPix data set.

imshow_hpx(data[, hdu_in, order, nested, …])

Add an image for a HEALPix data set.

mark_inset_axes(ax, *args, **kwargs)

Outline the footprint of another WCSAxes inside this one.

scalebar(*args, **kwargs)

Add scale bar.

Attributes Documentation

header
name = 'astro wcs'

Methods Documentation

compass(x, y, size)[source] [edit on github]

Add a compass to indicate the north and east directions.

Parameters
x, yfloat

Position of compass vertex in axes coordinates.

sizefloat

Size of compass in axes coordinates.

connect_inset_axes(ax, loc, *args, **kwargs)[source] [edit on github]

Connect a corner of another WCSAxes to the matching point inside this one.

Parameters
axastropy.visualization.wcsaxes.WCSAxes

The other axes.

locint, str

Which corner to connect. For valid values, see matplotlib.offsetbox.AnchoredOffsetbox.

Other Parameters
args :

Extra arguments for matplotlib.patches.ConnectionPatch

kwargs :

Extra keyword arguments for matplotlib.patches.ConnectionPatch

Returns
——-
patchmatplotlib.patches.ConnectionPatch
contour_hpx(data, hdu_in=None, order='bilinear', nested=False, field=0, smooth=None, **kwargs)[source] [edit on github]

Add contour levels for a HEALPix data set.

Parameters
datanumpy.ndarray or str or TableHDU or BinTableHDU or tuple

The HEALPix data set. If this is a numpy.ndarray, then it is interpreted as the HEALPix array in the same coordinate system as the axes. Otherwise, the input data can be any type that is understood by reproject.reproject_from_healpix.

smoothastropy.units.Quantity, optional

An optional smoothing length in angle-compatible units.

Returns
countoursmatplotlib.contour.QuadContourSet
Other Parameters
hdu_in, order, nested, field, smooth :

Extra arguments for reproject.reproject_from_healpix

kwargs :

Extra keyword arguments for matplotlib.axes.Axes.contour

contourf_hpx(data, hdu_in=None, order='bilinear', nested=False, field=0, smooth=None, **kwargs)[source] [edit on github]

Add filled contour levels for a HEALPix data set.

Parameters
datanumpy.ndarray or str or TableHDU or BinTableHDU or tuple

The HEALPix data set. If this is a numpy.ndarray, then it is interpreted as the HEALPix array in the same coordinate system as the axes. Otherwise, the input data can be any type that is understood by reproject.reproject_from_healpix.

smoothastropy.units.Quantity, optional

An optional smoothing length in angle-compatible units.

Returns
contoursmatplotlib.contour.QuadContourSet
Other Parameters
hdu_in, order, nested, field, smooth :

Extra arguments for reproject.reproject_from_healpix

kwargs :

Extra keyword arguments for matplotlib.axes.Axes.contour

imshow_hpx(data, hdu_in=None, order='bilinear', nested=False, field=0, smooth=None, **kwargs)[source] [edit on github]

Add an image for a HEALPix data set.

Parameters
datanumpy.ndarray or str or TableHDU or BinTableHDU or tuple

The HEALPix data set. If this is a numpy.ndarray, then it is interpreted as the HEALPix array in the same coordinate system as the axes. Otherwise, the input data can be any type that is understood by reproject.reproject_from_healpix.

smoothastropy.units.Quantity, optional

An optional smoothing length in angle-compatible units.

Returns
imagematplotlib.image.AxesImage
Other Parameters
hdu_in, order, nested, field, smooth :

Extra arguments for reproject.reproject_from_healpix

kwargs :

Extra keyword arguments for matplotlib.axes.Axes.contour

mark_inset_axes(ax, *args, **kwargs)[source] [edit on github]

Outline the footprint of another WCSAxes inside this one.

Parameters
axastropy.visualization.wcsaxes.WCSAxes

The other axes.

Returns
patchmatplotlib.patches.PathPatch
Other Parameters
args :

Extra arguments for matplotlib.patches.PathPatch

kwargs :

Extra keyword arguments for matplotlib.patches.PathPatch

scalebar(*args, **kwargs)[source] [edit on github]

Add scale bar.

Parameters
xytuple

The axes coordinates of the scale bar.

lengthastropy.units.Quantity

The length of the scale bar in angle-compatible units.

Returns
patchmatplotlib.patches.FancyArrowPatch
Other Parameters
args :

Extra arguments for matplotlib.patches.FancyArrowPatch

kwargs :

Extra keyword arguments for matplotlib.patches.FancyArrowPatch