Rulings

class kgpy.optics.surface.rulings.Rulings

Bases: Broadcastable, Copyable, ABC

__init__()

Attributes

broadcasted
shape

Methods

__init__()
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
effective_input_direction(input_vector)
effective_input_index(input_vector)
effective_input_vector(rays[, material])	rtype kgpy.vector.Vector3D
normal(x, y[, num_extra_dims])

Inheritance Diagram

copy()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

copy_shallow()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

classmethod effective_input_direction(input_vector)

Parameters

input_vector (Vector3D) –

classmethod effective_input_index(input_vector)

Parameters

input_vector (Vector3D) –

abstract effective_input_vector(rays, material=None)

Return type

kgpy.vector.Vector3D

Parameters

• rays (Rays) –

• material (Optional[Material]) –

abstract normal(x, y, num_extra_dims=0)

Parameters

• x (Quantity) –

• y (Quantity) –

• num_extra_dims (int) –

property broadcasted

property shape