roman-snpit-snappl 0.3.0__tar.gz → 0.4.0__tar.gz

{roman_snpit_snappl-0.3.0/roman_snpit_snappl.egg-info → roman_snpit_snappl-0.4.0}/PKG-INFO

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

roman_snpit_snappl-0.4.0/changes/18.feature.rst

@@ -0,0 +1 @@
+Add a few properties (sca, zeropoint, etc.) to Image ; add ou2024PSF.

{roman_snpit_snappl-0.3.0 → roman_snpit_snappl-0.4.0/roman_snpit_snappl.egg-info}/PKG-INFO

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

{roman_snpit_snappl-0.3.0 → roman_snpit_snappl-0.4.0}/roman_snpit_snappl.egg-info/SOURCES.txt

@@ -29,6 +29,7 @@ changes/13.bugfix.rst
 changes/14.snappl.rst
 changes/15.feature.rst
 changes/16.feature.rst
+changes/18.feature.rst
 changes/3.snappl.rst
 changes/5.snappl.rst
 changes/8.snappl.rst

{roman_snpit_snappl-0.3.0 → roman_snpit_snappl-0.4.0}/snappl/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.0'
-__version_tuple__ = version_tuple = (0, 3, 0)
+__version__ = version = '0.4.0'
+__version_tuple__ = version_tuple = (0, 4, 0)

{roman_snpit_snappl-0.3.0 → roman_snpit_snappl-0.4.0}/snappl/image.py

@@ -1,10 +1,13 @@
 import types
+import pathlib
 
 import numpy as np
 from astropy.io import fits
 from astropy.nddata.utils import Cutout2D
 # from astropy.coordinates import SkyCoord
 
+import galsim.roman
+
 from snpit_utils.logger import SNLogger
 from snappl.wcs import AstropyWCS, GalsimWCS
 
@@ -63,11 +66,12 @@ class Image:
 
         """
         self.inputs = types.SimpleNamespace()
-        self.inputs.path = path
+        self.inputs.path = pathlib.Path( path )
         self.inputs.exposure = exposure
         self.inputs.sca = sca
         self._wcs = None      # a BaseWCS object (in wcs.py)
         self._is_cutout = False
+        self._zeropoint = None
 
     @property
     def data( self ):
@@ -101,6 +105,18 @@ class Image:
         """Tuple: (ny, nx) pixel size of image."""
         raise NotImplementedError( f"{self.__class__.__name__} needs to implement image_shape" )
 
+    @property
+    def sca( self ):
+        return self.inputs.sca
+
+    @property
+    def path( self ):
+        return self.inputs.path
+
+    @property
+    def name( self ):
+        return self.inputs.path.name
+
     @property
     def sky_level( self ):
         """Estimate of the sky level in ADU."""
@@ -116,6 +132,24 @@ class Image:
         """Band (str)"""
         raise NotImplementedError( f"{self.__class__.__name__} needs to implement band" )
 
+    @property
+    def zeropoint( self ):
+        """Image zeropoint for AB magnitudes.
+
+        The zeropoint zp is defined so that an object with total counts
+        c has magnitude m:
+
+           m = -2.5 * log(10) + zp
+
+        """
+        if self._zeropoint is None:
+            self._get_zeropoint()
+        return self._zeropoint
+
+    @zeropoint.setter
+    def zeropoint( self, val ):
+        self._zeropoint = val
+
     @property
     def mjd( self ):
         """MJD of the start of the image (defined how? TAI?)"""
@@ -192,7 +226,12 @@ class Image:
         """
         raise NotImplementedError( f"{self.__class__.__name__} needs to implement get_wcs" )
 
+    def _get_zeropoint( self ):
+        """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):
+
         """Make a cutout of the image at the given RA and DEC.
 
         Returns
@@ -504,3 +543,14 @@ class OpenUniverse2024FITSImage( FITSImage ):
         """The band the image is taken in (str)."""
         header = self._get_header()
         return header['FILTER'].strip()
+
+    @property
+    def mjd(self):
+        """The mjd of the image."""
+        header = self._get_header()
+        return float( header['MJD-OBS'] )
+
+    @property
+    def _get_zeropoint( self ):
+        header = self._get_header()
+        return galsim.roman.getBandpasses()[self.band].zeropoint + header['ZPTMAG']

{roman_snpit_snappl-0.3.0 → roman_snpit_snappl-0.4.0}/snappl/psf.py

@@ -3,10 +3,17 @@ import base64
 
 import numpy as np
 
+from roman_imsim.utils import roman_utils
+import galsim
+
+from snpit_utils.config import Config
+from snpit_utils.logger import SNLogger
+
 
 class PSF:
+    # Thought required: how to deal with oversampling.
+
     def __init__( self, *args, **kwargs ):
-        # Will define a PSF with a nominal position
         pass
 
     def get_stamp( self, x, y, flux=1. ):
@@ -35,11 +42,39 @@ class PSF:
         """
         raise NotImplementedError( f"{self.__class__.__name__} needs to implement get_stamp" )
 
+    @classmethod
+    def get_psf_object( cls, psfclass, **kwargs ):
+        """Return a PSF object whose type is specified by psfclass.
+
+        Parameters
+        ----------
+          psfclass : str
+             The name of the class of the PSF to instantiate.
+
+          **kwargs : further keyword arguments
+             TODO : we need to standardize on these so that things can
+             just call PSF.get_psf_object() without having to have their
+             own if statements on the type to figure out what kwargs to
+             pass!
+
+        """
+        if psfclass == "OversampledImagePSF":
+            return OversampledImagePSF.create( **kwargs )
+
+        if psfclass == "YamlSerialized_OversampledImagePSF":
+            return YamlSerialized_OversampledImagePSF( **kwargs )
+
+        if psfclass == "ou24PSF":
+            return ou24PSF( **kwargs )
+
+        raise ValueError( f"Unknown PSF class {psfclass}" )
 
 
 class OversampledImagePSF( PSF ):
     @classmethod
-    def create( cls, data, x0, y0, oversample_factor=1., enforce_odd=True, normalize=True ):
+    def create( cls, data=None, x0=None, y0=None, oversample_factor=1., enforce_odd=True, normalize=True,
+                **kwargs ):
+
         """Parameters
         ----------
           data: 2d numpy array
@@ -61,9 +96,19 @@ class OversampledImagePSF( PSF ):
           object of type cls
 
         """
+
+        if len(kwargs) > 0:
+            SNLogger.warning( f"Unused arguments to OversampledImagePSF.create: {[k for k in kwargs]}" )
+
         # TODO : implement enforce_odd
         # TODO : enforce square
 
+        if not isinstance( data, np.ndarray ) or ( len(data.shape) != 2 ):
+            raise TypeError( "data must be a 2d numpy array" )
+
+        x0 = float( x0 )
+        y0 = float( y0 )
+
         psf = cls()
         psf._data = data
         if normalize:
@@ -203,5 +248,45 @@ class YamlSerialized_OversampledImagePSF( OversampledImagePSF ):
         yaml.dump( out, open( filepath, 'w' ) )
 
 
-class galsimPSF( PSF ):
-    pass
+class ou24PSF( PSF ):
+    # Currently, does not support any oversampling, because SFFT doesn't
+    # TODO: support oversampling!
+
+    def __init__( self, pointing=None, sca=None, config_file=None, size=201, include_photonOps=True, **kwargs ):
+        if len(kwargs) > 0:
+            SNLogger.warning( f"Unused arguments to ou24PSF.__init__: {[k for k in kwargs]}" )
+
+        if ( pointing is None ) or ( sca is None ):
+            raise ValueError( "Need a pointing and an sca to make an ou24PSF" )
+        if config_file is None:
+            config_file = Config.get().value( 'ou24psf.config_file' )
+        self.config_file = config_file
+        self.pointing = pointing
+        self.sca = sca
+        self.size = size
+        self.include_photonOps = include_photonOps
+        self._stamps = {}
+
+    def get_stamp( self, x, y, flux=1., seed=None ):
+        """Return a 2d numpy image of the PSF at the image resolution.
+
+        Parameters are as in PSF.get_stamp, plus:
+
+        Parameters
+        ----------
+          seed : int
+            A random seed to pass to galsim.BaseDeviate for photonOps.
+            NOTE: this is not part of the base PSF interface (at least,
+            as of yet), so don't use it in production pipeline code.
+            However, it will be useful in tests for purposes of testing
+            reproducibility.
+
+        """
+        if (x, y) not in self._stamps:
+            rmutils = roman_utils( self.config_file, self.pointing, self.sca )
+            if seed is not None:
+                rmutils.rng = galsim.BaseDeviate( seed )
+            self._stamps[(x, y)] = rmutils.getPSF_Image( self.size, x, y,
+                                                         include_photonOps=self.include_photonOps ).array
+            self._stamps[(x, y)] *= flux / self._stamps[(x, y)].sum()
+        return self._stamps[(x, y)]