SAA¶
- class gdt.core.plot.plot.SAA(saa_def, proj, ax, color='darkred', alpha=0.4, **kwargs)[source]¶
Bases:
PlotElementPlot the SAA polygon on the Earth.
- Parameters:
saa_def (
SouthAtlanticAnomaly) – Object containing the SAA boundary definitionproj (Cartopy Projection) – The Cartopy projection
ax (
matplotlib.axes) – The axis on which to plotcolor (str, optional) – The color of the SAA polygon
alpha (float, optional) – The alpha of the interior of the polygon
**kwargs – Other plotting options
Attributes Summary
The alpha opacity value, between 0 and 1.
The object references to the individual matplotlib elements
The color of the plot element
True if the polygon is filled, False otherwise
The hatching string
The linestyle of the edge
The line width of the edge
True if the element is shown on the plot, False otherwise
The plot element zorder
Methods Summary
hide()Hide the plot element
in_saa(lon, lat)Check if a point or points is inside the SAA
remove()Remove the plot element
show()Show the plot element
toggle()Toggle the visibility of the plot element
Attributes Documentation
- alpha¶
The alpha opacity value, between 0 and 1.
- Type:
(float)
- artists¶
The object references to the individual matplotlib elements
- Type:
(list)
- color¶
The color of the plot element
- Type:
(str)
- fill¶
True if the polygon is filled, False otherwise
- Type:
(bool)
- hatch¶
The hatching string
- Type:
(str)
- linestyle¶
The linestyle of the edge
- Type:
(str)
- linewidth¶
The line width of the edge
- Type:
(int)
- visible¶
True if the element is shown on the plot, False otherwise
- Type:
(bool)
- zorder¶
The plot element zorder
- Type:
(int)
Methods Documentation
- hide()¶
Hide the plot element
- in_saa(lon, lat)[source]¶
Check if a point or points is inside the SAA
- Parameters:
lon (np.array) – longitudes
lat (np.array) – latitudes
- Returns:
np.array – Boolean array for each point where True indicates the point is in the SAA.
- remove()¶
Remove the plot element
- show()¶
Show the plot element
- toggle()¶
Toggle the visibility of the plot element