Source code for scopesim.effects.shutter

# -*- coding: utf-8 -*-
"""Contains the Shutter effect."""

from . import Effect
from ..base_classes import ImagePlaneBase
from ..utils import get_logger


logger = get_logger(__name__)


class Shutter(Effect):
    """Simulate a closed shutter, useful for dark exposures."""

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.meta["z_order"] = [799]

    def apply_to(self, obj, **kwargs):
        """Set all pixels of image plane to zero."""
        if not isinstance(obj, ImagePlaneBase):
            return obj

        logger.warning("Shutter is closed, setting all pixels to zero.")
        obj.data[:] = 0.0
        return obj