Toroidal

class kgpy.optics.sags.Toroidal(radius=<Quantity inf mm>, conic=<Quantity 0.>, radius_of_rotation=<Quantity 0. mm>)

Bases: Standard

Parameters:
__init__(radius=<Quantity inf mm>, conic=<Quantity 0.>, radius_of_rotation=<Quantity 0. mm>)
Parameters:
Return type:

None

Attributes

broadcasted

conic

curvature

radius

radius_of_rotation

shape

Methods

__init__([radius, conic, radius_of_rotation])

copy()

rtype:

typing.TypeVar(CopyableT, bound= Copyable)

copy_shallow()

rtype:

typing.TypeVar(CopyableT, bound= Copyable)

normal(position)

rtype:

kgpy.vectors.Cartesian3D

Inheritance Diagram

digraph inheritanced31d4ad62f { 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.sags.Sag" [URL="kgpy.optics.sags.Sag.html#kgpy.optics.sags.Sag",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="Sag()"]; "kgpy.mixin.Broadcastable" -> "kgpy.optics.sags.Sag" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Copyable" -> "kgpy.optics.sags.Sag" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.ABC" -> "kgpy.optics.sags.Sag" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.optics.sags.Standard" [URL="kgpy.optics.sags.Standard.html#kgpy.optics.sags.Standard",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="Standard(radius: Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray] = <Quantity inf mm>, conic: Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray] = <Quantity 0.>)"]; "kgpy.optics.sags.Sag" -> "kgpy.optics.sags.Standard" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.optics.sags.Toroidal" [URL="kgpy.optics.sags.Toroidal.html#kgpy.optics.sags.Toroidal",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="Toroidal(radius: Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray] = <Quantity inf mm>, conic: Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray] = <Quantity 0.>, radius_of_rotation: Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray] = <Quantity 0. mm>)"]; "kgpy.optics.sags.Standard" -> "kgpy.optics.sags.Toroidal" [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) –

normal(position)
Return type:

kgpy.vectors.Cartesian3D

Parameters:
property broadcasted
conic: typing.Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray] = <Quantity 0.>
property curvature: int | float | ndarray | Quantity | AbstractArray | AbstractArray
radius: typing.Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray] = <Quantity inf mm>
radius_of_rotation: typing.Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray] = <Quantity 0. mm>
property shape