scopesim.effects.illumination.gaussian2d

Contents

scopesim.effects.illumination.gaussian2d#

scopesim.effects.illumination.gaussian2d(shape: tuple[int, int], amp: float = 1.0, mu: tuple[float, float] = (0.0, 0.0), sigma: tuple[float, float] = (2000.0, 2000.0), theta: ~astropy.units.quantity.Annotated[~astropy.units.quantity.Quantity, Unit("deg")] | float = <Quantity 0. deg>) → ndarray#

2D elliptical Gaussian to be used for vignetting map.

Added in version 0.11.3.

Parameters:

  • shape (tuple[int, int]) – Image shape in pixels (ny, nx).

  • amp (float, optional) – Peak throughput. The default is 1.0.

  • mu (tuple[float, float], optional) – Offset of the peak center in pixels (x, y) from the image center. The default is (0.0, 0.0), i.e. no offset.

  • sigma (tuple[float, float], optional) – Gaussian widths in pixels (sx, sy). The default is (2000.0, 2000.0).

  • theta (float, optional) – Rotation angle (if float, the angle is interpreted in degrees), counterclockwise. The default is 0°.

Returns:

Vignetting map.

Return type:

np.ndarray

Contents