Breadboard

class kgpy.optics.breadboards.Breadboard(plot_kwargs=<factory>, transform=<factory>, color='gray', length=<Quantity 0. mm>, width=<Quantity 0. mm>, thickness=<Quantity 0. mm>)

Bases: Transformable, Plottable

Parameters:

• plot_kwargs (Dict[str, Any]) –

• transform (TransformList) –

• color (str) –

• length (Quantity) –

• width (Quantity) –

• thickness (Quantity) –

__init__(plot_kwargs=<factory>, transform=<factory>, color='gray', length=<Quantity 0. mm>, width=<Quantity 0. mm>, thickness=<Quantity 0. mm>)

Parameters:

• plot_kwargs (Dict[str, Any]) –

• transform (TransformList) –

• color (str) –

• length (Quantity) –

• width (Quantity) –

• thickness (Quantity) –

Return type:

None

Attributes

color
length
thickness
width
transform
plot_kwargs

Methods

__init__([plot_kwargs, transform, color, ...])
copy()	rtype: typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype: typing.TypeVar(CopyableT, bound= Copyable)
plot(ax[, component_x, component_y, ...])

Inheritance Diagram

digraph inheritance4c5c8a1215 { 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.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.breadboards.Breadboard" [URL="kgpy.optics.breadboards.Breadboard.html#kgpy.optics.breadboards.Breadboard",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="Breadboard(plot_kwargs: Dict[str, Any] = <factory>, transform: kgpy.transforms.TransformList = <factory>, color: str = 'gray', length: astropy.units.quantity.Quantity = <Quantity 0. mm>, width: astropy.units.quantity.Quantity = <Quantity 0. mm>, thickness: astropy.units.quantity.Quantity = <Quantity 0. mm>)"]; "kgpy.transforms.Transformable" -> "kgpy.optics.breadboards.Breadboard" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Plottable" -> "kgpy.optics.breadboards.Breadboard" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.transforms.Transformable" [URL="kgpy.transforms.Transformable.html#kgpy.transforms.Transformable",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="Transformable(transform: kgpy.transforms.TransformList = <factory>)"]; }

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, component_x='x', component_y='y', component_z='z', components=('x', 'y'), transform_extra=None, to_global=False, **kwargs)

Parameters:

• ax (Axes) –

• component_x (str) –

• component_y (str) –

• component_z (str) –

• components (Tuple[str, str]) –

• transform_extra (TransformList | None) –

• to_global (bool) –

color: str = 'gray'

length: astropy.units.quantity.Quantity = <Quantity 0. mm>

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

thickness: astropy.units.quantity.Quantity = <Quantity 0. mm>

transform: TransformList

width: astropy.units.quantity.Quantity = <Quantity 0. mm>