lstid_processing.model.plots

Create some useful plots for the SAMI3 concatonated data.

Functions

plot_f2_peak_char_and_diff(sami, f2_inds[, nt, ...])	Plot the F2 peak characteristics and hemispheric differences.
plot_dom_acceleration(sami, nt, nlind[, dom_acc, ...])	Plot the dominate acceleration terms for a single time and meridian.
plot_dens_var(sami, nlind, nfind, nzind, sat_key[, ...])	Plot the electron, O+, and H+ density variations at a desired location.
plot_field_lines_w_linear_var(sami, nt, nlind, nfinds, ...)	Plot the 6-panel conjunction figure.
get_plot_tid_peaks(sami, nt_start, nt_stop, nlind, ...)	Calculate and plot the TID peaks for a given time and altitude range.

Module Contents

lstid_processing.model.plots.plot_f2_peak_char_and_diff(sami, f2_inds, nt=None, dat_keys=None, start=dt.datetime(2014, 3, 25, 22), stop=dt.datetime(2014, 3, 26, 6))

Plot the F2 peak characteristics and hemispheric differences.

Parameters:

samixr.Dataset

Dataset with concatonated SAMI3 data

f2_indsdict

Dict with north and south indices for the F2 peaks along a field line

ntint or NoneType

Event time index or None to not include a vertical line marking this point (default=None)

dat_keyslist-like

List of data keys to plot, if None uses altitude and field-aligned neutral wind (default=None)

startdt.datetime

Starting time for plot (default=dt.datetime(2014, 3, 25, 22))

stopdt.datetime

Ending time for plot (default=dt.datetime(2014, 3, 26, 6))

Returns:

figplt.Figure

Figure handle

lstid_processing.model.plots.plot_dom_acceleration(sami, nt, nlind, dom_acc=None, nfinds=None, nz_sat=None, nz_north=None, nz_south=None)

Plot the dominate acceleration terms for a single time and meridian.

Parameters:

samixr.Dataset

Dataset with concatonated SAMI3 data

ntint

Time index

nlindint

‘nl’ meridian index

dom_accarray-like or NoneType

Array of values specifying the dominant acceleration term or None to calculate (default=None)

nfindslist-like or None

List of ‘nf’ indices for field lines to be plotted (default=None)

nz_satlist-like or None

List of ‘nz’ indices corresponding to the nfinds indices for satellite locations (default=None)

nz_northlist-like or None

List of ‘nz’ indices corresponding to the nfinds indices for northern F2 peak locations (default=None)

nz_southlist-like or None

List of ‘nz’ indices corresponding to the nfinds indices for southern F2 peak locations (default=None)

Returns:

figplt.Figure

Figure handle

lstid_processing.model.plots.plot_dens_var(sami, nlind, nfind, nzind, sat_key, nt=None, nt_color='k', title='', start=dt.datetime(2014, 3, 25, 22), stop=dt.datetime(2014, 3, 26, 6))

Plot the electron, O+, and H+ density variations at a desired location.

Parameters:

samixr.Dataset

Dataset with concatonated SAMI3 data

nlindint

‘nl’ index

nfindint

‘nf’ index

nzindint

‘nf’ index

ntint or None

Time index to plot a vertical line marking time or None (default=None)

nt_colorstr

Color for vertical line (default=’k’)

sat_keystr

Single character string used to specify the satellite/meridian for the data variations (e.g., ‘c’ or ‘d’)

title ; str

Figure title string (default=’’)

startdt.datetime

Starting time for plot (default=dt.datetime(2014, 3, 25, 22))

stopdt.datetime

Ending time for plot (default=dt.datetime(2014, 3, 26, 6))

Returns:

figplt.Figure

Figure handle

lstid_processing.model.plots.plot_field_lines_w_linear_var(sami, nt, nlind, nfinds, nz_sat, nz_north, nz_south, colors, sat_labels)

Plot the 6-panel conjunction figure.

Parameters:

samixr.Dataset

SAMI3 standard or concatonated data set

ntint

Time index

nlindint

‘nl’ index

nfindslist-like

List of two ‘nl’ indexes

nz_satlist-like

List of ‘nz’ indices corresponding to the nfinds indices for satellite locations

nz_northlist-like

List of ‘nz’ indices corresponding to the nfinds indices for northern F2 peak locations

nz_southlist-like or None

List of ‘nz’ indices corresponding to the nfinds indices for southern F2 peak locations

colorslist-like

This that contains two colors for each satellite as a list, for example [[‘orange’, ‘tan’], [‘k’, ‘grey’]]

sat_labelslist-like

List of satellite labels

Returns:

figplt.Figure

Figure handle

lstid_processing.model.plots.get_plot_tid_peaks(sami, nt_start, nt_stop, nlind, nfind, nzinds, dat_keys, dat_labels=None, dat_scale=None, peak_height=None, add_lines=True, add_line_labels=False, min_lat=None, min_sec=None, min_lat_break=None, min_lin_fit=None, max_lat=None, max_sec=None, max_lat_break=None, max_lin_fit=None)

Calculate and plot the TID peaks for a given time and altitude range.

Parameters:

samixr.Dataset

SAMI3 concatonated data set

nt_start: int

Starting time index

nt_stopint

Ending time index

nlindint

‘nl’ index

nfindint

‘nf’ index

nzindslist-like

List of ‘nz’ indices corresponding to, e.g., the topside ionosphere

dat_keyslist-like or str

List of data keys to plot or a satellite string to use defaults

dat_labelslist-like or NoneType

List of data labels, will be overwritten if dat_keys is a satellite string (default=None)

dat_scalelist-like or NoneType

List of data scales for keys, if a satellite string is used for dat_keys this will be reset (default=None)

peak_heightlist-like or NoneType

List of peak height minima for keys, if a satellite string is used for dat_keys this will be reset (default=None)

add_linesbool

Add linear fits to plot (default=True)

add_line_labelsbool

Add the linear fits to the legend (default=False)

min_latdict or NoneType

Latitudes corresponding to the minima indices with keys corresponding to data variables or None to calculate (default=None)

min_secdict or NoneType

Seconds from the starting time corresponding to the minima indices with keys corresponding to data variables or None to calculate (default=None)

min_lat_breakdict or NoneType

Indices of the latitude breaks with keys corresponding to data variables for the minima or None to calculate (default=None)

min_lin_fitdict or NoneType

Output from scipy.stats.linregress for each valid fit period or None to calculate (default=None)

max_latdict or NoneType

Latitudes corresponding to the maxima indices with keys corresponding to data variables or None to calculate (default=None)

max_secdict or NoneType

Seconds from the starting time corresponding to the maxima indices with keys corresponding to data variables or None to calculate (default=None)

max_lat_breakdict or NoneType

Indices of the latitude breaks with keys corresponding to data variables for the maxim aor None to calculate (default=None)

max_lin_fitdict or NoneType

Output from scipy.stats.linregress for each valid fit period or None to calculate (default=None)

Returns:

min_latdict

Latitudes corresponding to the minima indices with keys corresponding to data variables

min_secdict

Seconds from the starting time corresponding to the minima indices with keys corresponding to data variables

min_lat_breakdict

Indices of the latitude breaks with keys corresponding to data variables for the minima

min_lin_fitdict

Output from scipy.stats.linregress for each valid fit period

max_latdict

Latitudes corresponding to the maxima indices with keys corresponding to data variables

max_secdict

Seconds from the starting time corresponding to the maxima indices with keys corresponding to data variables

max_lat_breakdict

Indices of the latitude breaks with keys corresponding to data variables for the maxima

max_lin_fitdict

Output from scipy.stats.linregress for each valid fit period

figplt.Figure

Figure handle