roman-snpit-snappl 0.9.1__tar.gz → 0.10.0__tar.gz

{roman_snpit_snappl-0.9.1/roman_snpit_snappl.egg-info → roman_snpit_snappl-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: roman_snpit_snappl
-Version: 0.9.1
+Version: 0.10.0
 Summary: Photometry utilities for the Roman SNPIT
 Author: Roman Supernova Project Infrastructure Team
 Maintainer-email: Roman SN PIT <raknop@lbl.gov>

roman_snpit_snappl-0.10.0/changes/57.snappl.rst

@@ -0,0 +1 @@
+Small imagecollection bugfixes.

roman_snpit_snappl-0.10.0/changes/58.snappl.rst

@@ -0,0 +1 @@
+Allow for kwargs to be passed to get_ra_dec_cutout in snappl.image.Image

{roman_snpit_snappl-0.9.1 → roman_snpit_snappl-0.10.0/roman_snpit_snappl.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: roman_snpit_snappl
-Version: 0.9.1
+Version: 0.10.0
 Summary: Photometry utilities for the Roman SNPIT
 Author: Roman Supernova Project Infrastructure Team
 Maintainer-email: Roman SN PIT <raknop@lbl.gov>

{roman_snpit_snappl-0.9.1 → roman_snpit_snappl-0.10.0}/roman_snpit_snappl.egg-info/SOURCES.txt

@@ -46,6 +46,8 @@ changes/47.feature.rst
 changes/49.docs.rst
 changes/5.snappl.rst
 changes/54.snappl.rst
+changes/57.snappl.rst
+changes/58.snappl.rst
 changes/8.snappl.rst
 changes/9.snappl.rst
 docs/Makefile

{roman_snpit_snappl-0.9.1 → roman_snpit_snappl-0.10.0}/snappl/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.9.1'
-__version_tuple__ = version_tuple = (0, 9, 1)
+__version__ = version = '0.10.0'
+__version_tuple__ = version_tuple = (0, 10, 0)
 
-__commit_id__ = commit_id = 'g1b1e672b9'
+__commit_id__ = commit_id = 'g4b7a8be4a'

{roman_snpit_snappl-0.9.1 → roman_snpit_snappl-0.10.0}/snappl/image.py

@@ -207,6 +207,12 @@ class Image:
         """MJD of the start of the image (defined how? TAI?)"""
         raise NotImplementedError( f"{self.__class__.__name__} needs to implement mjd" )
 
+    @mjd.setter
+    def mjd( self, val ):
+        # We need an MJD setter so that ImageCollection can set the MJD when fetching the images, much faster than
+        # reading the header each time!
+        self._mjd = val
+
     @property
     def position_angle( self ):
         """Position angle in degrees east of north (or what)?"""
@@ -282,13 +288,64 @@ class Image:
         """Set self._zeropoint; see "zeropoint" property above."""
         raise NotImplementedError( f"{self.__class__.__name__} needs to implement _get_zeropoint" )
 
-    def get_cutout(self, ra, dec, size):
+    def get_ra_dec_cutout(self, ra, dec, xsize, ysize=None, mode="strict", fill_value=np.nan):
+        """Creates a new snappl image object that is a cutout of the original image, at a location in pixel-space.
+
+        Parameters
+        ----------
+        ra : float
+            RA coordinate of the center of the cutout, in degrees.
+        dec : float
+            DEC coordinate of the center of the cutout, in degrees.
+        xsize : int
+            Width of the cutout in pixels.
+        ysize : int
+            Height of the cutout in pixels. If None, set to xsize.
+        mode : str, default 'strict'
+            "strict" does not allow for partial overlap between the cutout and the original image,
+            "partial" will fill in non-overlapping pixels with fill_value. This is identical to the
+            mode parameter of astropy.nddata.Cutout2D.
+        fill_value : float, default np.nan
+            Fill value for pixels that are outside the original
+            image when mode='partial'. This is identical to the fill_value parameter
+            of astropy.nddata.Cutout2D.
+
+        Returns
+        -------
+        cutout : snappl.image.Image
+            A new snappl image object that is a cutout of the original image.
+        """
+        raise NotImplementedError( f"{self.__class__.__name__} needs to implement get_ra_dec_cutout" )
+
+    def get_cutout(self, ra, dec, xsize, ysize=None, mode='strict', fill_value=np.nan):
 
         """Make a cutout of the image at the given RA and DEC.
+        This implementation assumes that the image WCS is an AstropyWCS.
+
+        Parameters
+        ----------
+        x : int
+            x pixel coordinate of the center of the cutout.
+        y : int
+            y pixel coordinate of the center of the cutout.
+        xsize : int
+            Width of the cutout in pixels.
+        ysize : int
+            Height of the cutout in pixels. If None, set to xsize.
+        mode : str, default 'strict'
+            "strict" does not allow for partial overlap between the cutout and the original image,
+            "partial" will fill in non-overlapping pixels with fill_value. This is identical to the
+            mode parameter of astropy.nddata.Cutout2D.
+        fill_value : float, default np.nan
+            Fill value for pixels that are outside the original
+            image when mode='partial'. This is identical to the fill_value parameter
+            of astropy.nddata.Cutout2D.
 
         Returns
         -------
-          snappl.image.Image
+        cutout : snappl.image.Image
+            A new snappl image object that is a cutout of the original image.
+
         """
         raise NotImplementedError( f"{self.__class__.__name__} needs to implement get_cutout" )
 
@@ -594,27 +651,10 @@ class FITSImage( Numpy2DImage ):
             else:
                 raise RuntimeError("get_data called with which='flags', but flags are not set.")
 
-    def get_cutout(self, x, y, xsize, ysize=None):
-        """Creates a new snappl image object that is a cutout of the original image, at a location in pixel-space.
-
-        This implementation (in FITSImage) assumes that the image WCS is an AstropyWCS.
-
-        Parameters
-        ----------
-        x : int
-            x pixel coordinate of the center of the cutout.
-        y : int
-            y pixel coordinate of the center of the cutout.
-        xsize : int
-            Width of the cutout in pixels.
-        ysize : int
-            Height of the cutout in pixels. If None, set to xsize.
-
-        Returns
-        -------
-        cutout : snappl.image.Image
-            A new snappl image object that is a cutout of the original image.
+    def get_cutout(self, x, y, xsize, ysize=None, mode='strict', fill_value=np.nan):
+        """See Image.get_cutout
 
+        The mode and fill_value parameters are passed directly to astropy.nddata.Cutout2D for FITSImage.
         """
         if not all( [ isinstance( x, (int, np.integer) ),
                       isinstance( y, (int, np.integer) ),
@@ -638,9 +678,13 @@ class FITSImage( Numpy2DImage ):
         apwcs = None if wcs is None else wcs._wcs
 
         # Remember that numpy arrays are indexed [y, x] (at least if they're read with astropy.io.fits)
-        astropy_cutout = Cutout2D(data, (x, y), size=(ysize, xsize), mode='strict', wcs=apwcs)
-        astropy_noise = Cutout2D(noise, (x, y), size=(ysize, xsize), mode='strict', wcs=apwcs)
-        astropy_flags = Cutout2D(flags, (x, y), size=(ysize, xsize), mode='strict', wcs=apwcs)
+
+        astropy_cutout = Cutout2D(data, (x, y), size=(ysize, xsize), wcs=apwcs, mode=mode, fill_value=fill_value)
+        astropy_noise = Cutout2D(noise, (x, y), size=(ysize, xsize), wcs=apwcs, mode=mode, fill_value=fill_value)
+        # Because flags are integer, we can't use the same fill_value as the default.
+        # Per the slack channel, it seemed 1 will be used for bad pixels.
+        # https://github.com/spacetelescope/roman_datamodels/blob/main/src/roman_datamodels/dqflags.py
+        astropy_flags = Cutout2D(flags, (x, y), size=(ysize, xsize), wcs=apwcs, mode=mode, fill_value=1)
 
         snappl_cutout = self.__class__(self.path)
         snappl_cutout._data = astropy_cutout.data
@@ -651,31 +695,17 @@ class FITSImage( Numpy2DImage ):
 
         return snappl_cutout
 
-    def get_ra_dec_cutout(self, ra, dec, xsize, ysize=None):
-        """Creates a new snappl image object that is a cutout of the original image, at a location in pixel-space.
+    def get_ra_dec_cutout(self, ra, dec, xsize, ysize=None, mode='strict', fill_value=np.nan):
+        """See Image.get_ra_dec_cutout
 
-        Parameters
-        ----------
-        ra : float
-            RA coordinate of the center of the cutout, in degrees.
-        dec : float
-            DEC coordinate of the center of the cutout, in degrees.
-        xsize : int
-            Width of the cutout in pixels.
-        ysize : int
-            Height of the cutout in pixels. If None, set to xsize.
-
-        Returns
-        -------
-        cutout : snappl.image.Image
-            A new snappl image object that is a cutout of the original image.
+        The mode and fill_value parameters are passed directly to astropy.nddata.Cutout2D for FITSImage.
         """
 
         wcs = self.get_wcs()
         x, y = wcs.world_to_pixel( ra, dec )
         x = int( np.floor( x + 0.5 ) )
         y = int( np.floor( y + 0.5 ) )
-        return self.get_cutout( x, y, xsize, ysize )
+        return self.get_cutout( x, y, xsize, ysize, mode=mode, fill_value=fill_value )
 
 
 # ======================================================================
@@ -686,7 +716,7 @@ class FITSImage( Numpy2DImage ):
 
 class ManualFITSImage(FITSImage):
     def __init__(self, header, data=None, noise=None, flags=None,
-                 path = None, exposure = None, sca = None, *args, **kwargs):
+                 path=None, exposure=None, sca=None, *args, **kwargs):
 
         self._data = data
         self._noise = noise
@@ -919,8 +949,18 @@ class OpenUniverse2024FITSImage( FITSImageOnDisk ):
         TODO : is this start-time, mid-time, or end-time?
 
         """
-        header = self.get_fits_header()
-        return float( header['MJD-OBS'] )
+        if self._mjd is None:
+            header = self.get_fits_header()
+            self.mjd =  float( header['MJD-OBS'] )
+        return self._mjd
+
+    @mjd.setter
+    def mjd( self, val ):
+        # We need an MJD setter so that ImageCollection can set the MJD when fetching the images, much faster than
+        # reading the header each time!
+        self._mjd = val
+
+
 
     @property
     def exptime( self ):

{roman_snpit_snappl-0.9.1 → roman_snpit_snappl-0.10.0}/snappl/imagecollection.py

@@ -240,12 +240,15 @@ class ImageCollectionOU2024:
         if exptime_max is not None:
             params['exptime_max'] = float(exptime_max)
 
-        res = retry_post( "https://roman-desc-simdex.lbl.gov/findromanimages", json=params )
+        res = retry_post( "https://roman-desc-simdex.lbl.gov/findromanimages", json=params ).json()
 
         images = []
         for i in range( len(res['pointing']) ):
             path = self.get_image_path( res['pointing'][i], res['filter'][i], res['sca'][i] )
-            images.append( OpenUniverse2024FITSImage( path, None, res['sca'][i] ) )
+            image = OpenUniverse2024FITSImage(path, None, res["sca"][i])
+            image.mjd = res['mjd'][i]
+            images.append( image )
+
 
         return images