Baffle

class kgpy.optics.baffle.Baffle(name=<factory>, transform=<factory>, plot_kwargs=<factory>, apertures_base=<factory>, apertures_extra=<factory>, obscuration_base=None, margin=<Quantity 1. mm>, min_distance=<Quantity 2. mm>, combined_axes=None, shapely_unit=Unit("mm"), buffer_cap_style=BufferCapStyle.square, buffer_join_style=BufferJoinStyle.mitre)

Bases: Broadcastable, Plottable, Transformable, Named, Generic[ObscurationT]

__init__(name=<factory>, transform=<factory>, plot_kwargs=<factory>, apertures_base=<factory>, apertures_extra=<factory>, obscuration_base=None, margin=<Quantity 1. mm>, min_distance=<Quantity 2. mm>, combined_axes=None, shapely_unit=Unit("mm"), buffer_cap_style=BufferCapStyle.square, buffer_join_style=BufferJoinStyle.mitre)

Parameters

• name (Name) –

• transform (TransformList) –

• plot_kwargs (Dict[str, Any]) –

• apertures_base (List[IrregularPolygon]) –

• apertures_extra (List[Aperture]) –

• obscuration_base (Optional[ObscurationT]) –

• margin (Quantity) –

• min_distance (Quantity) –

• combined_axes (Optional[Sequence[int]]) –

• shapely_unit (Unit) –

• buffer_cap_style (int) –

• buffer_join_style (int) –

Return type

None

Attributes

apertures
broadcasted
buffer_cap_style
buffer_join_style
buffer_resolution
combined_axes
dataframe
interiors
margin
min_distance
obscuration
obscuration_base
shape
shapely_unit
tol_iter
apertures_base
apertures_extra

Methods

__init__([name, transform, plot_kwargs, ...])
concat_apertures(apertures)	rtype kgpy.optics.baffle.Baffle
concat_apertures_from_global_positions(...)
concat_apertures_from_intercept(intercept, mask)	rtype kgpy.optics.baffle.Baffle
concat_apertures_from_lofts(lofts[, ...])	rtype kgpy.optics.baffle.Baffle
concat_apertures_from_raytrace(raytrace[, ...])	rtype kgpy.optics.baffle.Baffle
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
plot([ax, components, plot_kwargs, ...])	rtype matplotlib.axes.Axes
to_dxf(filename[, dxf_unit])
unary_union(other)

Inheritance Diagram

concat_apertures(apertures)

Return type

kgpy.optics.baffle.Baffle

Parameters

apertures (List[IrregularPolygon]) –

concat_apertures_from_global_positions(position_1, position_2, mask=None, hull_axes=None, color='black')

Parameters

• position_1 (Vector3D) –

• position_2 (Vector3D) –

• mask (Optional) –

• hull_axes (Optional[Sequence[int]]) –

• color (str) –

Return type

Baffle

concat_apertures_from_intercept(intercept, mask, hull_axes=None, color='black')

Return type

kgpy.optics.baffle.Baffle

Parameters

• intercept (Vector3D) –

• mask (Quantity) –

• hull_axes (Optional[Sequence[int]]) –

• color (str) –

concat_apertures_from_lofts(lofts, transform_extra=None, color='black')

Return type

kgpy.optics.baffle.Baffle

Parameters

• lofts (Dict[int, Tuple[Surface, Surface]]) –

• transform_extra (Optional[TransformList]) –

• color (str) –

concat_apertures_from_raytrace(raytrace, transform_extra=None, hull_axes=None, color='black')

Return type

kgpy.optics.baffle.Baffle

Parameters

• raytrace (RaysList) –

• transform_extra (Optional[TransformList]) –

• hull_axes (Optional[Sequence[int]]) –

• color (str) –

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=None, components=('x', 'y'), plot_kwargs=None, transform_extra=None, to_global=False, plot_apertures_base=False)

Return type

matplotlib.axes.Axes

Parameters

• ax (Optional[Axes]) –

• components (Tuple[str, str]) –

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

• transform_extra (Optional[TransformList]) –

• to_global (bool) –

• plot_apertures_base (bool) –

to_dxf(filename, dxf_unit=Unit('inch'))

Parameters

• filename (Path) –

• dxf_unit (Unit) –

unary_union(other)

Parameters

other (Baffle) –

property apertures

apertures_base: typing.List[kgpy.optics.surface.aperture.IrregularPolygon]

apertures_extra: typing.List[kgpy.optics.surface.aperture.Aperture]

property broadcasted

buffer_cap_style: int = 3

buffer_join_style: int = 2

buffer_resolution = 1

combined_axes: typing.Optional[typing.Sequence[int]] = None

property dataframe: DataFrame

property interiors: MultiPolygon

margin: astropy.units.Quantity = <Quantity 1. mm>

min_distance: astropy.units.Quantity = <Quantity 2. mm>

name: Name

property obscuration

obscuration_base: typing.Optional[typing.TypeVar(ObscurationT, bound= kgpy.optics.surface.aperture.Polygon)] = None

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

property shape

shapely_unit: astropy.units.core.Unit = Unit("mm")

property tol_iter: Iterator[Transformable]

transform: TransformList