SkyPolygon

class gdt.core.plot.plot.SkyPolygon(x, y, 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: PlotElement

Plot a polygon on the sky in equatorial, galactic, or spacecraft coordinates.

Parameters:
  • x (float) – The azimuthal coordinate, in degrees

  • y (float) – The polar coordinate, in degrees

  • ax (matplotlib.axes) – The axis on which to plot

  • flipped (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 polygon fill

  • face_alpha (float, optional) – The alpha opacity of the polygon fill

  • edge_color (str, optional) – The color of the polygon edge

  • edge_alpha (float, optional) – The alpha opacity of the polygon edge

  • color (str, optional) – The color of the polygon. If set, overrides face_color and edge_color.

  • alpha (float, optional) – The alpha of the polygon. If set, overrides face_alpha and edge_alpha.

  • **kwargs – Other plotting options

Attributes Summary

alpha

The alpha opacity value

artists

The object references to the individual matplotlib elements

color

The color of the polygon

edge_alpha

The alpha opacity of the polygon edge

edge_color

The color of the polygon edge

face_alpha

The alpha opacity of the polygon fill

face_color

The color of the polygon fill

fill

True if the polygon is filled, False otherwise

hatch

The hatching string

linestyle

The linestyle of the edge

linewidth

The line width of the edge

visible

True if the element is shown on the plot, False otherwise

zorder

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 polygon

Type:

(str)

edge_alpha

The alpha opacity of the polygon edge

Type:

(float)

edge_color

The color of the polygon edge

Type:

(str)

face_alpha

The alpha opacity of the polygon fill

Type:

(float)

face_color

The color of the polygon fill

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

remove()

Remove the plot element

show()

Show the plot element

toggle()

Toggle the visibility of the plot element