API Reference¶

LSteinCanvas¶

`LSteinCanvas`(…)	main canvas to draw LSteinPanels into
`LSteinCanvas.__init__`(…)	constructor
`LSteinCanvas.add_panel`(…)	returns created LSteinPanel
`LSteinCanvas.compute_thetaaxis`(…)	computes and returns various elements necessary for adding the theta-axis (azimuthal) to the canvas
`LSteinCanvas.compute_xaxis`(…)	computes and returns various elements necessary for adding the x-axis to the canvas
`LSteinCanvas.compute_ylabel`(…)	computes and returns coordinates of for positioning the ylabel
`LSteinCanvas.get_panel`(…)	returns a panel associated with theta
`LSteinCanvas.get_thetas`(…)	returns theta of all currently added panels
`LSteinCanvas.plot`(…)	adds all series defined in theta, X, Y to respective panels for plotting
`LSteinCanvas.reset`()	resets all plotting-related flags in LSteinCanvas

`LSteinPanel`	represents a single panel in the LSteinCanvas
`LSteinPanel.__init__`	constructor
`LSteinPanel.apply_axis_limits`	returns x, y and **kwargs after application of axis limits
`LSteinPanel.get_rbounds`	returns panel bounds in radial direction
`LSteinPanel.get_thetabounds`	returns panel location and bounds as angles in radians
`LSteinPanel.get_yticks`	returns yticklabels and location of yticks
`LSteinPanel.plot`	attaches a dataseries to plot to the panel
`LSteinPanel.project_xy`	returns x and y after projection into the panel
`LSteinPanel.project_xy_theta`	returns x and y after projection into the panel
`LSteinPanel.project_xy_y`	returns x and y after projection into the panel

`LSteinMPL`	represents matplotlib backend for plotting LStein
`LSteinMPL.__init__`	constructor
`LSteinMPL.add_thetaaxis`	adds theta-axis to ax
`LSteinMPL.add_xaxis`	adds x-axis to ax
`LSteinMPL.add_yaxis`	adds y-axis of LSP to ax
`LSteinMPL.add_ylabel`	adds y-label to ax
`LSteinMPL.show`	display LStein plot in ax

`LSteinPlotly`	represents plotly backend for plotting LStein
`LSteinPlotly.__init__`	constructor
`LSteinPlotly.add_thetaaxis`	adds theta-axis to fig
`LSteinPlotly.add_xaxis`	adds x-axis to fig
`LSteinPlotly.add_yaxis`	adds y-axis of LSP to fig
`LSteinPlotly.add_ylabel`	adds y-label to fig
`LSteinPlotly.show`	display LStein plot in fig
`LSteinPlotly.translate_kwargs`	translates kwargs from matplotlib to plotly names

`utils.cart2polar`	converts cartesian coordinates to polar coordinates
`utils.correct_labelrotation`	corrects label-rotation to always be readable
`utils.get_colors`	returns array of colors mapping x onto cmap
`utils.minmaxscale`	applies min-max-scaling to x
`utils.polar2cart`	converts polar coordinates to cartesian coordinates