AutoAxis

class kgpy.mixin.AutoAxis

Bases: object

Semi-automated axis numbering

abstract __init__()

Attributes

ndim

num_left_dim

Number of dimensions on the left side of the array.

num_right_dim

Number of dimensions on the right side of the array

all

List of indices for each axis.

Methods

__init__()

auto_axis_index([from_right])

rtype:

int

perp_axes(axis)

rtype:

typing.Tuple[int, ...]

Inheritance Diagram

digraph inheritance913d99e6da { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "kgpy.mixin.AutoAxis" [URL="kgpy.mixin.AutoAxis.html#kgpy.mixin.AutoAxis",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Semi-automated axis numbering"]; }
auto_axis_index(from_right=True)
Return type:

int

Parameters:

from_right (bool) –

perp_axes(axis)
Return type:

typing.Tuple[int, ...]

Parameters:

axis (int | Sequence[int]) –

all

List of indices for each axis.

property ndim: int
num_left_dim

Number of dimensions on the left side of the array.

num_right_dim

Number of dimensions on the right side of the array