scopesim.effects.illumination.quadratic_vignetting

scopesim.effects.illumination.quadratic_vignetting#

scopesim.effects.illumination.quadratic_vignetting(shape: tuple[int, int], falloff: float = 0.01, r_ref: float | None = None, mu: tuple[float, float] = (0.0, 0.0), stretch: tuple[float, float, float, float] = (1.0, 1.0, 1.0, 1.0)) → ndarray#

Quadratic vignetting pattern with independent stretch factors.

Added in version 0.11.3.

Parameters:

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

  • falloff (float, optional) – Fractional illumination drop at r_ref. The default is 0.01 (= 1 %).

  • r_ref (float | None, optional) – Reference radius in stretched pixels. If None (the default), use the corner distance.

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

  • stretch (tuple[float, float, float, float], optional) – (+x, -x, +y, -y) independent scale factors for half-planes respectively. All 1.0 gives a circular pattern. A value > 1 widens the falloff in that direction (shallower); < 1 narrows it (steeper). The default is (1.0, 1.0, 1.0, 1.0).

Returns:

Vignetting map.

Return type:

np.ndarray

Contents