Material

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

Bases: Plottable, Broadcastable, Copyable, ABC

Parameters

• plot_kwargs (Dict[str, Any]) –

• name (str) –

__init__(plot_kwargs=<factory>, name='')

Parameters

• plot_kwargs (Dict[str, Any]) –

• name (str) –

Return type

None

Attributes

broadcasted
name
shape

Methods

__init__([plot_kwargs, name])
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
index_of_refraction(rays)	rtype astropy.units.Quantity
plot(ax[, components, component_z, ...])	rtype typing.List[matplotlib.lines.Line2D]
transmissivity(rays)	rtype astropy.units.Quantity

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) –

abstract index_of_refraction(rays)

Return type

astropy.units.Quantity

Parameters

rays (Rays) –

plot(ax, components=('x', 'y'), component_z=None, plot_kwargs=None, transform_extra=None, sag=None, aperture=None)

Return type

typing.List[matplotlib.lines.Line2D]

Parameters

• ax (Axes) –

• components (Tuple[str, str]) –

• component_z (Optional[str]) –

• plot_kwargs (Optional[Dict[str, Any]]) –

• transform_extra (Optional[TransformList]) –

• sag (Optional[Callable[[Quantity, Quantity], Quantity]]) –

• aperture (Optional[Aperture]) –

transmissivity(rays)

Return type

astropy.units.Quantity

Parameters

rays (Rays) –

property broadcasted

name: str = ''

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

property shape