Skip to content

Commit 00dab92

Browse files
Lulus792Angelus Vincent
authored andcommitted
updated the docstring for the data module, and fixed linting errors
1 parent 67f0701 commit 00dab92

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

lumispy/data/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def _resolve_dir():
3939

4040

4141
def asymmetric_peak_map():
42-
"""Load example asymmetric peak map data.
42+
"""Load an examplary datamap with an asymmetric peak. Some of the spectra contain spikes.
4343
4444
Returns
4545
-------
@@ -52,7 +52,7 @@ def asymmetric_peak_map():
5252

5353

5454
def nanoparticles():
55-
"""Load example nanoparticle spectrum data.
55+
"""Load an examplary datamap with one peak. The spectra contain a lot of noise.
5656
5757
Returns
5858
-------

lumispy/signals/luminescence_spectrum.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ def savetxt(
220220

221221
def to_array(self, axes=True, transpose=False):
222222
"""Return luminescence spectrum object as numpy array.
223-
223+
224224
%s
225225
%s
226226
%s
@@ -293,7 +293,7 @@ def px_to_nm_grating_solver(
293293

294294
def centroid(self, signal_range=None, **kwargs):
295295
"""Find the centroid (center of mass) of a peak.
296-
296+
297297
It basically represents a "weighted average" of the peak.
298298
299299
Notes

lumispy/utils/signals.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868

6969
def com(spectrum_intensities, signal_axis, **kwargs):
7070
"""Find the centroid (center of mass) of a peak.
71-
71+
7272
Basically represents a weighted average of the spectrum based on the
7373
intensity at each pixel and its respective signal axis.
7474
@@ -101,7 +101,7 @@ def com(spectrum_intensities, signal_axis, **kwargs):
101101

102102
def _interpolate_signal(axis_array, index, **kwargs):
103103
"""Wrapper for `hs.axes.index2value`.
104-
104+
105105
Linearly interpolate between values should the index passed not be a
106106
integer. Using the kwargs, the interpolation method can be changed.
107107
"""

0 commit comments

Comments
 (0)