Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
Vasudevan, Rama K
pycroscopy
Commits
ded7a231
Commit
ded7a231
authored
Feb 17, 2017
by
Chris Smith
Browse files
Small docstrings update
parent
00646f83
Changes
1
Hide whitespace changes
Inline
Side-by-side
pycroscopy/io/translators/beps_ndf.py
View file @
ded7a231
...
...
@@ -29,7 +29,7 @@ class BEPSndfTranslator(Translator):
"""
Translates Band Excitation Polarization Switching (BEPS) datasets from .dat
files to .h5
"""
def
translate
(
self
,
data_filepath
,
show_plots
=
True
,
save_plots
=
True
,
do_histogram
=
False
,
debug
=
False
):
...
...
@@ -959,7 +959,8 @@ class BEPSndfPixel(object):
data_vec : 1D float numpy array
Data contained within each pixel
harm: unsigned int
Harmonic of the BE waveform. absolute value of the wave type used to normalize the response waveform.
Harmonic of the BE waveform. absolute value of the wave type used to normalize the response waveform.
"""
harm
=
abs
(
harm
)
...
...
@@ -1066,20 +1067,20 @@ class BEPSndfPixel(object):
Notes
-----
*Typical things that change during BEPS*
1. BE parameters:
a. Center Frequency, Band Width - changes in the BE_bin_w
b. Amplitude, Phase Variation, Band Edge Smoothing, Band Edge Trim - Harder to find out what happened
exactly
- FFT should show changes
c. BE repeats, desired duration - changes in the spectrogram length?
2. VS Parameters:
a. Amplitude, Phase shift - Changes in the AC_amp_vec / DC offset
b. Offset, Read voltage - Shows up in the DC offset
c. Steps per full Cycle - Changes in DC offset / AC amplitude ....
d. Number of cycles, Cycle fraction, In and out of field - changes in the length of DC offset etc.
e. FORC - should all show up in DC / AC amplitude
3. IO parameters : don't change really
4. grid parameters : cannot do anything about this.
*Typical things that change during BEPS*
1. BE parameters:
a. Center Frequency, Band Width - changes in the BE_bin_w
b. Amplitude, Phase Variation, Band Edge Smoothing, Band Edge Trim - Harder to find out what happened
exactly
- FFT should show changes
c. BE repeats, desired duration - changes in the spectrogram length?
2. VS Parameters:
a. Amplitude, Phase shift - Changes in the AC_amp_vec / DC offset
b. Offset, Read voltage - Shows up in the DC offset
c. Steps per full Cycle - Changes in DC offset / AC amplitude ....
d. Number of cycles, Cycle fraction, In and out of field - changes in the length of DC offset etc.
e. FORC - should all show up in DC / AC amplitude
3. IO parameters : don't change really
4. grid parameters : cannot do anything about this.
"""
disp_on
=
True
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment