FermiEarthPlot¶
- class gdt.missions.fermi.plot.FermiEarthPlot(saa=None, mcilwain=True, **kwargs)[source]¶
Bases:
EarthPlotClass for plotting Fermi’s orbit, including the McIlwain L heatmap.
Note
This class requires installation of Cartopy.
- Parameters:
saa (
SouthAtlanticAnomaly, optional) – If set, displays the SAA polygon.mcilwain (optional, bool) – Set to True if plotting the McIlwain L heatmap, otherwise False.
**kwargs – Options to pass to
GdtPlot
Attributes Summary
The matplotlib axes object for the plot
The plotting canvas, if set upon initialization.
The matplotlib figure object
The Cartopy axes
The McIlwain L heatmap
The orbital path
The SAA polygon
A plot point representing the spacecraft position
The plotting range of the x axis
The scale of the x axis, either 'linear' or 'log'.
The plotting range of the y axis.
The scale of the y axis, either 'linear' or 'log'.
Methods Summary
add_spacecraft_frame(*args, **kwargs)Add a SpacecraftFrame object to plot the orbital path and optionally the spacecraft position at a particular time.
Add a standard plot title containing orbital position and McIlwain L
Attributes Documentation
- ax¶
The matplotlib axes object for the plot
- Type:
(
matplotlib.axes)
- canvas¶
The plotting canvas, if set upon initialization.
- Type:
(Canvas Backend object)
- fig¶
The matplotlib figure object
- Type:
(
matplotlib.figure)
- geoaxes¶
The Cartopy axes
- Type:
(cartopy.mpl.geoaxes.GeoAxesSubplot)
- orbit¶
The orbital path
- Type:
(
EarthLine)
- saa¶
The SAA polygon
- Type:
(
SAA)
- spacecraft¶
A plot point representing the spacecraft position
- Type:
(
EarthPoints)
- xlim¶
The plotting range of the x axis
- Type:
(float, float)
- xscale¶
The scale of the x axis, either ‘linear’ or ‘log’.
- Type:
(str)
- ylim¶
The plotting range of the y axis.
- Type:
(float, float)
- yscale¶
The scale of the y axis, either ‘linear’ or ‘log’.
- Type:
(str)
Methods Documentation
- add_spacecraft_frame(*args, **kwargs)[source]¶
Add a SpacecraftFrame object to plot the orbital path and optionally the spacecraft position at a particular time.
- Parameters:
frame (
SpacecraftFrame) – The spacecraft frame containing position informationtstart – (astropy.time.Time, optional): The start time to plot the orbit. If not set, then uses the first
frame.obstime.tstop – (astropy.time.Time, astropy.units.Quantity, or float, optional): Either a time value signifying the end of the range, the duration of the time range as a Quantity with appropriate unit, or an int/float representing the number of seconds. If not set, then uses the last
frame.obstime.step (datetime.TimeDelta, astropy.units.Quantity, or float, optional) – Either a TimeDelta value, Quantity with appropriate unit, or an int/float representing the number of seconds. Default is 1.0
trigtime (astropy.time.Time) – Set to a particular time of interest to plot the location.
icon (
EarthPoints) – A subclass of EarthPoints that defines a specialized spacecraft icon. If not set, will default to standard matplotlib markers.**kwargs – Arguments to be passed to
EarthPointsificonis not set.