gme.sat.rbsp

Module: gme.rbsp

This module handles RBSP foorpoint calculations and plotting

Class:

• rbspFp: FPs reading (or calculating) and plotting

class gme.sat.rbsp.rbspFp(sTime, eTime=None, spacecraft=None, L_shell_min=None, L_shell_max=None, apogees_only=False)

This class reads FPs from the SuperDARN FPs database, or generate them if necessary

Args:

• sTime: start date/time to get FPs
• [eTime]: end date/time to get FPs (defaulst to 24 hours after sTime)
• [hemisphere]: limit FPs loading to a specific hemisphere
• [spacecraft]: limit FPs loading to a specific spacecraft
• [L_shell_min]: limit FPs loading to L-shell values greater than this
• [L_shell_max]: limit FPs loading to L-shell values lesser than this
• [apogees_only]: record foot-points (usefull if all you want are apogees)

Example:

# Get all the FPs for 1/Sept/2012 from 0 to 6 UT
from datetime import datetime
import rbsp
sTime = datetime(2012,9,1,0)
eTime = datetime(2012,9,1,6)
fps = rbsp.rbspFp(sTime, eTime)
# Pretty print the apogees in that period
print fps
# Plot them on a map
fps.map()

Warning

try not to request more than 24 hours at once, unless all you want are apogees.

written by Sebastien de Larquier, 2013-03

map(hemisphere='north', boundinglat=35, spacecraft=None, legend=True, date=True, apogees=False)

Plot FPs on a map

Belongs to: rbspFp

Args:

• [hemisphere]: plot FPs in this hemisphere (‘north’ or ‘south’)
• [boundinglat]: bounding latitude of map (absolute value)
• [spacecraft]: limit the plotting to one spacecraft (‘a’ or ‘b’)
• [legend]: to show or not to show the legend
• [date]: to show or not to show the date
• [apogees]: to show or not to show the apogees
• [isr]: a list of ISRs to be plotted (codes include mho, sdt, eiscat, pfisr, risr)

Returns:

• myMap: a mpl_toolkits.basemap.Basemap object

Example:

# To plot 2 panels (1 per hemisphere)
fig = figure(figsize=(11,8))
subplot(121)
fps.map()
subplot(122)
fps.map(hemisphere='South')
fig.tight_layout()

showISR(myMap, isr)

overlay ISR fovs on map

Belongs to: rbspFp

Args:

• myMap: Basemap object
• isr: a list of ISRs to be plotted (codes include mho, sdt, eiscat, pfisr, risr)

gme.sat.rbsp

alias of gme.sat.rbsp