healpy.visufunc.azeqview

Contents

healpy.visufunc.azeqview#

healpy.visufunc.azeqview(map=None, fig=None, rot=None, zat=None, coord=None, unit='', xsize=800, ysize=None, reso=1.5, lamb=False, half_sky=False, title=None, nest=False, remove_dip=False, remove_mono=False, gal_cut=0, min=None, max=None, flip='astro', format='%.3g', cbar=True, cmap=None, badcolor='gray', bgcolor='white', norm=None, aspect=None, hold=False, sub=None, reuse_axes=False, margins=None, notext=False, return_projected_map=False, alpha=None, fontsize=None)#

Plot a HEALPix map (given as an array) in Azimuthal equidistant projection or Lambert azimuthal equal-area projection.

Parameters:
mapfloat, array-like or None

An array containing the map, supports masked maps, see the ma function. If None, will display a blank map, useful for overplotting.

figint or None, optional

The figure number to use. Default: create a new figure

rotscalar or sequence, optional

Describe the rotation to apply. In the form (lon, lat, psi) (unit: degrees) : the point at longitude lon and latitude lat will be at the center. An additional rotation of angle psi around this direction is applied.

coordsequence of character, optional

Either one of ‘G’, ‘E’ or ‘C’ (where ‘E’ stands for the Ecliptic, ‘G’ for the Galactic, and ‘C’ for the Celestial or equatorial) to describe the coordinate system of the map, or a sequence of 2 of these to rotate the map from the first to the second coordinate system.

unitstr, optional

A text describing the unit of the data. Default: ‘’

xsizeint, optional

The size of the image. Default: 800

ysizeNone or int, optional

The vertical size of the image. Default: None= xsize

zatfloat, optional

The zenith angle of the center of the projection in degrees. Default: None

resofloat, optional

Resolution (in arcmin). Default: 1.5 arcmin

lambbool, optional

If True, plot Lambert azimuthal equal area instead of azimuthal equidistant. Default: False (az equidistant)

half_skybool, optional

Plot only one side of the sphere. Default: False

titlestr, optional

The title of the plot. Default: ‘Azimuthal equidistant view’ or ‘Lambert azimuthal equal-area view’ (if lamb is True)

nestbool, optional

If True, ordering scheme is NESTED. Default: False (RING)

minfloat, optional

The minimum range value

maxfloat, optional

The maximum range value

flip{‘astro’, ‘geo’}, optional

Defines the convention of projection : ‘astro’ (default, east towards left, west towards right) or ‘geo’ (east towards right, west towards left)

remove_dipbool, optional

If True, remove the dipole+monopole

remove_monobool, optional

If True, remove the monopole

gal_cutfloat, scalar, optional

Symmetric galactic cut for the dipole/monopole fit. Removes points in latitude range [-gal_cut, +gal_cut]

formatstr, optional

The format of the scale label. Default: ‘%.3g’

cbarbool, optional

Display the colorbar. Default: True

notextbool, optional

If True, no text is printed around the map

norm{‘hist’, ‘log’, None}

Color normalization, hist= histogram equalized color mapping, log= logarithmic color mapping, Default: None (linear color mapping)

aspectstr or None, optional

Aspect ratio of the axes. Default: None (auto)

cmapa color map

The colormap to use (see matplotlib.cm)

badcolorstr

Color to use to plot bad values

bgcolorstr

Color to use for background

holdbool, optional

If True, replace the current Axes by an Equidistant AzimuthalAxes. use this if you want to have multiple maps on the same figure. Default: False

subint, scalar or sequence, optional

Use only a zone of the current figure (same syntax as subplot). Default: None

reuse_axesbool, optional

If True, reuse the current Axes (should be a AzimuthalAxes). This is useful if you want to overplot with a partially transparent colormap, such as for plotting a line integral convolution. Default: False

marginsNone or sequence, optional

Either None, or a sequence (left,bottom,right,top) giving the margins on left,bottom,right and top of the axes. Values are relative to figure (0-1). Default: None

return_projected_mapbool

if True returns the projected map in a 2d numpy array

alphafloat, array-like or None

An array containing the alpha channel, supports masked maps, see the ma function. If None, no transparency will be applied.

fontsizedict, optional

Override font sizes. Allowed keys are ‘xlabel’, ‘ylabel’, ‘title’, ‘xtick_label’, ‘ytick_label’, ‘cbar_label’, ‘cbar_tick_label’. Default: None uses relative sizes that scale with DPI (‘large’ for most text). To exactly reproduce plots from previous versions, use: fontsize={'cbar_label': 14}