Ruling

class kgpy.optics.rulings.Ruling

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)

rtype:

kgpy.vectors.Cartesian3D

effective_input_index(input_vector)

rtype:

typing.Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray]

effective_input_vector(ray[, material])

rtype:

kgpy.vectors.Cartesian3D

normal(position)

rtype:

kgpy.vectors.Cartesian3D

Inheritance Diagram

digraph inheritance44b124e222 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "abc.ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",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="Helper class that provides a standard way to create an ABC using"]; "kgpy.mixin.Broadcastable" [URL="kgpy.mixin.Broadcastable.html#kgpy.mixin.Broadcastable",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="Class to help with determining the shape of the optical configuration."]; "kgpy.mixin.Copyable" [URL="kgpy.mixin.Copyable.html#kgpy.mixin.Copyable",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"]; "abc.ABC" -> "kgpy.mixin.Copyable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.optics.rulings.Ruling" [URL="kgpy.optics.rulings.Ruling.html#kgpy.optics.rulings.Ruling",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.Broadcastable" -> "kgpy.optics.rulings.Ruling" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Copyable" -> "kgpy.optics.rulings.Ruling" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.ABC" -> "kgpy.optics.rulings.Ruling" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
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)
Return type:

kgpy.vectors.Cartesian3D

Parameters:

input_vector (Cartesian3D) –

classmethod effective_input_index(input_vector)
Return type:

typing.Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray]

Parameters:

input_vector (Cartesian3D) –

abstract effective_input_vector(ray, material=None)
Return type:

kgpy.vectors.Cartesian3D

Parameters:
abstract normal(position)
Return type:

kgpy.vectors.Cartesian3D

Parameters:
property broadcasted
property shape