Skip to content

Commit

Permalink
update namespace of Background (#215)
Browse files Browse the repository at this point in the history
replace specreduce.tracing.Background with specreduce.background.Background for correct calling of Background submodule.
  • Loading branch information
rudolffu committed Mar 27, 2024
1 parent 408547c commit bc96f9d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/extraction_quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ defined by one or more windows, and can be generated with:

The center of the window can either be passed as a float/integer or as a trace::

bg = specreduce.tracing.Background.one_sided(image, trace, separation=5, width=2)
bg = specreduce.background.Background.one_sided(image, trace, separation=5, width=2)


or, equivalently::

bg = specreduce.tracing.Background.one_sided(image, 15, separation=5, width=2)
bg = specreduce.background.Background.one_sided(image, 15, separation=5, width=2)


The background image can be accessed via `~specreduce.background.Background.bkg_image`
Expand Down

0 comments on commit bc96f9d

Please sign in to comment.