Source code for astrophot.image.model_image

from .image_object import Image, ImageList, ImageBatchMixin
from ..errors import InvalidImage
from ..utils.decorators import combine_docstrings

__all__ = ["ModelImage", "ModelImageList"]


######################################################################


@combine_docstrings
class ModelImage(Image):
    """Image object which represents the sampling of a model at the given
    coordinates of the image. Extra arithmetic operations are
    available which can update model values in the image. The whole
    model can be shifted by less than a pixel to account for sub-pixel
    accuracy.

    """



######################################################################


@combine_docstrings
class ModelImageList(ImageList):
    """A list of ModelImage objects."""

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        if not all(isinstance(image, (ModelImage, ModelImageList)) for image in self.images):
            raise InvalidImage(
                f"Model_Image_List can only hold Model_Image objects, not {tuple(type(image) for image in self.images)}"
            )





@combine_docstrings
class ModelImageBatch(ImageBatchMixin, ModelImageList):
    pass