@@ -194,8 +194,8 @@ def bkg_image(self, image=None):
194
194
Parameters
195
195
----------
196
196
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 .
199
199
200
200
Returns
201
201
-------
@@ -213,14 +213,15 @@ def bkg_spectrum(self, image=None):
213
213
Parameters
214
214
----------
215
215
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 .
218
218
219
219
Returns
220
220
-------
221
221
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.
224
225
"""
225
226
bkg_image = self .bkg_image (image = image )
226
227
@@ -234,8 +235,8 @@ def sub_image(self, image=None):
234
235
Parameters
235
236
----------
236
237
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 .
239
240
240
241
Returns
241
242
-------
@@ -257,14 +258,15 @@ def sub_spectrum(self, image=None):
257
258
Parameters
258
259
----------
259
260
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 .
262
263
263
264
Returns
264
265
-------
265
266
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.
268
270
"""
269
271
sub_image = self .sub_image (image = image )
270
272
0 commit comments