Circular

class kgpy.optics.surface.aperture.Circular(is_obscuration=False, plot_kwargs=<factory>, decenter=<factory>, num_samples=1000, radius=<Quantity 0. mm>)

Bases: Aperture, Decenterable, Obscurable

Parameters

• is_obscuration (bool) –

• plot_kwargs (Dict[str, Any]) –

• decenter (Translate) –

• num_samples (int) –

• radius (Quantity) –

__init__(is_obscuration=False, plot_kwargs=<factory>, decenter=<factory>, num_samples=1000, radius=<Quantity 0. mm>)

Parameters

• is_obscuration (bool) –

• plot_kwargs (Dict[str, Any]) –

• decenter (Translate) –

• num_samples (int) –

• radius (Quantity) –

Return type

None

Attributes

broadcasted
is_obscuration
max
min
num_samples
radius
shape
wire

Methods

__init__([is_obscuration, plot_kwargs, ...])
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
is_unvignetted(points[, num_extra_dims])	rtype numpy.ndarray
plot(ax[, components, component_z, ...])	rtype typing.List[matplotlib.lines.Line2D]
write_to_dxf(file_writer, unit[, ...])	rtype None

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

is_unvignetted(points, num_extra_dims=0)

Return type

numpy.ndarray

Parameters

• points (Vector2D) –

• num_extra_dims (int) –

plot(ax, components=('x', 'y'), component_z=None, plot_kwargs=None, transform_extra=None, sag=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[Sag]) –

write_to_dxf(file_writer, unit, transform_extra=None, sag=None)

Return type

None

Parameters

• self (ApertureT) –

• file_writer (R12FastStreamWriter) –

• unit (Unit) –

• transform_extra (Optional[Transform]) –

• sag (Optional[Sag]) –

property broadcasted

decenter: kgpy.transform.rigid.Translate

is_obscuration: bool = False

property max: Vector3D

property min: Vector3D

num_samples: int = 1000

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

radius: astropy.units.Quantity = <Quantity 0. mm>

property shape

property wire: Vector3D