Source code for pdrtpy.tool.fitmap

import numpy as np
from astropy.nddata import NDData




class FitMap(NDData):
    def __init__(self, data, *args, **kwargs):
        """A class that can store fit objects in a data array but has all the nice WCS properties of NDData.

        Parameters
        ----------
        data : array-like
            The data set, an array of `lmfit.model.ModelResult` or `lmfit.minimizer.MinimizerResult`.
        name : str, optional
            An identifying name for this object.
        """
        debug = kwargs.pop("debug", False)
        if debug:
            print("args=", *args)
            print("kwargs=", *kwargs)
        self._name = kwargs.pop("name", None)

        # NDData wants a nddata array so give it a fake one
        # and sub our object array afterwards
        _data = np.zeros(data.shape)
        super().__init__(_data, *args, **kwargs)
        self._data = data
        if np.shape(self._data) == ():
            self._data = np.array([self._data])

    @property
    def name(self):
        """The name of this FitMap.

        Returns
        -------
        str
        """
        return self._name

    def __getitem__(self, i):
        """get the value object at array index i"""
        return self._data[i]



    def get_pixel(self, world_x, world_y):
        # @TODO: allow non-rounding. param round=T/F
        # @TODO: move to util? this method is copied from measurement.py
        """Return the nearest pixel coordinates to the input world coordinates x,y.

        The pixel values will be rounded to the nearest integer.

        Parameters
        ----------
        world_x : float
            The horizontal world coordinate.
        world_y : float
            The vertical world coordinate.
        """
        if self.wcs is None:
            raise Exception(f"No wcs in this FitMap {self.name}")
        return tuple(np.round(self.wcs.world_to_pixel_values(world_x, world_y)).astype(int))




    def get_pixel_from_coord(self, coord):
        """Return the nearest pixel coordinates to the input world coordinates.

        The pixel values will be rounded to the nearest integer.

        Parameters
        ----------
        coord : :class:`~astropy.coordinates.SkyCoord`
            The world coordinate.
        """
        if self.wcs is None:
            raise Exception(f"No wcs in this FitMap {self.name}")
        return tuple(np.round(self.wcs.world_to_pixel_values(coord)).astype(int))




    def get_world(self, x, y):
        """Return the world coordinates corresponding to the input pixel coordinates.

        Parameters
        ----------
        x : float
            The horizontal pixel coordinate.
        y : float
            The vertical pixel coordinate.
        """
        if self.wcs is None:
            raise Exception(f"No wcs in this FitMap {self.name}")
        return tuple(self.wcs.pixel_to_world_values([[x, y]])[0])




    def get_skycoord(self, x, y):
        """Return the Sky Coordinate corresponding to the input pixel coordinates.

        Parameters
        ----------
        x : float
            The horizontal pixel coordinate.
        y : float
            The vertical pixel coordinate.
        """
        return self.wcs.pixel_to_world([x], [y])