lstein.lstein.LSteinPanel.__init__

LSteinPanel.__init__(LSC, theta: float, yticks: Tuple[List[float], List[Any]], panelsize: float = 0.39269908169872414, show_panelbounds: bool = False, show_yticks: bool = True, y_projection_method: Literal['theta', 'y'] = 'theta', ytickkwargs: dict = None, yticklabelkwargs: dict = None, panelboundskwargs: dict = None)[source]

constructor

  • initializes class

  • computes inferred attributes

Parameters
  • LSC

    • LSteinCanvas

    • parent canvas the panel is associated with

  • theta

    • float

    • theta value the panel is associated with

    • equivalent to 2.5th dimension of the dataset

    • similar to pos in fig.add_subolot(pos)

    • determines where on LSC the panel will be located

      • created panel will be centered around theta with a width of panelsize

  • yticks

    Tuple[List[float],List[Any]] - ticks to draw for the y-axis - also defines axis limits applied to y

    • i.e., bounds of the respective panel

    • yticks[0][0] corresponds to the start of the panel

    • yticks[0][-1] corresponds to the end of the panel

    • yticks[0] will be used as tickpositions

    • yticks[1] will be used as ticklabels

    • yticks[0] has to be sorted in ascending or descending order

    • to invert the y-axis pass yticks[0] in a reverse sorted manner

  • panelsize

    • float, optional

    • (angular) space the created panel will occupy

    • in radians

    • the entire Canvas can allocate (thetaguidelims[1]-thetaguidelims[0])/panelsize evenly distributed, nonoverlapping panels

    • the default is np.pi/8

  • show_panelbounds

    • bool, optional

    • whether to show bounds of the individual panels when rendering

    • the default is False

  • show_yticks

    • bool, optional

    • whether to show ticks and gridlines for y-values

    • the default is True

  • y_projection_method

    • Literal[“theta”,”y”], optional

    • method to use for the projection

    • the default is theta

      • uses LSteinPanel.project_xy_theta()

  • ytickkwargs

    • dict, optional

    • kwargs to pass to ax.plot() when drawing yticks (lines in radial direction)

    • used for styling

    • the default is None

      • will be set to dict(c=plt.rcParams[“grid.color”], ls=plt.rcParams[“grid.linestyle”], lw=plt.rcParams[“grid.linewidth”])

  • yticklabelkwargs

    • dict, optional

    • kwargs to pass to ax.annotate() calls used for defining the ticklabels of the y-axis

    • used for styling

    • pad determines the padding w.r.t. the ticks

    • the default is None

      • will be set to dict(c=plt.rcParams[“axes.labelcolor”], ha=”center”, va=”center”, pad=0.1)

  • panelboundskwargs

    • dict, optional

    • kwargs to pass to ax.plot() when drawing bounds of each panel

    • used for styling

    • the default is None

      • will be set to dict(c=plt.rcParams[“axes.edgecolor”])

Raises

Returns