Axis

class kgpy.optics.rays.Axis

Bases: AutoAxis

__init__()

Attributes

field_xy
latex_names
ndim
ndim_field
ndim_pupil
pupil_xy
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 inheritance84ea01a387 { 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"]; "kgpy.optics.rays.Axis" [URL="kgpy.optics.rays.Axis.html#kgpy.optics.rays.Axis",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"]; "kgpy.mixin.AutoAxis" -> "kgpy.optics.rays.Axis" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

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 field_xy: Tuple[int, int]

property latex_names: List[str]

property ndim: int

ndim_field: typing.ClassVar[int] = 2

ndim_pupil: typing.ClassVar[int] = 2

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

property pupil_xy: Tuple[int, int]