Layer

class kgpy.optics.materials.Layer(material=None, thickness=None, num_periods=1)

Bases: Copyable

Parameters:

  • material (Array | None) –

  • thickness (Array | None) –

  • num_periods (int) –

__init__(material=None, thickness=None, num_periods=1)
Parameters:

  • material (Array | None) –

  • thickness (Array | None) –

  • num_periods (int) –

Return type:

None

Attributes

material

num_periods

thickness

Methods

__init__([material, thickness, num_periods])

copy()

rtype:

typing.TypeVar(CopyableT, bound= Copyable)

copy_shallow()

rtype:

typing.TypeVar(CopyableT, bound= Copyable)

plot(ax, z, layer_material_color, ...)

rtype:

astropy.units.quantity.Quantity

Inheritance Diagram

digraph inheritancedaa2fe0c84 { 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.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.materials.Layer" [URL="kgpy.optics.materials.Layer.html#kgpy.optics.materials.Layer",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="Layer(material: Optional[kgpy.labeled.Array] = None, thickness: Optional[kgpy.labeled.Array] = None, num_periods: int = 1)"]; "kgpy.mixin.Copyable" -> "kgpy.optics.materials.Layer" [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) –

plot(ax, z, layer_material_color, layer_label_x, layer_label_x_text)
Return type:

astropy.units.quantity.Quantity

Parameters:
material: typing.Optional[kgpy.labeled.Array] = None
num_periods: int = 1
thickness: typing.Optional[kgpy.labeled.Array] = None