From 6183995bd717e2ec806697655052b862b6698c4b Mon Sep 17 00:00:00 2001 From: Ricky O'Steen Date: Tue, 22 Nov 2022 15:08:52 -0500 Subject: [PATCH 1/4] Add summary of capabilities/user stories to docs index page --- docs/index.rst | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 7bc6ce57..4da9ec59 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,15 +2,31 @@ Specreduce Documentation ######################## -The `specreduce `_ package aims to provide a data reduction toolkit for optical +The `specreduce `_ package +aims to provide a data reduction toolkit for optical and infrared spectroscopy, on which applications such as pipeline processes for specific instruments can be built. The scope of its functionality is limited to basic spectroscopic reduction, with basic *image* processing steps (such as -bias subtraction) instead covered by `ccdproc `_ and other packages, data -analysis by `specutils `_ and visualization by `matplotlib `_. A few +bias subtraction) instead covered by `ccdproc `_ +and other packages, data analysis by `specutils `_, +and visualization by `matplotlib `_. A few examples will nevertheless be provided of its usage in conjunction with these complementary packages. +Specreduce is currently useful mainly for the following three tasks: + +#. Determining the trace of a spectrum dispersed in a 2D image, either by setting a flat + trace or fitting a spline, polynomial, or other model to the positions of the dispersed + spectrum. +#. Generating a background based on a region on one or both sides of this trace, and making + available the background image, 1D spectrum of the background, and the + background-subtracted image. +#. Performing either a Horne (aka "optimal") or boxcar extraction on either the original + or background-subtracted 2D spectrum, using the trace generated by the first task to + generate a 1D spectrum. + +Further details about these capabilities are detailed in the sections linked below. + .. note:: Specreduce is currently an incomplete work-in-progress and is liable to From 34a143951f87f6b254e3a05ce12506f1949e4f57 Mon Sep 17 00:00:00 2001 From: Ricky O'Steen Date: Mon, 28 Nov 2022 16:39:09 -0500 Subject: [PATCH 2/4] Address review comments --- docs/index.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 4da9ec59..51c70486 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,14 +6,7 @@ The `specreduce `_ packa aims to provide a data reduction toolkit for optical and infrared spectroscopy, on which applications such as pipeline processes for specific instruments can be built. The scope of its functionality is limited to -basic spectroscopic reduction, with basic *image* processing steps (such as -bias subtraction) instead covered by `ccdproc `_ -and other packages, data analysis by `specutils `_, -and visualization by `matplotlib `_. A few -examples will nevertheless be provided of its usage in conjunction with these -complementary packages. - -Specreduce is currently useful mainly for the following three tasks: +basic spectroscopic reduction, currently encompassing the following three tasks: #. Determining the trace of a spectrum dispersed in a 2D image, either by setting a flat trace or fitting a spline, polynomial, or other model to the positions of the dispersed @@ -26,6 +19,12 @@ Specreduce is currently useful mainly for the following three tasks: generate a 1D spectrum. Further details about these capabilities are detailed in the sections linked below. +Beyond these tasks, basic *image* processing steps (such as bias subtraction) are covered by +`ccdproc `_ +and other packages, data analysis by `specutils `_, +and visualization by `matplotlib `_. A few +examples will be provided of using ``specreduce`` in conjunction with these +complementary packages. .. note:: From aa9897cb6c5d52acb66ad4a24d0d731d6d68326b Mon Sep 17 00:00:00 2001 From: Ricky O'Steen <39831871+rosteen@users.noreply.github.com> Date: Tue, 29 Nov 2022 15:00:40 -0500 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: ojustino --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 51c70486..ec93e94b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,7 @@ basic spectroscopic reduction, currently encompassing the following three tasks: #. Generating a background based on a region on one or both sides of this trace, and making available the background image, 1D spectrum of the background, and the background-subtracted image. -#. Performing either a Horne (aka "optimal") or boxcar extraction on either the original +#. Performing either a Horne (a.k.a. "optimal") or boxcar extraction on either the original or background-subtracted 2D spectrum, using the trace generated by the first task to generate a 1D spectrum. @@ -23,7 +23,7 @@ Beyond these tasks, basic *image* processing steps (such as bias subtraction) ar `ccdproc `_ and other packages, data analysis by `specutils `_, and visualization by `matplotlib `_. A few -examples will be provided of using ``specreduce`` in conjunction with these +examples will be provided that feature ``specreduce`` in conjunction with these complementary packages. .. note:: From 82675f65856f4738721922e2f337c3377d3e149d Mon Sep 17 00:00:00 2001 From: Ricky O'Steen Date: Tue, 29 Nov 2022 15:02:06 -0500 Subject: [PATCH 4/4] Mention third trace option --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index ec93e94b..e05ac72b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,8 +9,8 @@ specific instruments can be built. The scope of its functionality is limited to basic spectroscopic reduction, currently encompassing the following three tasks: #. Determining the trace of a spectrum dispersed in a 2D image, either by setting a flat - trace or fitting a spline, polynomial, or other model to the positions of the dispersed - spectrum. + trace, providing a custom trace array, or fitting a spline, polynomial, or other model + to the positions of the dispersed spectrum. #. Generating a background based on a region on one or both sides of this trace, and making available the background image, 1D spectrum of the background, and the background-subtracted image.