pyssage.graph.draw_angular_correlation
pyssage » pyssage.graph » pyssage.graph.draw_angular_correlation
A function for graphing the results of an angular_correlation_analysis. By definition, 0° represents East (right), with positive values moving counter-clockwise (i.e., 90° is North, 180° is West and 270° is South).
Traditionally these figures have been drawn in using a polar coordinate system. An option is available to alternatively draw the figure in Cartesian coordinates.
draw_angular_correlation(data: numpy.ndarray, title: str = "", draw_polar: bool = True,
point_style: Optional[PointStyle] = None, figoutput: Optional[FigOutput] = None)| Parameters: | data: the output values of angular_correlation_analysis |
|---|---|
| title: a title to display above the figure (default = "") | |
| draw_polar: a boolean specifying whether the graph should be drawn in polar coordinates (default = True) | |
| point_style: an optional object of type PointStyle, used to control the visualization of the points on the figure | |
| figoutput: an optional object of type FigOutput, used to control certain aspects of the figure output such as size and whether to display to screen or save to file |