Analysis modules - Revision history

Sebastian Kuhlen: /* Data genreation */

2025-03-21T12:28:27Z

Data genreation

Sebastian Kuhlen: /* Data genreation */

2025-03-21T12:27:55Z

Data genreation

Sebastian Kuhlen: /* Basic math */

2024-09-27T19:28:51Z

Basic math

Sebastian Kuhlen: /* Buffer operations */

2024-05-18T11:50:29Z

Buffer operations

Sebastian Kuhlen: /* Statistics */

2024-05-18T11:23:40Z

Statistics

Sebastian Kuhlen: /* Buffer operations */

2024-05-18T11:15:15Z

Buffer operations

Sebastian Kuhlen: /* Buffer operations */

2024-05-18T11:14:32Z

Buffer operations

Sebastian Kuhlen: /* Advanced math */

2024-05-18T09:49:47Z

Advanced math

Sebastian Kuhlen: /* atan2 */

2024-02-08T16:08:26Z

atan2

Sebastian Kuhlen: /* loess */

2021-10-19T18:47:15Z

loess

← Older revision		Revision as of 12:28, 21 March 2025
Line 1,207:		Line 1,207:

	=== info ===		=== info ===
		+
		+	'''Available since phyphox file format 1.19 (phyphox 1.2.0)'''

	The info module is used as a generic way to access system information like the device's battery level. This is typically data that only has a use-case in few specific applications and that cannot reasonably be considered as a sensor. It's more about metadata for the experiment (although this of course is not a precise criterium).		The info module is used as a generic way to access system information like the device's battery level. This is typically data that only has a use-case in few specific applications and that cannot reasonably be considered as a sensor. It's more about metadata for the experiment (although this of course is not a precise criterium).

@@ Line 1,204: / Line 1,204: @@
 : ''output''
 : ''as'' required, '''Available since phyphox file format 1.12 (phyphox 1.1.8)'''
 == Logic ==

@@ Line 39: / Line 39: @@
 === add ===
-Calculates the sum of all inputs element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated.
+Calculates the sum of all inputs element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated. (Exception: If any buffer is empty, the result will be an empty buffer, too.)
 ;''summand''
@@ Line 52: / Line 52: @@
 === divide ===
-Calculates the quotient of multiple divisors from a single dividend element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated.
+Calculates the quotient of multiple divisors from a single dividend element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated. (Exception: If any buffer is empty, the result will be an empty buffer, too.)
 For this simple function you can leave out the ''as'' attribute. If you do so, the first input will be used as dividend and all subsequent values as divisors.
@@ Line 71: / Line 71: @@
 === gcd (greatest common divisor) ===
-Calculates the greatest common divisor of two inputs element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated.
+Calculates the greatest common divisor of two inputs element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated. (Exception: If any buffer is empty, the result will be an empty buffer, too.)
 ;''value''
@@ Line 84: / Line 84: @@
 === lcm (least common multiple) ===
-Calculates the least common multiple of two inputs element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated.
+Calculates the least common multiple of two inputs element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated. (Exception: If any buffer is empty, the result will be an empty buffer, too.)
 ;''value''
@@ Line 112: / Line 112: @@
 === multiply ===
-Calculates the product of all inputs element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated.
+Calculates the product of all inputs element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated. (Exception: If any buffer is empty, the result will be an empty buffer, too.)
 ;''factor''
@@ Line 125: / Line 125: @@
 === power ===
-Calculates the power of a base and an exponent element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated.
+Calculates the power of a base and an exponent element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated. (Exception: If any buffer is empty, the result will be an empty buffer, too.)
 ;''base''
@@ Line 166: / Line 166: @@
 === subtract ===
-Calculates the difference of multiple subtrahends from a single minuend element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated.
+Calculates the difference of multiple subtrahends from a single minuend element-wise and writes it to a single output buffer. This module will write as many values as there are values in the biggest input buffer. If a buffer is shorter than the others (especially if one input is a single value), its last value will be repeated. (Exception: If any buffer is empty, the result will be an empty buffer, too.)
 For this simple function you can leave out the ''as'' attribute. If you do so, the first input will be used as minuend and all subsequent values as subtrahends.

@@ Line 685: / Line 685: @@
 : ''output''
 : ''as'' not required
 === first ===

@@ Line 394: / Line 394: @@
 : ''as'' not required
 ;''binCounts''
 : ''output''
 : ''as'' not required

@@ Line 938: / Line 938: @@
 === split ===
-Split
+'''Available since phyphox file format 1.18 (phyphox 1.1.16)'''
 Takes ''data'' as input and splits it into two buffers at the given ''index''. A third parameter ''overlap'' allows to set a number of elements from before the split index that will also end up in the second buffer. ''index'' defaults to the length of the input data if not given, i.e. the entire input is returned as the first output without any splitting, which only makes sense in combination with an overlap, for example to take all data from a buffer associated with the input from a sensor and setting "overlap" such that a certain number of values is retained as a starting point for the next iteration.

@@ Line 914: / Line 914: @@
 : ''as'' required
 : Number of inputs: One or none.
 === subrange ===
@@ Line 954: / Line 1,008: @@
 : ''as'' not required
 : '''Multiple may be defined!'''
 === threshold ===

@@ Line 490: / Line 490: @@
 : ''as'' not required
-=== loess ===
+=== interpolate ===
-Smooths data using locally estimated scatterplot smoothing (LOESS) aka local regression. It takes x and y data as well as a list of x values at which to generate smoothed y values. Additionally, you have to set the width of the windowing function (tri-cubic window). Smoothed data can be generated at the same x positions as the source data or anywhere as long as it is near the source data, so that it contributes within the window width. The data does not need to be ordered.
+Note that both, x and xi need to be monotic (i.e. ordered).
-Optionally, you can use three outputs to directly get the local fit parameters yi0, yi1 and yi2 to the function y(x) = yi0 + yi1 * x + yi2 * x². In this formula, the axis for x is shifted such that x=0 is in place of the evaluated position xi. If the input is position data versus time, these parameters are great estimates for a (smoothed) position, the momentary velocity and the momentary acceleration. Note, that if you describe the location as a function of time from an initial location, velocity and acceleration, you would have the formula y(t) = y0 + v*t + 1/2 a*t², so if you want to extract location y0, velocity v and acceleration a from the fit parameters, you need to multiply the yi2 by two as yi2 = a/2.
+;''method''
 ;''x''
@@ Line 508: / Line 513: @@
 : Source data y values
-;''d''
+;''xi''
 : ''input''
 : ''as'' required
 : Number of inputs: Exactly one
-: Width of the tri-cubic weighting window
+: x values at which output should be calculated
-;''xi''
+;''in''
 : ''input''
-: ''as'' required
+: ''as'' not required
 : Number of inputs: Exactly one
-;''yi0''
+;''out''
 : ''output''
 : ''as'' not required
-Interpolate input data. It takes x and y values from the source data and a buffer with x values at which to interpolate the y input data. The attribute ''method'' determines the method for interpolation, which can be ''previous'' (the y value corresponding to the x value immediately preceeding the x value at which the data is to be interpolated), ''next'' (the y value corresponding to the x value immediately succeeding the x value at which the data is to be interpolated), ''nearest'' (the y value corresponding to the nearest x value to the x value at which the data is to be interpolated) and ''linear'' (the y is interpolated linearly). In all cases, the first or the last y value is simply reused if the evaluated x value is entirely outside the range of the input x values.
+=== loess ===
-Note that both, x and xi need to be monotic (i.e. ordered).
+Smooths data using locally estimated scatterplot smoothing (LOESS) aka local regression. It takes x and y data as well as a list of x values at which to generate smoothed y values. Additionally, you have to set the width of the windowing function (tri-cubic window). Smoothed data can be generated at the same x positions as the source data or anywhere as long as it is near the source data, so that it contributes within the window width. The data does not need to be ordered.
-;''method''
+Optionally, you can use three outputs to directly get the local fit parameters yi0, yi1 and yi2 to the function y(x) = yi0 + yi1 * x + yi2 * x². In this formula, the axis for x is shifted such that x=0 is in place of the evaluated position xi. If the input is position data versus time, these parameters are great estimates for a (smoothed) position, the momentary velocity and the momentary acceleration. Note, that if you describe the location as a function of time from an initial location, velocity and acceleration, you would have the formula y(t) = y0 + v*t + 1/2 a*t², so if you want to extract location y0, velocity v and acceleration a from the fit parameters, you need to multiply the yi2 by two as yi2 = a/2.
 ;''x''
@@ Line 557: / Line 556: @@
 : Number of inputs: Exactly one
 : Source data y values
 ;''xi''
@@ Line 564: / Line 569: @@
 : x values at which output should be calculated
-;''out''
+;''yi0''
 : ''output''
 : ''as'' not required
-=== integrate ===
+;''yi1''
-Performs a simple integration of a single input by summing all elements and returning each step of the summation as a value. It will write as many values as there are values in the input buffer. So, if the input is a three-value array [v1, v2, v3], the output will be [v1, v1+v2, v1+v2+v3].
+;''yi2''
 === periodicity ===

@@ Line 239: / Line 239: @@
 === atan2 ===
-Calculates the two-argument variant of the inverse tangens (corresponding to atan(y/x)) element-wise and writes it to a single output buffer. This module will write as many values as there are values in the input buffer. The module will calculate in radians unless degrees are specified using the ''deg'' attribute.
+Calculates the two-argument variant of the inverse tangens (corresponding to atan(y/x), see [https://en.wikipedia.org/wiki/Atan2 Wikipadia] for an explanation) element-wise and writes it to a single output buffer. This module will write as many values as there are values in the input buffer. The module will calculate in radians unless degrees are specified using the ''deg'' attribute.
 ;''deg''