Skip to content

Commit cade209

Browse files
kecnryojustino
andcommitted
Apply suggestions from code review
Co-authored-by: ojustino <ojustino@users.noreply.github.com>
1 parent c53ea53 commit cade209

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

specreduce/background.py

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@ def bkg_image(self, image=None):
194194
Parameters
195195
----------
196196
image : nddata-compatible image or None
197-
image with 2-D spectral image data. If None, will use ``image`` passed
198-
to extract the background.
197+
image with 2-D spectral image data. If None, will extract
198+
the background from ``image`` used to initialize the class.
199199
200200
Returns
201201
-------
@@ -213,14 +213,15 @@ def bkg_spectrum(self, image=None):
213213
Parameters
214214
----------
215215
image : nddata-compatible image or None
216-
image with 2-D spectral image data. If None, will use ``image`` passed
217-
to extract the background.
216+
image with 2-D spectral image data. If None, will extract
217+
the background from ``image`` used to initialize the class.
218218
219219
Returns
220220
-------
221221
spec : `~specutils.Spectrum1D`
222-
The background 1d spectrum with flux expressed in the same
223-
units as the input image, or u.DN, and pixel units
222+
The background 1-D spectrum, with flux expressed in the same
223+
units as the input image (or u.DN if none were provided) and
224+
the spectral axis expressed in pixel units.
224225
"""
225226
bkg_image = self.bkg_image(image=image)
226227

@@ -234,8 +235,8 @@ def sub_image(self, image=None):
234235
Parameters
235236
----------
236237
image : nddata-compatible image or None
237-
image with 2-D spectral image data. If None, will use ``image`` passed
238-
to extract the background.
238+
image with 2-D spectral image data. If None, will extract
239+
the background from ``image`` used to initialize the class.
239240
240241
Returns
241242
-------
@@ -257,14 +258,15 @@ def sub_spectrum(self, image=None):
257258
Parameters
258259
----------
259260
image : nddata-compatible image or None
260-
image with 2-D spectral image data. If None, will use ``image`` passed
261-
to extract the background.
261+
image with 2-D spectral image data. If None, will extract
262+
the background from ``image`` used to initialize the class.
262263
263264
Returns
264265
-------
265266
spec : `~specutils.Spectrum1D`
266-
The background-subtracted 1d spectrum with flux expressed in the same
267-
units as the input image, or u.DN, and pixel units
267+
The background 1-D spectrum, with flux expressed in the same
268+
units as the input image (or u.DN if none were provided) and
269+
the spectral axis expressed in pixel units.
268270
"""
269271
sub_image = self.sub_image(image=image)
270272

0 commit comments

Comments
 (0)