Skip to content

Commit 0363cdb

Browse files
committed
Update processor methods documentation and statistics in CSV files
1 parent 49fd0db commit 0363cdb

File tree

6 files changed

+142
-132
lines changed

6 files changed

+142
-132
lines changed

doc/processor_methods_image.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_hough_circle_peaks`,Compute peak detection based on a circle Hough transform
5151
:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_ifft`,Compute iFFT with :py:func:`cdl.computation.image.compute_ifft`
5252
:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_im`,Compute imaginary part with :py:func:`cdl.computation.image.compute_im`
53+
:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_inverse`,Compute inverse
5354
:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_laplace`,Compute Laplace filter
5455
:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_line_profile`,Compute profile along a vertical or horizontal line
5556
:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_log10`,Compute Log10 with :py:func:`cdl.computation.image.compute_log10`

doc/processor_methods_nb.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
67,100,167
1+
71,101,172

doc/processor_methods_signal.csv

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_bandstop`,Compute band-stop filter
1111
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_bandwidth_3db`,Compute bandwidth at -3dB
1212
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_calibration`,Compute data linear calibration
13+
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_cartesian2polar`,Convert cartesian to polar coordinates
1314
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_clip`,Compute maximum data clipping
1415
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_contrast`,Compute contrast with :py:func:`cdl.computation.signal.compute_contrast`
1516
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_convolution`,Compute convolution
@@ -33,6 +34,7 @@
3334
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_im`,Compute imaginary part with :py:func:`cdl.computation.signal.compute_im`
3435
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_integral`,Compute integral with :py:func:`cdl.computation.signal.compute_integral`
3536
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_interpolation`,Compute interpolation
37+
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_inverse`,Compute inverse
3638
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_log10`,Compute Log10 with :py:func:`cdl.computation.signal.compute_log10`
3739
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_lowpass`,Compute high-pass filter
3840
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_magnitude_spectrum`,Compute magnitude spectrum
@@ -45,6 +47,7 @@
4547
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_overlapping_allan_variance`,Compute overlapping Allan variance
4648
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_peak_detection`,Detect peaks from data
4749
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_phase_spectrum`,Compute phase spectrum
50+
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_polar2cartesian`,Convert polar to cartesian coordinates
4851
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_polyfit`,Compute polynomial fitting curve
4952
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_power`,Compute power with :py:func:`cdl.computation.signal.compute_power`
5053
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_product`,Compute product with :py:func:`cdl.computation.signal.compute_product`
@@ -65,3 +68,4 @@
6568
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_wiener`,Compute Wiener filter
6669
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_windowing`,Compute windowing
6770
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_x_at_minmax`,Compute x at min/max
71+
:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_x_at_y`,Compute x at y with :py:func:`cdl.computation.signal.compute_x_at_y`

doc/validation_statistics.csv

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Number of compute functions,58,94,152
2-
Number of validated compute functions,46,82,128
3-
Percentage of validated compute functions,79%,87%,84%
1+
Number of compute functions,62,95,157
2+
Number of validated compute functions,50,83,133
3+
Percentage of validated compute functions,80%,87%,84%

0 commit comments

Comments
 (0)