4. Polar Plots - HeloiseS/FUSS GitHub Wiki

The sub-module FUSS.polplot was written to facilitate the creating of polar plots.

Creating The Polar Axis

Before using polplot.axis or polplot.data, a figure must be defined using matplotlib.pyplot (e.g fig=matplotlib.pyplot.figure())

polplot.axis()

This creates the axis on which the data can later be plotted.

Parameters

  • fig (matplotlib.figure.Figure): The figure to plot the axis on.
  • loc (3 digit int, optional): Location of the subplot. Default = 111
  • num_ticks (int, optional): scales the number of ticks (= int(maximum velocity / 1000)*num_ticks)). Default = 1.
  • phot_vel (int/float, optional): Absolute value of the photospheric velocity. Default = None
  • vel_lim (array, optional): Velocity limits [0, max]. Default = [0, 30000]
  • ang_grid (string, optional): Angular grid style: 'h' for heavy, 'l' for light, 'ul' for ultra-light. Default = 'ul'.
  • rad_grid (string, optional): Radial grid style: 'h' for heavy, 'l' for light, 'ul' for ultra-light. Alteratively, specify a radial grid using a list of velocities (must be absolute values). Default = 'l'

Return

  • The polar axis.

polplot.data()

This function creates the data that can then plotted on the polar axis created using polplot.axis()

Parameters

  • pa_start (int): Lower limit of the angular range (in degrees).
  • pa_end (int): Upper limit of the angular range (in degrees).
  • vel (int): Velocity

Return

  • Two 1D arrays of the same length containing the angular component and radial component to be plotted.