GalacticPlane

class gdt.core.plot.plot.GalacticPlane(ax, flipped=True, frame='equatorial', color=None, inner_color='black', outer_color='dimgray', alpha=None, line_alpha=0.5, center_alpha=0.75, **kwargs)

Bases: PlotElement

Plot the Galactic Plane in equatorial, galactic, or spacecraft coordinates.

Parameters:

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

• flipped (bool, optional) – If True, the azimuthal axis is flipped, following equatorial convention

• frame (str or SpacecraftFrame, optional) – If a string, then can either be ‘equatorial’ or ‘galactic’. Otherwise, it is the spacecraft frame definition. Defaults is ‘equatorial’.

• inner_color (str, optional) – The color of the inner line element

• outer_color (str, optional) – The color of the outer line element

• line_alpha (float, optional) – The alpha opacity of the line elements of the Galactic Plane

• center_alpha (float, optional) – The alpha opacity of the Galactic center

• color (str, optional) – The color of the Galactic plane. Overrides inner_color and outer_color.

• alpha (float, optional) – The opacity of the Galactic plane. Overrides line_alpha and center_alpha.

• **kwargs – Other plotting options

Attributes Summary

alpha	The alpha opacity value
artists	The object references to the individual matplotlib elements
center_alpha	The alpha opacity of the Galactic plane
color	The color of the Galactic plane
inner_color	The color of the inner line element
line_alpha	The alpha opacity of the line elements
outer_color	The color of the outer line element
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)

center_alpha

The alpha opacity of the Galactic plane

Type:

(float)

color

The color of the Galactic plane

Type:

(str)

inner_color

The color of the inner line element

Type:

(str)

line_alpha

The alpha opacity of the line elements

Type:

(float)

outer_color

The color of the outer line element

Type:

(str)

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