spacepy.ae9ap9.Ae9Data¶
-
class
spacepy.ae9ap9.
Ae9Data
(*args, **kwargs)[source]¶ Dictionary-like container for AE9/AP9/SPM data, derived from SpacePy’s datamodel
To inspect the variables within this class, use the tree method. To export the data to a CDF, HDF5 or JSON-headed ASCII file use the relevant “to” method (toCDF, toHDF5, toJSONheadedASCII).
getLm
([alpha, model])Calculate McIlwain L for the imported AE9/AP9 run and add to object plotOrbit
([timerange, coord_sys, landscape, …])Plot X-Y and X-Z projections of satellite orbit in requested coordinate system plotSummary
([timerange, coord_sys, …])Generate summary plot of AE9/AP9/SPM data loaded plotSpectrogram
([ecol, pvars])Plot a spectrogram of the flux along the requested orbit, as a function of Lm and time setUnits
([per])Set units of energy and flux/fluence -
getLm
(alpha=[90], model='T89')[source]¶ Calculate McIlwain L for the imported AE9/AP9 run and add to object
-
plotOrbit
(timerange=None, coord_sys=None, landscape=True, fig_target=None)[source]¶ Plot X-Y and X-Z projections of satellite orbit in requested coordinate system
-
plotSummary
(timerange=None, coord_sys=None, fig_target=None, spec=False, orbit_params=(False, True), **kwargs)[source]¶ Generate summary plot of AE9/AP9/SPM data loaded
spec : if True, plot spectrogram instead of flux/fluence lineplot, requires ‘ecol’ keyword
-
plotSpectrogram
(ecol=0, pvars=None, **kwargs)[source]¶ Plot a spectrogram of the flux along the requested orbit, as a function of Lm and time
Other Parameters: zlim : list
2-element list with upper and lower bounds for color scale
colorbar_label : string
text to appear next to colorbar (default is ‘Flux’ plus the units)
ylabel : string
text to label y-axis (default is ‘Lm’ plus the field model name)
title : string
text to appear above spectrogram (default is climatology model name, data type and energy)
pvars : list
list of plotting variable names in order [Epoch-like (X axis), Flux-like (Z axis), Energy (Index var for Flux-like)]
ylim : list
2-element list with upper and lower bounds for y axis
-
setUnits
(per=None)[source]¶ Set units of energy and flux/fluence
If keyword ‘per’ is set to None, this method reports the units currently set. To set energy in MeV and flux/fluence in ‘per MeV’, set ‘per=MeV’. Valid options are ‘eV’, ‘keV’, ‘Mev’ and ‘GeV’.
Other Parameters: per : string (optional)
Energy units for both energy and flux/fluence
-