McIlwainL

class gdt.missions.fermi.plot.McIlwainL(lat_range, lon_range, proj, colorbar=True, color=<GdtCmap: viridis;           alpha_min=0.00;           alpha_max=1.00;           alpha_scale=linear>, alpha=None, norm=None, levels=None, **kwargs)

Bases: PlotElement

Plot class for the McIlwain L heatmap.

Parameters:

• lat_range (float, float) – The latitude range

• lon_range (float, float) – The longitude range

• proj (Cartopy Projection) – The Cartopy projection

• ax (matplotlib.axes) – The axis on which to plot

• colorbar (bool, optional) – If True, create a colorbar for the heatmap. Default is True

• color (GdtCmap) – The colormap of the heatmap. Default is ‘viridis’

• alpha (float, optional) – The alpha opacity of the heatmap

• norm (matplotlib.colors.Normalize or similar, optional) – The normalization used to scale the colormapping to the heatmap values. This can be initialized by the defined matplotlib normalizations or a custom normalization.

• levels (list, optional) – The number of plot levels. If not set, the default is to plot from 0.9 to 1.7 in increments of 0.1.

• **kwargs – Other plotting options

Attributes Summary

alpha	The alpha opacity value
artists	The object references to the individual matplotlib elements
color	The colormap
colorbar	The colorbar object
levels	The contour levels
norm	The colormap normalization
visible	True if the element is shown on the plot, False otherwise
zorder	The plot element zorder

Methods Summary

hide()	Hide the plot element
remove()	Remove the plot element
show()	Show the plot element
toggle()	Toggle the visibility of the plot element

Attributes Documentation

alpha

The alpha opacity value

Type:

(float)

artists

The object references to the individual matplotlib elements

Type:

(list)

color

The colormap

Type:

(GdtCmap)

colorbar

The colorbar object

Type:

(matplotlib.colorbar.Colorbar)

levels

The contour levels

Type:

(list)

norm

The colormap normalization

Type:

(matplotlib.colors.Normalize or similar)

visible

True if the element is shown on the plot, False otherwise

Type:

(bool)

zorder

The plot element zorder

Type:

(int)

Methods Documentation

hide()

Hide the plot element

remove()

Remove the plot element

show()

Show the plot element

toggle()

Toggle the visibility of the plot element