MaxiDetectorFov

class gdt.missions.maxi.plot.MaxiDetectorFov(x, y, det, ax, flipped=True, frame='equatorial', color='dimgray', alpha=None, face_color=None, face_alpha=0.25, edge_alpha=0.5, fontsize=10, font_alpha=0.8, font_color=None, **kwargs)[source]

Bases: SkyPolygon

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

Note

The last x and y coordinates are assumed to be represent the center of the FOV (used for the detector annotation), while the rest of the coordinates are assumed to represent the closed polygon of the FOV.

Parameters:

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

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

  • radius (float) – The radius of the circle, in degrees

  • det (str) – The name of the detector

  • 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 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_color and edge_color.

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

  • fontsize (float, optional) – The size of the detector label

  • font_alpha (float, optional) – The alpha opacity of the detector label

  • font_color (str, optional) – The font color.

  • **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

font_alpha

The alpha opacity of the detector label

font_color

The color of the detector label

fontsize

The size of the detector label

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)

font_alpha

The alpha opacity of the detector label

Type:

(float)

font_color

The color of the detector label

Type:

(float)

fontsize

The size of the detector label

Type:

(float)

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