feat(review): fix docstrings

aodn · Jul 14, 2020 · 3388992 · 3388992
1 parent a8ca87c
commit 3388992
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/AutomaticQC/SpikeClassifiers/imosSpikeClassifierHampel.m b/AutomaticQC/SpikeClassifiers/imosSpikeClassifierHampel.m
@@ -1,5 +1,5 @@
 function [spikes, fsignal] = imosSpikeClassifierHampel(signal, half_window_width, madfactor, lower_mad_limit)
-% function spikes, fsignal = imosSpikeClassifierHampel(signal, half_window_width, madfactor)
+% function spikes, fsignal = imosSpikeClassifierHampel(signal, half_window_width, madfactor, lower_mad_limit)
 %
 % A wrapper to Hampel classifier.The hampel method is a robust parametric denoising filter that uses
 % the MAD deviation (scaled) from the median in a pre-defined centred window.

diff --git a/AutomaticQC/SpikeClassifiers/imosSpikeClassifiersLimits.m b/AutomaticQC/SpikeClassifiers/imosSpikeClassifiersLimits.m
@@ -15,9 +15,9 @@
 %
 % len = 100
 % [limits] = imosTimeSeriesSpikeQCLimits(len)
-% assert(limits.hampel.window.min==1)
-% assert(limits.hampel.window.max=len/2)
-% assert(limits.otsu_savgol.pdeg.min=2)
+% assert(limits.hampel_half_window_width.min==1)
+% assert(limits.hampel_half_window_width.max==len/2)
+% assert(limits.hampel_madfactor.max = 20)
 %
 % author: hugo.oliveira@utas.edu.au
 %