Circular plots

Created on Fri Jun 10 00:01:11 2022

@author: felipe

Functions:

circ_hist(a, ax[, bins, bottom, mean_axis, ...])

Circular histogram with mean value and standard deviation

polar_statistics(angles[, axis, nan_policy])

Polar statisitcs Return the mean and standard deviation of circular data.

plot.circular.circ_hist(a, ax, bins=10, bottom=1, mean_axis=0, density=False, cmap=<matplotlib.colors.LinearSegmentedColormap object>, colorscale=10.0, plotmeanstd=True)

Circular histogram with mean value and standard deviation

Parameters
  • a (2D floay array) – angles data

  • ax (matplotlib.pyplot.axes) – matplotlib.pyplot.axes with projection=’polar’

  • bins (int, optional.) – number of bins in the range [0,360) or [0,2pi). Default value is 10 bins.

  • mean_axis (int, optional.) – The average is calculated along this axis. Default value is 0

  • density (boolean, optional) – if is True it plots a pmf type histogram. Default value is False

  • cmap (plt.cm.colormap, optional. Default is plt.cm.Blues) – Colormap

  • colorscale=float – Scale factor for the colomap. Default is 10.0

  • optional – Scale factor for the colomap. Default is 10.0

  • plotmeanstd (boolean, optional) – Plot or not the mean and standard deviation markers. Default is True

Returns

ax – The axes that could be shown in a subplot of a figure. Usually the same of the ‘ax’ parameter.

Return type

matplotlib.pyplot.axes

plot.circular.polar_statistics(angles, axis=0, nan_policy='omit')

Polar statisitcs Return the mean and standard deviation of circular data. np.circmean returns the same mean value np.circstd returns different standard deviation value

Parameters
  • angles (2D float array) – data of angles.

  • axis (int, optional) – Selected axis to calculate the statistic. The default is 0.

  • nan_policy (string, optional) – Policy for nan values. The default is ‘omit’.

Returns

  • meanpolar (float) – average angle.

  • stdpolar (float) – standard deviation of angles.