healpy.visufunc.cartview¶
- healpy.visufunc.cartview(map=None, fig=None, rot=None, zat=None, coord=None, unit='', xsize=800, ysize=None, lonra=None, latra=None, title='Cartesian view', 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)¶
Plot a healpix map (given as an array) in Cartesian 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
- lonrasequence, optional
Range in longitude. Default: [-180,180]
- latrasequence, optional
Range in latitude. Default: [-90,90]
- titlestr, optional
The title of the plot. Default: ‘Mollweide view’
- 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 roght, 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: ‘%g’
- cbarbool, optional
Display the colorbar. Default: True
- notextbool, optional
If True, no text is printed around the map
- norm{‘hist’, ‘log’, None}, optional
Color normalization, hist= histogram equalized color mapping, log= logarithmic color mapping, default: None (linear color mapping)
- 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 a CartesianAxes. 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 CartesianAxes). 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.