V1.1

docs/source/quickstart.rst

@@ -29,8 +29,10 @@ Analysis requires the sampling rate for your data. If you know this *a priori*,
 
 
 **process(dataset, fs, windowsize=0.75, report_time=False,
-calc_freq=False, freq_method='welch', interp_clipping=True,
-interp_threshold=1020, hampel_correct=False, bpmmin=40, bpmmax=180)**
+calc_freq=False, freq_method='welch', interp_clipping=True, 
+clipping_scale=True, interp_threshold=1020, hampel_correct=False, 
+bpmmin=40, bpmmax=180, reject_segmentwise=False, measures = {},
+working_data = {})**
 
 requires two arguments:
 
@@ -43,9 +45,16 @@ Several optional arguments are available:
 * **report_time:** _optional_ whether to report total processing time of process() loop.
 * **calc_fft:** _optional_ whether to calculate frequency domain measures. Default = false Note: can cause slowdowns in some cases.
 * **calc_freq:** _optional_ whether to calculate frequency domain measures. Default = false Note: can cause slowdowns in some cases.
-* **interp_clipping**: if True, clipping parts of the signal are identified and the implied peak shape is interpolated. Default=True
+* **freq_method:** _optional_ method used to extract the frequency spectrum. Available: 'fft' (Fourier Analysis), 'periodogram', and 'welch' (Welch's method), Default = 'welch'
+* **interp_clipping:** if True, clipping parts of the signal are identified and the implied peak shape is interpolated. Default=True
+* **clipping_scale:** whether to scale the data priod to clipping detection. Can correct errors if signal amplitude has been affected after digitization (for example through filtering). Default = false
 * **interp_threshold**: the amplitude threshold beyond which will be checked for clipping. Recommended is to take this as the maximum value of the ADC with some margin for signal noise (default 1020, default ADC max 1024) 
-
+* **hampel_correct:** whether to reduce noisy segments using large median filter. Disabled by default due to computational complexity, and generally it is not necessary. Default = false.
+* **bpmmin:** minimum value to see as likely for BPM when fitting peaks. Default = 40
+* **bpmmax:** maximum value to see as likely for BPM when fitting peaks. Default = 180
+* **reject_segmentwise:** whether to reject segments with more than 30% rejected beats. By default looks at segments of 10 beats at a time. Default = false.
+* **measures:** measures dict in which results are stored. Custom dictionary can be passed, otherwise one is created and returned.
+* **working_data:** working_data dict in which results are stored. Custom dictionary can be passed, otherwise one is created and returned.
 
 Two :code:`dict{}` objects are returned: one working data dict, and one containing all measures. Access as such: