spacepy.pybats.add_body¶
-
spacepy.pybats.
add_body
(ax, rad=2.5, facecolor='lightgrey', add_planet=True, ang=0.0, add_night=True, **extra_kwargs)[source]¶ Creates a circle of radius=self.attrs[‘rbody’] and returns the MatPlotLib Ellipse patch object for plotting. If an axis is specified using the “ax” keyword, the patch is added to the plot. Default color is light grey; extra keywords are handed to the Ellipse generator function.
Because the body is rarely the size of the planet at the center of the modeling domain, add_planet is automatically called. This can be negated by using the add_planet kwarg.
Parameters: ax : Matplotlib Axes object
Set the axes on which to place planet.
Other Parameters: rad : float
Set radius of the inner boundary. Defaults to 2.5.
facecolor : string
Set color of face of inner boundary circle via Matplotlib color selectors (name, hex, etc.) Defaults to ‘lightgrey’.
add_planet : boolean
Turns on/off planet indicator inside inner boundary. Defaults to True
ang : float
Set the rotation of the day-night terminator from the y-axis, in degrees. Defaults to zero (terminator is aligned with Y-axis.)
add_night : boolean
Add night hemisphere. Defaults to True