spacepy.pybats.ram.IonoPotScb

class spacepy.pybats.ram.IonoPotScb(filename, *args, **kwargs)

The 3D equilibrium code produces NetCDF files that contain the ionospheric potential on the polar cap as well as mapped to the equatorial plane. The IonoPotScb object can be used to parse and visualize the data quickly.

__init__(filename, *args, **kwargs)

Base class for “Data Model” representation data

Abstract method, reimplement

Attributes:

attrsdict

dictionary of the attributes of the SpaceData object

Methods

calc_pot_drop()	Calculate the electric potential drop across the inner magnetosphere for the whole time period.
plot_eqPot(time[, target, range, n, add_cbar])	Plot the equatorial electric potential in kV to target, where target may be a matplotlib figure or axis or None.

Attributes

attrs

calc_pot_drop()

Calculate the electric potential drop across the inner magnetosphere for the whole time period. This value is analogous to cross polar cap potential drop, but is only valid inside of the RAM-SCB domain.

This value is simply the maximum potential minus the minimum potential. The new data entry is stored using key ‘ceqp’, which stands for the cross equatorial potential.

plot_eqPot(time, target=None, range=200, n=31, add_cbar=True)

Plot the equatorial electric potential in kV to target, where target may be a matplotlib figure or axis or None. If target is a figure, a new subplot is created. If target is None, a new figure AND axis is created.

Parameters:

timeint

An array index indicating what epoch to plot.

Returns:

figmatplotlib figure object

axmatplotlib axes object

contmatplotlib contour object

cbarmatplotlib colorbar object

Other Parameters:

ninteger

The number of contours. Defaults to 31.

rangereal

The max and min of the contour range.

add_cbarbool

Set whether to add a color bar or not. Defaults to False.

targetFigure or Axes

If None (default), a new figure is generated from scratch. If a matplotlib Figure object, a new axis is created to fill that figure. If a matplotlib Axes object, the plot is placed into that axis.

locint

Use to specify the subplot placement of the axis (e.g. loc=212, etc.) Used if target is a Figure or None. Default 111 (single plot).

attrs: collections.abc.Mapping