Skip to content

Commit

Permalink
Merge branch 'develop' into coadd1d_badspec1d
Browse files Browse the repository at this point in the history
  • Loading branch information
debora-pe committed Aug 3, 2023
2 parents 0d7519d + 6fd1ba0 commit 23da51c
Show file tree
Hide file tree
Showing 109 changed files with 1,572 additions and 1,503 deletions.
8 changes: 0 additions & 8 deletions doc/api/pypeit.scripts.ql_multislit.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/api/pypeit.scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Submodules
pypeit.scripts.parse_slits
pypeit.scripts.qa_html
pypeit.scripts.ql
pypeit.scripts.ql_multislit
pypeit.scripts.run_pypeit
pypeit.scripts.scriptbase
pypeit.scripts.sensfunc
Expand Down
2 changes: 1 addition & 1 deletion doc/calibrations/image_proc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ in our documentation as ``(nspec,nspat)``. The operations required to
flip/transpose the image arrays to match the PypeIt convention are dictated by
instrument-specific :class:`~pypeit.images.detector_container.DetectorContainer`
parameters and performed by
:func:`~pypeit.spectrograph.spectrographs.Spectrograph.orient_image`. Image
:func:`~pypeit.spectrographs.spectrograph.Spectrograph.orient_image`. Image
orientation will be performed if the ``orient`` parameter is true.

.. warning::
Expand Down
2 changes: 1 addition & 1 deletion doc/calibrations/tilt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Current TiltImage Data Model
============================

Internally, the image is held in
:class:`pypeit.tiltimage.TiltImage`
:class:`pypeit.images.buildimage.tiltimage.TiltImage`
which subclasses from :class:`pypeit.images.pypeitimage.PypeItImage` and
:class:`pypeit.datamodel.DataContainer`.

Expand Down
9 changes: 8 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,16 @@

# When nit-picking, ignore these warnings:
nitpick_ignore = [ ('py:class', 'optional'),
('py:class', 'iterable'),
('py:class', 'ndarray'),
('py:class', 'dict-like'),
('py:class', 'array-like'),
('py:class', 'table-like'),
('py:class', 'float-like'),
('py:class', 'scalar-like'),
('py:class', 'default') ]
('py:class', 'default'),
('py:class', 'callable'),
]

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down
3 changes: 1 addition & 2 deletions doc/fluxing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -589,6 +589,5 @@ FluxSpec Class
==============

The guts of the flux algorithms are guided by the
:class:`~pypeit.fluxcalibrate.FluxCalibrate`
class.
:func:`~pypeit.fluxcalibrate.apply_flux_calib` class.

8 changes: 5 additions & 3 deletions doc/help/pypeit_coadd_1dspec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
positional arguments:
coadd1d_file File to guide coadding process.
------------------------ MultiSlit
------------------------
MultiSlit
------------------------
For coadding Multislit spectra the file must have the
Expand Down Expand Up @@ -50,7 +51,8 @@
inspect the spec1d_*.txt files or run pypeit_show_1dspec
spec1dfile --list
------------------------ Echelle
------------------------
Echelle
------------------------
For coadding Echelle spectra the file must have the
Expand Down Expand Up @@ -93,7 +95,7 @@
file for the echelle setup in question
setup_id: string identifier for the echelle setup in
question, i.e. 'VIS', 'NIR', or '
question, i.e. 'VIS', 'NIR', or 'UVB'
If the coaddfile is not given the output file will be
placed in the same directory as the first spec1d file.
Expand Down
78 changes: 0 additions & 78 deletions doc/help/pypeit_ql_multislit.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/help/run_pypeit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
usage: run_pypeit [-h] [-v VERBOSITY] [-r REDUX_PATH] [-m] [-s] [-o] [-c]
pypeit_file
## [1;37;42mPypeIt : The Python Spectroscopic Data Reduction Pipeline v1.13.1.dev504+ge3211bd33.d20230721[0m
## [1;37;42mPypeIt : The Python Spectroscopic Data Reduction Pipeline v1.13.1.dev537+g0261baa1b.d20230728[0m
##
## Available spectrographs include:
## bok_bc, gemini_flamingos1, gemini_flamingos2, gemini_gmos_north_e2v,
Expand Down
2 changes: 1 addition & 1 deletion doc/include/bitmaskarray_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You can access the bit flag names using:
Bit access
++++++++++

You can flag bits using :func:`~pypeit.bitmaskarray.BitMaskArray.turn_on`. For
You can flag bits using :func:`~pypeit.images.bitmaskarray.BitMaskArray.turn_on`. For
example, the following code flags the center column of the image as being
part of the detector bad-pixel mask:

Expand Down
32 changes: 16 additions & 16 deletions doc/include/class_datamodel_wavetilts.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@

**Version**: 1.2.0

==================== ============================ ================= ==============================================================================================================================
Attribute Type Array Type Description
==================== ============================ ================= ==============================================================================================================================
``PYP_SPEC`` str PypeIt spectrograph name
``bpmtilts`` `numpy.ndarray`_ `numpy.integer`_ Bad pixel mask for tilt solutions. Keys are taken from SlitTraceSetBitmask
``coeffs`` `numpy.ndarray`_ `numpy.floating`_ 2D coefficents for the fit on the initial slits. One set per slit/order (3D array).
``func2d`` str Function used for the 2D fit
``nslit`` int Total number of slits. This can include masked slits
``slits_filename`` str Path to SlitTraceSet file. This helps to find the Slits calibration file when running pypeit_chk_tilts()
``spat_flexure`` float Flexure shift from the input TiltImage
``spat_id`` `numpy.ndarray`_ `numpy.integer`_ Slit spat_id
``spat_order`` `numpy.ndarray`_ `numpy.integer`_ Order for spatial fit (nslit)
``spec_order`` `numpy.ndarray`_ `numpy.integer`_ Order for spectral fit (nslit)
``tilt_traces`` `astropy.table.table.Table`_ Table with the positions of the traced and fitted tilts for all the slits. see :func:`make_tbl_tilt_traces` for more details.
``tiltimg_filename`` str Path to Tiltimg file. This helps to find Tiltimg file when running pypeit_chk_tilts()
==================== ============================ ================= ==============================================================================================================================
==================== ============================ ================= ===============================================================================================================================================================
Attribute Type Array Type Description
==================== ============================ ================= ===============================================================================================================================================================
``PYP_SPEC`` str PypeIt spectrograph name
``bpmtilts`` `numpy.ndarray`_ `numpy.integer`_ Bad pixel mask for tilt solutions. Keys are taken from SlitTraceSetBitmask
``coeffs`` `numpy.ndarray`_ `numpy.floating`_ 2D coefficents for the fit on the initial slits. One set per slit/order (3D array).
``func2d`` str Function used for the 2D fit
``nslit`` int Total number of slits. This can include masked slits
``slits_filename`` str Path to SlitTraceSet file. This helps to find the Slits calibration file when running pypeit_chk_tilts()
``spat_flexure`` float Flexure shift from the input TiltImage
``spat_id`` `numpy.ndarray`_ `numpy.integer`_ Slit spat_id
``spat_order`` `numpy.ndarray`_ `numpy.integer`_ Order for spatial fit (nslit)
``spec_order`` `numpy.ndarray`_ `numpy.integer`_ Order for spectral fit (nslit)
``tilt_traces`` `astropy.table.table.Table`_ Table with the positions of the traced and fitted tilts for all the slits. see :func:`~pypeit.wavetilts.BuildWaveTilts.make_tbl_tilt_traces` for more details.
``tiltimg_filename`` str Path to Tiltimg file. This helps to find Tiltimg file when running pypeit_chk_tilts()
==================== ============================ ================= ===============================================================================================================================================================
Loading

0 comments on commit 23da51c

Please sign in to comment.