SkyCircle¶
- class gdt.core.plot.plot.SkyCircle(x, y, radius, ax, flipped=True, frame='equatorial', color='C0', alpha=1.0, face_color=None, face_alpha=None, edge_color=None, edge_alpha=None, **kwargs)[source]¶
Bases:
PlotElementPlot a circle on the sky in equatorial, galactic, or spacecraft coordinates.
- Parameters:
x (float) – The azimuthal coordinate of the center, in degrees
y (float) – The polar coordinate of the center, in degrees
radius (float) – The radius of the circle, in degrees
ax (
matplotlib.axes) – The axis on which to plotflipped (bool, optional) – If True, the azimuthal axis is flipped, following equatorial convention
frame (str, optional) – Either ‘equatorial’, ‘galactic’, ‘spacecraft’. Default is ‘equatorial’
face_color (str, optional) – The color of the circle fill
face_alpha (float, optional) – The alpha opacity of the circle fill
edge_color (str, optional) – The color of the circle edge
edge_alpha (float, optional) – The alpha opacity of the circle edge
color (str, optional) – The color of the circle. If set, overrides
face_colorandedge_color.alpha (float, optional) – The alpha of the circle. If set, overrides
face_alphaandedge_alpha.**kwargs – Other plotting options
Attributes Summary
The alpha opacity value
The object references to the individual matplotlib elements
The color of the circle
The alpha opacity of the circle edge
The color of the circle edge
The alpha opacity of the circle fill
The color of the circle fill
True if the circle 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
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
- Type:
(float)
- artists¶
The object references to the individual matplotlib elements
- Type:
(list)
- color¶
The color of the circle
- Type:
(str)
- edge_alpha¶
The alpha opacity of the circle edge
- Type:
(float)
- edge_color¶
The color of the circle edge
- Type:
(str)
- face_alpha¶
The alpha opacity of the circle fill
- Type:
(float)
- face_color¶
The color of the circle fill
- Type:
(str)
- fill¶
True if the circle 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
- remove()¶
Remove the plot element
- show()¶
Show the plot element
- toggle()¶
Toggle the visibility of the plot element