![]() |
![]() |
Gwyddion Data Processing Library Reference Manual | ![]() |
---|
linestatslinestats — One-dimensional statistical functions |
gdouble gwy_data_line_get_max (GwyDataLine *data_line); gdouble gwy_data_line_get_min (GwyDataLine *data_line); gdouble gwy_data_line_get_avg (GwyDataLine *data_line); gdouble gwy_data_line_get_rms (GwyDataLine *data_line); gdouble gwy_data_line_get_sum (GwyDataLine *data_line); gdouble gwy_data_line_part_get_max (GwyDataLine *data_line, gint from, gint to); gdouble gwy_data_line_part_get_min (GwyDataLine *data_line, gint from, gint to); gdouble gwy_data_line_part_get_avg (GwyDataLine *data_line, gint from, gint to); gdouble gwy_data_line_part_get_rms (GwyDataLine *data_line, gint from, gint to); gdouble gwy_data_line_part_get_sum (GwyDataLine *data_line, gint from, gint to); gdouble gwy_data_line_get_modus (GwyDataLine *data_line, gint histogram_steps); gdouble gwy_data_line_part_get_modus (GwyDataLine *data_line, gint from, gint to, gint histogram_steps); gdouble gwy_data_line_get_length (GwyDataLine *data_line); void gwy_data_line_dh (GwyDataLine *data_line, GwyDataLine *target_line, gdouble ymin, gdouble ymax, gint nsteps); void gwy_data_line_cdh (GwyDataLine *data_line, GwyDataLine *target_line, gdouble ymin, gdouble ymax, gint nsteps); void gwy_data_line_da (GwyDataLine *data_line, GwyDataLine *target_line, gdouble ymin, gdouble ymax, gint nsteps); void gwy_data_line_cda (GwyDataLine *data_line, GwyDataLine *target_line, gdouble ymin, gdouble ymax, gint nsteps); void gwy_data_line_acf (GwyDataLine *data_line, GwyDataLine *target_line); void gwy_data_line_hhcf (GwyDataLine *data_line, GwyDataLine *target_line); void gwy_data_line_psdf (GwyDataLine *data_line, GwyDataLine *target_line, gint windowing, gint interpolation);
gdouble gwy_data_line_get_max (GwyDataLine *data_line);
Finds the maximum value of a data line.
data_line : | A data line. |
Returns : | The maximum value. |
gdouble gwy_data_line_get_min (GwyDataLine *data_line);
Finds the minimum value of a data line.
data_line : | A data line. |
Returns : | The minimum value. |
gdouble gwy_data_line_get_avg (GwyDataLine *data_line);
Computes average value of a data line.
data_line : | A data line. |
Returns : | Average value |
gdouble gwy_data_line_get_rms (GwyDataLine *data_line);
Computes root mean square value of a data line.
data_line : | A data line. |
Returns : | Root mean square deviation of values. |
gdouble gwy_data_line_get_sum (GwyDataLine *data_line);
Computes sum of all values in a data line.
data_line : | A data line. |
Returns : | sum of all the values. |
gdouble gwy_data_line_part_get_max (GwyDataLine *data_line, gint from, gint to);
Finds the maximum value of a part of a data line.
data_line : | A data line. |
from : | Index the line part starts at. |
to : | Index the line part ends at + 1. |
Returns : | Maximum within given interval. |
gdouble gwy_data_line_part_get_min (GwyDataLine *data_line, gint from, gint to);
Finds the minimum value of a part of a data line.
data_line : | A data line. |
from : | Index the line part starts at. |
to : | Index the line part ends at + 1. |
Returns : | Minimum within given interval. |
gdouble gwy_data_line_part_get_avg (GwyDataLine *data_line, gint from, gint to);
Computes mean value of all values in a part of a data line.
data_line : | A data line. |
from : | Index the line part starts at. |
to : | Index the line part ends at + 1. |
Returns : | Average value within given interval. |
gdouble gwy_data_line_part_get_rms (GwyDataLine *data_line, gint from, gint to);
Computes root mean square value of a part of a data line.
data_line : | A data line. |
from : | Index the line part starts at. |
to : | Index the line part ends at + 1. |
Returns : | Root mean square deviation of heights within a given interval |
gdouble gwy_data_line_part_get_sum (GwyDataLine *data_line, gint from, gint to);
Computes sum of all values in a part of a data line.
data_line : | A data line. |
from : | Index the line part starts at. |
to : | Index the line part ends at + 1. |
Returns : | Sum of all values within the interval. |
gdouble gwy_data_line_get_modus (GwyDataLine *data_line, gint histogram_steps);
Finds approximate modus of a data line.
As each number in the data line is usually unique, this function does not return modus of the data itself, but modus of a histogram.
data_line : | A data line. |
histogram_steps : | Number of histogram steps used for modus searching, pass a nonpositive number to autosize. |
Returns : | The modus. |
gdouble gwy_data_line_part_get_modus (GwyDataLine *data_line, gint from, gint to, gint histogram_steps);
Finds approximate modus of a data line part.
data_line : | A data line. |
from : | The index in data_line to start from (inclusive). |
to : | The index in data_line to stop (noninclusive). |
histogram_steps : | Number of histogram steps used for modus searching, pass a nonpositive number to autosize. |
Returns : | The modus. |
gdouble gwy_data_line_get_length (GwyDataLine *data_line);
Calculates physical length of a data line.
The length is calculated from approximation by straight segments between values.
data_line : | A data line to compute length of. |
Returns : | The line length. |
void gwy_data_line_dh (GwyDataLine *data_line, GwyDataLine *target_line, gdouble ymin, gdouble ymax, gint nsteps);
Computes distribution of heights in interval [ymin, ymax).
If the interval is (0, 0) it computes the distribution from real data minimum and maximum value.
data_line : | A data line. |
target_line : | Data line to store height distribution function to. It will be resized to nsteps. |
ymin : | Height distribution minimum value. |
ymax : | Height distribution maximum value. |
nsteps : | Number of histogram steps. |
void gwy_data_line_cdh (GwyDataLine *data_line, GwyDataLine *target_line, gdouble ymin, gdouble ymax, gint nsteps);
Computes cumulative distribution of heighs in interval [ymin, ymax).
If the interval is (0, 0) it computes the distribution from real data minimum and maximum value.
data_line : | A data line. |
target_line : | Data line to store height distribution function to. It will be resized to nsteps. |
ymin : | Height distribution minimum value. |
ymax : | Height distribution maximum value. |
nsteps : | Number of histogram steps. |
void gwy_data_line_da (GwyDataLine *data_line, GwyDataLine *target_line, gdouble ymin, gdouble ymax, gint nsteps);
Computes distribution of angles in interval [ymin, ymax).
If the interval is (0, 0) it computes the distribution from real data minimum and maximum angle value.
data_line : | A data line. |
target_line : | Data line to store angle distribution function to. |
ymin : | Angle distribution minimum value. |
ymax : | Angle distribution maximum value. |
nsteps : | Mumber of angular histogram steps. |
void gwy_data_line_cda (GwyDataLine *data_line, GwyDataLine *target_line, gdouble ymin, gdouble ymax, gint nsteps);
Computes cumulative distribution of angles in interval [ymin, ymax).
If the interval is (0, 0) it computes the distribution from real data minimum and maximum angle value.
data_line : | A data line. |
target_line : | Data line to store angle distribution function to. It will be resized to nsteps. |
ymin : | Angle distribution minimum value. |
ymax : | Angle distribution maximum value. |
nsteps : | Number of angular histogram steps. |
void gwy_data_line_acf (GwyDataLine *data_line, GwyDataLine *target_line);
Coputes autocorrelation function and stores the values in target_line
data_line : | A data line. |
target_line : | Data line to store autocorrelation function to. It will be resized to data_line size. |
void gwy_data_line_hhcf (GwyDataLine *data_line, GwyDataLine *target_line);
Computes height-height correlation function and stores results in target_line.
data_line : | A data line. |
target_line : | Data line to store height-height function to. It will be resized to data_line size. |
void gwy_data_line_psdf (GwyDataLine *data_line, GwyDataLine *target_line, gint windowing, gint interpolation);
Copmutes power spectral density function and stores the values in target_line.
data_line : | A data line. Its contents is destroyes and even its size may change. |
target_line : | Data line to store power spectral density function to. It will be resized to data_line size. |
windowing : | Windowing method to use. |
interpolation : | Interpolation method to use. |
<< level | simplefft >> |