Mirror

class kgpy.optics.materials.Mirror(plot_kwargs=<factory>, name='mirror', thickness=None)

Bases: Material

Parameters:

• plot_kwargs (Dict[str, Any]) –

• name (str) –

• thickness (int | float | ndarray | Quantity | AbstractArray | AbstractArray | None) –

__init__(plot_kwargs=<factory>, name='mirror', thickness=None)

Parameters:

• plot_kwargs (Dict[str, Any]) –

• name (str) –

• thickness (int | float | ndarray | Quantity | AbstractArray | AbstractArray | None) –

Return type:

None

Attributes

broadcasted
name
shape
thickness
plot_kwargs

Methods

__init__([plot_kwargs, name, thickness])
copy()	rtype: typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype: typing.TypeVar(CopyableT, bound= Copyable)
index_refraction(ray)	rtype: typing.Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray]
plot(ax[, component_x, component_y, ...])	rtype: typing.List[matplotlib.lines.Line2D]
transmissivity(ray)	rtype: typing.Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray]

Inheritance Diagram

digraph inheritance885afb4fc0 { 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.mixin.Plottable" [URL="kgpy.mixin.Plottable.html#kgpy.mixin.Plottable",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="Plottable(plot_kwargs: Dict[str, Any] = <factory>)"]; "kgpy.mixin.Copyable" -> "kgpy.mixin.Plottable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.ABC" -> "kgpy.mixin.Plottable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.optics.materials.Material" [URL="kgpy.optics.materials.Material.html#kgpy.optics.materials.Material",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="Material(plot_kwargs: Dict[str, Any] = <factory>, name: str = '')"]; "kgpy.mixin.Plottable" -> "kgpy.optics.materials.Material" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Broadcastable" -> "kgpy.optics.materials.Material" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Copyable" -> "kgpy.optics.materials.Material" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.ABC" -> "kgpy.optics.materials.Material" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.optics.materials.Mirror" [URL="kgpy.optics.materials.Mirror.html#kgpy.optics.materials.Mirror",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="Mirror(plot_kwargs: Dict[str, Any] = <factory>, name: str = 'mirror', thickness: Union[int, float, numpy.ndarray, astropy.units.quantity.Quantity, kgpy.labeled.AbstractArray, kgpy.uncertainty.AbstractArray, NoneType] = None)"]; "kgpy.optics.materials.Material" -> "kgpy.optics.materials.Mirror" [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) –

index_refraction(ray)

Return type:

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

Parameters:

• self (MirrorT) –

• ray (RayVector) –

plot(ax, component_x='x', component_y='y', component_z=None, transform_extra=None, sag=None, aperture=None, **kwargs)

Return type:

typing.List[matplotlib.lines.Line2D]

Parameters:

• self (MirrorT) –

• ax (Axes) –

• component_x (str) –

• component_y (str) –

• component_z (str | None) –

• transform_extra (TransformList | None) –

• sag (Sag | None) –

• aperture (Aperture | None) –

transmissivity(ray)

Return type:

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

Parameters:

• self (MaterialT) –

• ray (RayVector) –

property broadcasted

name: str = 'mirror'

plot_kwargs: typing.Dict[str, typing.Any]

property shape

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