Skip to content

Commit 587e38a

Browse files
authored
Merge pull request #166 from camipacifici/horne-docs
Improve Horne docs
2 parents 799ff49 + e56d181 commit 587e38a

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/extraction_quickstart.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,27 @@ implemented methods:
6666
Each of these takes the input image and trace as inputs (see the API above for other required
6767
and optional parameters)::
6868

69-
extract = specreduce.extract.BoxcarExtract(image-bg, trace, width=3)
70-
spectrum = extract.spectrum
69+
extract = specreduce.extract.BoxcarExtract(image-bg, trace, width=3)
70+
71+
or::
72+
73+
extract = specreduce.extract.HorneExtract(image-bg, trace)
7174

72-
The returned ``extract`` object contains all the set options. The extracted 1D spectrum can be
75+
For the Horne algorithm, the input image must include uncertainty and mask.
76+
These two calls set the options and initialize the object. To extract the spectrum, the
77+
syntax is::
78+
79+
spectrum = extract.spectrum
80+
81+
The ``extract`` object contains all the set options. The extracted 1D spectrum can be
7382
accessed via the ``spectrum`` property or by calling the ``extract`` object (which also allows
7483
temporarily overriding any values)::
7584

7685
spectrum2 = extract(width=6)
7786

87+
The Horne algorithm preforms a Gaussian fit on the source, it is thus best suited for cases
88+
where the source has a Gaussian profile in the cross-dispersion direction.
89+
7890
Example Workflow
7991
----------------
8092

0 commit comments

Comments
 (0)