Material

class kgpy.optics.materials.Material(plot_kwargs=<factory>, name='')

Bases: Plottable, Broadcastable, Copyable, ABC

Parameters:
__init__(plot_kwargs=<factory>, name='')
Parameters:
Return type:

None

Attributes

broadcasted

name

shape

plot_kwargs

Methods

__init__([plot_kwargs, name])

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 inheritancea766639e42 { 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)"]; }
copy()
Return type:

typing.TypeVar(CopyableT, bound= Copyable)

Parameters:

self (CopyableT) –

copy_shallow()
Return type:

typing.TypeVar(CopyableT, bound= Copyable)

Parameters:

self (CopyableT) –

abstract index_refraction(ray)
Return type:

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

Parameters:
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 (MaterialT) –

  • ax (Axes) –

  • component_x (str) –

  • component_y (str) –

  • component_z (str | None) –

  • transform_extra (AbstractTransform | None) –

  • sag (Sag | None) –

  • aperture (Aperture | None) –

  • kwargs (Any) –

transmissivity(ray)
Return type:

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

Parameters:
property broadcasted
name: str = ''
plot_kwargs: typing.Dict[str, typing.Any]
property shape