Skip to content

Commit

Permalink
docstring correct
Browse files Browse the repository at this point in the history
  • Loading branch information
abhi0395 committed Aug 5, 2024
1 parent 5f43055 commit b20b374
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
6 changes: 5 additions & 1 deletion docs/fileformat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ Then run `qsoabsfind` with the required FITS file. If using a custom constant fi
Output FITS File Structure
--------------------------

The **output** `fits file` will have the `ABSORBER` HDU, containing arrays such as:
The **output** `fits file` will have two HDUs `ABSORBER` and `MATADATA':

**ABSORBER** HDU will contain following structured data:

- **INDEX_SPEC**: Index of quasar (can be used to read the RA, DEC, and Z of QSOs).
- **Z_ABS**: Redshift of absorber.
Expand All @@ -48,3 +50,5 @@ The **output** `fits file` will have the `ABSORBER` HDU, containing arrays such
- **SN_${METAL}_${LINE}**: Signal-to-noise ratio of the lines.
- **${METAL}_EW_TOTAL**: Total EW of the lines in Angstroms.
- **${METAL}_EW_TOTAL_ERROR**: Uncertainties in total EW of the lines in Angstroms.

**METADATA** HDU will contain every metadata (corresponding to each absorber) that is available in input spectra file.
2 changes: 1 addition & 1 deletion qsoabsfind/absfinder.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ def read_single_spectrum_and_find_absorber(fits_file, spec_index, absorber, **kw
Raises:
AssertionError: If the sizes of `lam_search`, `unmsk_residual`, and `unmsk_error` do not match.
Notes:
Note:
- This function assumes that the input spectra are already normalized (i.e., flux divided by continuum).
- The wavelength search region is determined dynamically based on the observed wavelength range.
"""
Expand Down
1 change: 0 additions & 1 deletion qsoabsfind/ew.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
from .utils import double_gaussian
from .absorberutils import redshift_estimate
from .config import load_constants
from numba import jit

constants = load_constants()
lines = constants.lines
Expand Down
3 changes: 2 additions & 1 deletion qsoabsfind/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,8 @@ def vel_dispersion(c1, c2, sigma1, sigma2, resolution):

def plot_absorber(lam, residual, absorber, zabs, xlabel='obs wave (ang)', ylabel='residual', title='QSO', plot_filename=None):
"""
Saves a plot of spectra with absorber in the current working directory.
Saves a plot of spectra with absorber(s) (full spectrum + zoomed version)
in the current working directory.
Args:
lam (array-like): Observed wavelength.
Expand Down

0 comments on commit b20b374

Please sign in to comment.