keystone
- hcipy.mode_basis.keystone(n, m, inner_diameter, outer_diameter, angle_width, spider_width, keystone_angle=0, grid=None, cache=None)[source]
Evaluate a keystone mode on a grid.
- Parameters:
- nint
The radial keystone order.
- mint
The azimuthal keystone order.
- inner_diameterscalar
The inner diameter of the keystone aperture.
- outer_diameterscalar
The outer diameter of the keystone aperture.
- angle_widthscalar
The angular width of the keystone aperture in degrees.
- spider_widthscalar
The full width of the spiders bordering the keystone aperture.
- keystone_anglefloat
The angle of the keystone aperture in radians. At an angle of 0, the center of the keystone points to the right.
- gridGrid or None
The grid on which to evaluate the keystone mode. If this is None, a Field generator will be returned.
- cachedictionary or None
A dictionary of intermediate calculations for this exact grid, aperture geometry, and orientation. The dictionary is updated in place.
- Returns:
- Field or Field generator
The evaluated keystone mode. If grid is None, a Field generator is returned, which evaluates the keystone mode on the supplied grid.