exosim 2.2.2__tar.gz → 2.2.4__tar.gz

{exosim-2.2.2 → exosim-2.2.4}/CHANGELOG.rst

@@ -12,6 +12,38 @@ Unreleased changes live as fragments in ``changelog.d/`` and are merged here by
 
 .. scriv-insert-here
 
+.. _changelog-2.2.4:
+
+[2.2.4_] - Rescale sources API
+==============================
+
+Added
+-----
+
+- ``Channel.rescale_sources()`` and ``Channel.rescale_radiances()``: the two
+  halves of ``Channel.rescale_contributions()``, which now calls both and
+  behaves as before. A pipeline that propagates the sources a second time
+  (for example after ``define_sources``) can rescale only the sources, without
+  multiplying the path radiances by the wavelength step again.
+
+.. _changelog-2.2.3:
+
+[2.2.3_] - Elliptical aperture area
+===================================
+
+Fixed
+-----
+
+- elliptical apertures: ``aperture_size`` (the pixel count used by
+  ``ComputeConstantDarkCurrentNoise`` and ``ComputeConstantReadNoise``) was
+  computed as :math:`\pi (a/2)(b/2)`, four times smaller than the area
+  integrated by the photometry, which uses ``a`` and ``b`` as the semi-axes of
+  the ``photutils`` ``EllipticalAperture``. It is now :math:`\pi a b`.
+  ``find_elliptical_aperture`` likewise returns :math:`\pi a b` as its area
+  (it returned ``a * b``) and its docstring now states that the sizes are
+  semi-axes. Aperture tables generated with earlier versions have a wrong
+  ``aperture_size`` for elliptical rows and should be regenerated
+
 .. _changelog-2.2.2:
 
 [2.2.2_] - Fix ACES solar-metallicity SED download
@@ -284,5 +316,9 @@ Cleaned repository
 
 .. _2.2.2: https://github.com/arielmission-space/ExoSim2.0/releases/tag/v2.2.2
 
+.. _2.2.3: https://github.com/arielmission-space/ExoSim2.0/releases/tag/v2.2.3
+
+.. _2.2.4: https://github.com/arielmission-space/ExoSim2.0/releases/tag/v2.2.4
+
 .. _keepachangelog: https://keepachangelog.com/en/1.0.0/
 .. _semver: https://semver.org/spec/v2.0.0.html

{exosim-2.2.2 → exosim-2.2.4}/CITATION.cff

@@ -18,5 +18,5 @@ authors:
 
 title: "ExoSim 2: the new exoplanet observation simulator applied to the Ariel space mission"
 doi: 10.1007/s10686-024-09976-2
-version: 2.2.2
-date-released: 2026-11-12
+version: 2.2.4
+date-released: 2026-11-13

{exosim-2.2.2 → exosim-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: exosim
-Version: 2.2.2
+Version: 2.2.4
 Summary: ExoSim 2 is the next generation of the Exoplanet Observation Simulator (ExoSim) tailored for spectro-photometric observations of transiting exoplanets from space, ground, and sub-orbital platforms. This software is a complete rewrite implemented in Python 3, embracing object-oriented design principles.
 Author: E. Pascale, A. Bocchieri, A. Lorenzani, A. Papageorgiou
 Author-email: "L. V. Mugnai" <mugnail@cardiff.ac.uk>

{exosim-2.2.2 → exosim-2.2.4}/codemeta.json

@@ -40,12 +40,12 @@
     "license": "https://spdx.org/licenses/BSD-3-Clause",
     "name": "ExoSim2",
     "programmingLanguage": "Python 3",
-    "version": "2.2.2",
+    "version": "2.2.4",
     "codemeta:contIntegration": {
         "id": "https://app.codecov.io/gh/arielmission-space/ExoSim2-public"
     },
     "continuousIntegration": "https://app.codecov.io/gh/arielmission-space/ExoSim2-public",
     "issueTracker": "https://github.com/arielmission-space/ExoSim2-public/issues",
     "referencePublication": "https://link.springer.com/article/10.1007/s10686-024-09976-2",
-    "dateModified": "2026-11-12"
+    "dateModified": "2026-11-13"
 }

{exosim-2.2.2 → exosim-2.2.4}/src/exosim/models/channel.py

@@ -252,38 +252,52 @@ class Channel(log.Logger):
             self.bkg_focal_plane = focal_plane.copy(dataset_name="bkg_focal_plane")
         return focal_plane
 
-    # todo change into a more clearer name
-    def rescale_contributions(self) -> None:
+    def _focal_plane_wavelength_step(self) -> u.Quantity:
+        """Wavelength width of each focal-plane spectral column."""
+        x_wav_osr = self.focal_plane.spectral
+        d_x_wav_osr = np.zeros_like(x_wav_osr)
+        idx = np.where(x_wav_osr > 0.0)
+        d_x_wav_osr[idx] = np.gradient(x_wav_osr[idx])
+        if np.any(d_x_wav_osr < 0):
+            d_x_wav_osr *= -1.0
+        return d_x_wav_osr * self.focal_plane.spectral_units
+
+    def rescale_sources(self) -> None:
         """
-        It updated the contributions (sources and path)
-        by rebinning them to the wavelength solution grid
-        and multiplying them by the wl solution gradient
+        It rebins the sources onto the focal-plane wavelength grid and
+        multiplies them by the wavelength width of each column, turning
+        spectral densities into signals per column. Each source must be
+        rescaled once, after it has been propagated.
         """
-
-        def wl_gradient(x_wav_osr):
-            d_x_wav_osr = np.zeros_like(x_wav_osr)
-            idx = np.where(x_wav_osr > 0.0)
-            d_x_wav_osr[idx] = np.gradient(x_wav_osr[idx])
-            if np.any(d_x_wav_osr < 0):
-                d_x_wav_osr *= -1.0
-            return d_x_wav_osr
-
-        d_spectral_wl = (
-            wl_gradient(self.focal_plane.spectral) * self.focal_plane.spectral_units
-        )
-
-        # multiply sources by gradient
         if self.sources:
+            d_spectral_wl = self._focal_plane_wavelength_step()
             for source in self.sources:
                 self.sources[source].spectral_rebin(self.focal_plane.spectral)
                 self.sources[source] *= d_spectral_wl
 
-        # multiply radiances by gradient
+    def rescale_radiances(self) -> None:
+        """
+        It rebins the path radiances (foregrounds and optical-element
+        emission) onto the focal-plane wavelength grid and multiplies them
+        by the wavelength width of each column. The radiances must be
+        rescaled once: when the sources are propagated again (for example
+        after :meth:`define_sources`), use :meth:`rescale_sources` only.
+        """
         if self.path:
+            d_spectral_wl = self._focal_plane_wavelength_step()
             for rad in [k for k in self.path if "radiance" in k]:
                 self.path[rad].spectral_rebin(self.focal_plane.spectral)
                 self.path[rad] *= d_spectral_wl
 
+    def rescale_contributions(self) -> None:
+        """
+        It rescales the sources and the path radiances onto the focal-plane
+        wavelength grid: :meth:`rescale_sources` followed by
+        :meth:`rescale_radiances`.
+        """
+        self.rescale_sources()
+        self.rescale_radiances()
+
     @property
     def target_source(self):
         # TODO test this

{exosim-2.2.2 → exosim-2.2.4}/src/exosim/tasks/radiometric/estimate_apertures.py

@@ -223,7 +223,8 @@ class EstimateApertures(Task):
         if shape == "rectangular":
             aperture_size = np.array(dwl) * np.array(dsp)
         elif shape == "elliptical":
-            aperture_size = np.pi * (np.array(dwl) / 2) * (np.array(dsp) / 2)
+            # dwl and dsp are the semi-axes (a, b) of the photutils EllipticalAperture
+            aperture_size = np.pi * np.array(dwl) * np.array(dsp)
         else:
             aperture_size = np.array(dsp)  # fallback generico
 

{exosim-2.2.2 → exosim-2.2.4}/src/exosim/utils/aperture.py

@@ -115,9 +115,10 @@ def find_elliptical_aperture(ima, desired_ene, center=None):
     Returns
     -------
     (float, float)
-        sizes of the elliptical aperture (h,w)
+        semi-axes (a, b) of the elliptical aperture, in pixels, as used by
+        :class:`photutils.aperture.EllipticalAperture`
     float
-        number of pixels in the aperture
+        area of the aperture in pixels, :math:`\\pi a b`
     float
         encircled energy collected by the aperture
 
@@ -172,7 +173,7 @@ def find_elliptical_aperture(ima, desired_ene, center=None):
 
     a = res.x[0]
     b = res.x[1]
-    return (a, b), a * b, ene_func(center, a, b, ima)
+    return (a, b), np.pi * a * b, ene_func(center, a, b, ima)
 
 
 def find_bin_aperture(ima, desired_ene, spatial_with, center=None):

{exosim-2.2.2 → exosim-2.2.4}/src/exosim.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: exosim
-Version: 2.2.2
+Version: 2.2.4
 Summary: ExoSim 2 is the next generation of the Exoplanet Observation Simulator (ExoSim) tailored for spectro-photometric observations of transiting exoplanets from space, ground, and sub-orbital platforms. This software is a complete rewrite implemented in Python 3, embracing object-oriented design principles.
 Author: E. Pascale, A. Bocchieri, A. Lorenzani, A. Papageorgiou
 Author-email: "L. V. Mugnai" <mugnail@cardiff.ac.uk>

exosim-2.2.4/src/exosim.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "2.2.4",
+  "distance": 0,
+  "node": "g4b1c5c05",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-11-13"
+}

exosim-2.2.2/src/exosim.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "2.2.2",
-  "distance": 0,
-  "node": "g6cbdedbd",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-11-12"
-}