sparclclient 1.2.9b1__tar.gz → 1.3.0b1__tar.gz

{sparclclient-1.2.9b1 → sparclclient-1.3.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sparclclient
-Version: 1.2.9b1
+Version: 1.3.0b1
 Summary: A client for getting spectra and meta-data from NOIRLab.
 Author-email: "S. Pothier" <datalab-spectro@noirlab.edu>
 Description-Content-Type: text/markdown

{sparclclient-1.2.9b1 → sparclclient-1.3.0b1}/sparcl/__init__.py

@@ -38,4 +38,4 @@ __all__ = ["client", "align_records"]
 #__version__ = "1.2.6"
 #__version__ = "1.2.7"
 #__version__ = "1.2.8"
-__version__ = "1.2.9b1"
+__version__ = "1.3.0b1"

{sparclclient-1.2.9b1 → sparclclient-1.3.0b1}/sparcl/specutils.py

@@ -12,7 +12,32 @@ from astropy.nddata import InverseVariance
 import astropy.units as u
 
 def _validate_records(records, r0, collection):
-    """Validate that records can be converted to Spectrum."""
+    """Validate that records can be converted to Spectrum.
+
+    Parameters
+    ----------
+    records : list of dict
+        All records to validate.
+    r0 : dict
+        First record, used as reference for validation.
+    collection: bool
+        If ``True``, attempt to convert to a
+        :class:`~specutils.SpectrumCollection` instead.
+
+    Raises
+    ------
+    ValueError
+        If records lack 'wavelength' attribute.
+        If records have different data releases.
+        If wavelength array lengths differ (suggests using SpectrumList).
+        If wavelength pixel values differ and collection=False
+        (suggests using SpectrumCollection).
+
+    Warnings
+    --------
+    UserWarning
+        If records come from different data releases.
+    """
 
     # Check if the first record has wavelength data
     if 'wavelength' not in r0:
@@ -39,7 +64,45 @@ def _validate_records(records, r0, collection):
 def _extract_record_data(records, flux, uncertainty, mask, model, redshift,
                          meta, spectral_axis, has_model, has_redshift,
                          collection, single_record):
-    """Extract all data from records into arrays."""
+    """Extract all data from records into arrays. This function modifies
+    arrays in-place rather than returning values.
+
+    Parameters
+    ----------
+    records: list of dict
+        Records containing flux, ivar, mask, wavelength, and optional
+        model/redshift.
+    flux : np.ndarray
+        Pre-allocated array for flux values. Shape: (n_pixels,) if
+        single_record, else (n_records, n_pixels).
+    uncertainty : np.ndarray
+        Pre-allocated array for inverse variance.
+    mask : np.ndarray
+        Pre-allocated array for data quality masks.
+    model : np.ndarray or None
+        Pre-allocated array for model values if has_model=True.
+    redshift : list
+        Empty list to populate with redshift values.
+    meta : dict
+        Empty dict to populate with metadata.
+    spectral_axis : np.ndarray
+        For collections, pre-allocated 2D array to store wavelength grids.
+        For non-collections, this is just r0.wavelength (not modified).
+    has_model : bool
+        Whether records contain 'model' attribute.
+    has_redshift : bool
+        Whether records contain 'redshift' attribute.
+    collection : bool
+        If True, stores wavelength arrays for each record in spectral_axis.
+    single_record : bool
+        If True, treats arrays as 1D. If False, treats as 2D with row per
+        record.
+
+    Returns
+    -------
+    None
+        All outputs are written to the input arrays/containers in-place.
+    """
     for k, record in enumerate(records):
         if single_record:
             # For single record, assign directly (1D)
@@ -83,7 +146,7 @@ def to_Spectrum(results, *, collection=False):
     ----------
     results : :class:`sparcl.Results.Retrieved`
         Retrieved results, or a single record from a set of results.
-    collection : :class:`bool`, optional
+    collection : bool, optional
         If ``True``, attempt to convert to a
         :class:`~specutils.SpectrumCollection` instead.
 
@@ -131,16 +194,16 @@ def to_Spectrum(results, *, collection=False):
 
     # Build spectral axis
     if collection:
-        spectral_axis = np.zeros((len(records), r0.wavelength.shape[0]),
+        spectral_axis = np.empty((len(records), r0.wavelength.shape[0]),
                                  dtype=r0.wavelength.dtype)
     else:
         spectral_axis = r0.wavelength
 
     # Initialize arrays
-    flux = np.zeros(flux_shape, dtype=r0.flux.dtype)
-    uncertainty = np.zeros(flux_shape, dtype=r0.ivar.dtype)
-    mask = np.zeros(flux_shape, dtype=r0.mask.dtype)
-    model = np.zeros(flux_shape, dtype=r0.model.dtype) if has_model else None
+    flux = np.empty(flux_shape, dtype=r0.flux.dtype)
+    uncertainty = np.empty(flux_shape, dtype=r0.ivar.dtype)
+    mask = np.empty(flux_shape, dtype=r0.mask.dtype)
+    model = np.empty(flux_shape, dtype=r0.model.dtype) if has_model else None
     redshift = []
     meta = {}
 
@@ -152,6 +215,9 @@ def to_Spectrum(results, *, collection=False):
     # Convert redshift list to numpy array if exists
     if has_redshift:
         redshift = np.array(redshift)
+        if single_record and len(redshift) == 1:
+            # Convert to scalar if single record
+            redshift = redshift[0]
     else:
         redshift = None
 
@@ -161,7 +227,7 @@ def to_Spectrum(results, *, collection=False):
 
     # Prepare arguments common to both Spectrum and SpectrumCollection
     common_args = {
-        'flux': flux * u.Unit('1e-17 erg cm-2 s-1 AA-1'),
+        'flux': flux * 10**-17 * u.Unit('erg cm-2 s-1 AA-1'),
         'spectral_axis': spectral_axis * u.AA,
         'uncertainty': InverseVariance(uncertainty),
         'mask': mask,
@@ -200,7 +266,7 @@ def to_SpectrumList(results):
             if attribute not in ('flux', 'wavelength', 'ivar',
                                  'redshift', 'mask'):
                 meta[attribute] = r[attribute]
-        s1 = Spectrum(flux=r.flux*u.Unit('1e-17 erg cm-2 s-1 AA-1'),
+        s1 = Spectrum(flux=r.flux*10**-17*u.Unit('erg cm-2 s-1 AA-1'),
                       spectral_axis=r.wavelength*u.AA,
                       uncertainty=InverseVariance(r.ivar),
                       redshift=redshift,