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

Inheritance diagram of kgpy.mixin.AutoAxis

auto_axis_index(from_right=True)
Return type

int

Parameters

from_right (bool) –

perp_axes(axis)
Return type

typing.Tuple[int, ...]

Parameters

axis (Union[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