update docstrings for model classes

yuedong0607 · yuedong0607 · commit 7ffbb4b90e81 · 2026-04-17T18:34:26.000-04:00
diff --git a/romanisim/models/bandpass.py b/romanisim/models/bandpass.py
@@ -306,7 +306,7 @@ def getBandpasses(
                             There is currently no estimate for the thermal background for these
                             bands and they are set to zero arbitrarily.
                             [default: False]
-        sca:             Return the bandpasses dictionary for the particular SCA if given.
+        sca:                Return the bandpasses dictionary for the particular SCA if given.
                             [default: None]
         bandnames:          Iterable of bandpass names to get. If None, it gets all the imaging
                             bands if ``include_all_bands`` is False, or all bands if
@@ -445,6 +445,9 @@ def read_gsfc_effarea(sca=None, filename=None, galsim_filter_name=False):
         the name of the detector. A number between 1-18.
     filename : str
         filename to read in
+    galsim_filter_name: bool
+        Whether to return the Table using galsim.roman filter naming 
+        conventions.
 
     Returns
     -------
@@ -488,6 +491,9 @@ def compute_abflux(sca, effarea=None, galsim_filter_name=True):
         the name of the detector. A number between 1-18.
     effarea : astropy.Table.table
         Table from GSFC with effective areas for each filter.
+    galsim_filter_name: bool
+        Whether to return the Table using galsim.roman filter naming 
+        conventions.
 
     Returns
     -------
@@ -539,6 +545,9 @@ def compute_count_rate(flux, bandpass, sca, filename=None, effarea=None, wavedis
         Table from GSFC with effective areas for each filter.
     wavedist : numpy.ndarray
         Array of wavelengths along which spectral flux densities are defined in microns
+    galsim_filter_name: bool
+        whether the effective areas references from Goddard are in galsim.roman filter
+        naming conventions.
 
     Returns
     -------
diff --git a/romanisim/models/dark_current.py b/romanisim/models/dark_current.py
@@ -122,6 +122,14 @@ def _get_crds_model(self, getdq=False, metadata=None, image_mod=None, reffiles=N
         metadata : dict or None, optional
             Metadata overrides applied to the fake model's `meta` before CRDS
             reference selection.
+        image_mod : roman_datamodels.datamodels.ImageModel or None, optional
+            Existing image model whose metadata may be used to determine the
+            appropriate reference files. If provided, these values are used 
+            preferentially when available.
+        reffiles : dict or None, optional
+            Optional mapping of reference file types to file paths. If
+            provided, these values are used preferentially (with lower 
+            priority than image_mod) when available.
 
         Side Effects
         ------------
diff --git a/romanisim/models/gain.py b/romanisim/models/gain.py
@@ -58,6 +58,14 @@ def _get_crds_model(self, metadata=None, image_mod=None, reffiles=None):
         metadata : dict, optional
             Metadata overrides to apply before CRDS lookup. If provided, values
             are merged into the model metadata tree.
+        image_mod : roman_datamodels.datamodels.ImageModel or None, optional
+            Existing image model whose metadata may be used to determine the
+            appropriate reference files. If provided, these values are used 
+            preferentially when available.
+        reffiles : dict or None, optional
+            Optional mapping of reference file types to file paths. If
+            provided, these values are used preferentially (with lower 
+            priority than image_mod) when available.
 
         Notes
         -----
diff --git a/romanisim/models/ipc.py b/romanisim/models/ipc.py
@@ -74,6 +74,14 @@ def _get_crds_model(self, metadata=None, image_mod=None, reffiles=None):
         ----------
         metadata : dict or None, optional
             Metadata overrides applied to the data model before CRDS lookup.
+        image_mod : roman_datamodels.datamodels.ImageModel or None, optional
+            Existing image model whose metadata may be used to determine the
+            appropriate reference files. If provided, these values are used 
+            preferentially when available.
+        reffiles : dict or None, optional
+            Optional mapping of reference file types to file paths. If
+            provided, these values are used preferentially (with lower 
+            priority than image_mod) when available.
 
         Notes
         -----
diff --git a/romanisim/models/nonlinearity.py b/romanisim/models/nonlinearity.py
@@ -145,13 +145,31 @@ class Nonlinearity(object):
         If True, query CRDS and load per-pixel polynomial coefficients from the
         ``inverselinearity`` reference and a gain map from the ``gain`` reference.
         If False, use the module defaults.
+    reftype : str, optional
+        CRDS reference type to use for the polynomial coefficients. Typical
+        values include ``"inverselinearity"`` when applying nonlinearity and
+        ``"linearity"`` when removing it.
     getdq : bool, optional
         If True and ``usecrds=True``, also read the DQ array from the CRDS
         inverselinearity file and store it as ``self.dq`` (cropped by ``nborder``).
+    integralnonlinearity : object or None, optional
+        Optional integral nonlinearity reference model. If provided, the class
+        constructs channel-based lookup corrections that are added after the
+        polynomial correction.
     metadata : dict or None, optional
         Metadata overrides to apply before CRDS lookup. If provided, values
         are merged into the model metadata tree.
-
+    saturation : float or None, optional
+        Optional upper clipping threshold applied before evaluating the
+        nonlinearity correction.
+    coeffs : numpy.ndarray or None, optional
+        Explicit polynomial coefficients to use instead of loading them from
+        CRDS or using module defaults. Coefficients should be ordered from
+        lowest to highest polynomial degree.
+    gain : float or numpy.ndarray or None, optional
+        Explicit gain value or gain map to use when ``electrons=True`` in
+        :meth:`apply`.
+    
     Attributes
     ----------
     coeffs : numpy.ndarray
@@ -225,6 +243,34 @@ def __init__(
                 )
 
     def _get_crds_model(self, getdq=False, metadata=None, image_mod=None, reffiles=None):
+        """Load nonlinearity and gain reference data from CRDS.
+        This method resolves the required reference files, loads the gain map
+        and nonlinearity coefficients, crops them by ``nborder``, and repairs
+        invalid coefficient values when needed. If integral nonlinearity is
+        enabled, the corresponding reference file is also resolved.
+
+        Parameters
+        ----------
+        getdq : bool, optional
+            If True, also read the DQ array from the nonlinearity reference
+            file and propagate repair flags.
+        metadata : dict or None, optional
+            Metadata overrides used when selecting CRDS reference files.
+        image_mod : roman_datamodels.datamodels.ImageModel or None, optional
+            Existing image model whose metadata may be used to determine the
+            appropriate reference files. If provided, these values are used 
+            preferentially when available.
+        reffiles : dict or None, optional
+            Optional mapping of reference file types to file paths. If
+            provided, these values are used preferentially (with lower 
+            priority than image_mod) when available.
+        
+        Returns
+        -------
+        None
+            This method updates object attributes in place.
+        """
+        
         # Inverse linearity reference files are used to apply the
         # effect of classical non-linearity when constructing
         # L1 files, and linearity reference files are used to
diff --git a/romanisim/models/read_noise.py b/romanisim/models/read_noise.py
@@ -81,6 +81,14 @@ def _get_crds_model(self, metadata=None, image_mod=None, reffiles=None):
         metadata : dict, optional
             Metadata overrides to apply before CRDS lookup. If provided, values
             are merged into the model metadata tree.
+        image_mod : roman_datamodels.datamodels.ImageModel or None, optional
+            Existing image model whose metadata may be used to determine the
+            appropriate reference files. If provided, these values are used 
+            preferentially when available.
+        reffiles : dict or None, optional
+            Optional mapping of reference file types to file paths. If
+            provided, these values are used preferentially (with lower 
+            priority than image_mod) when available.
 
         """
 
diff --git a/romanisim/models/saturation.py b/romanisim/models/saturation.py
@@ -79,6 +79,14 @@ def _get_crds_model(self, getdq=False, metadata=None, image_mod=None, reffiles=N
         metadata : dict, optional
             Metadata overrides to apply before CRDS lookup. If provided, values
             are merged into the model metadata tree.
+        image_mod : roman_datamodels.datamodels.ImageModel or None, optional
+            Existing image model whose metadata may be used to determine the
+            appropriate reference files. If provided, these values are used 
+            preferentially when available.
+        reffiles : dict or None, optional
+            Optional mapping of reference file types to file paths. If
+            provided, these values are used preferentially (with lower 
+            priority than image_mod) when available.
         """
 
         ref_file = get_ref_files(image_mod, metadata, reffiles, reftypes=["saturation"])
