HexagonFieldStop

class poppy.HexagonFieldStop(name=None, side=None, diameter=None, flattoflat=None, **kwargs)

Bases: AnalyticImagePlaneElement

Defines an ideal hexagonal field stop

Specify either the side length (= corner radius) or the flat-to-flat distance, or the point-to-point diameter, in angular units

Parameters:

namestring

Descriptive name

sidefloat, optional

side length (and/or radius) of hexagon, in arcsec. Overrides flattoflat if both are present.

flattoflatfloat, optional

Distance between sides (flat-to-flat) of the hexagon, in arcsec. Default is 1.0

diameterfloat, optional

point-to-point diameter of hexagon. Twice the side length. Overrides flattoflat, but is overridden by side.

Note you can also specify the standard parameter “rotation” to rotate the hexagon by some amount.

Attributes Summary

diameter
flat_to_flat

Methods Summary

get_transmission(wave)

Compute the transmission inside/outside of the occulter.

Attributes Documentation

diameter

flat_to_flat

Methods Documentation

get_transmission(wave)

Compute the transmission inside/outside of the occulter.