stats

stats — 2D statistical functions

Synopsis




gdouble     gwy_data_field_get_max          (GwyDataField *a);
gdouble     gwy_data_field_get_min          (GwyDataField *a);
gdouble     gwy_data_field_get_avg          (GwyDataField *a);
gdouble     gwy_data_field_get_rms          (GwyDataField *a);
gdouble     gwy_data_field_get_sum          (GwyDataField *a);
gdouble     gwy_data_field_get_surface_area (GwyDataField *a,
                                             GwyInterpolationType interpolation);
gdouble     gwy_data_field_area_get_max     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);
gdouble     gwy_data_field_area_get_min     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);
gdouble     gwy_data_field_area_get_avg     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);
gdouble     gwy_data_field_area_get_rms     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);
gdouble     gwy_data_field_area_get_sum     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);
gdouble     gwy_data_field_area_get_surface_area
                                            (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height,
                                             GwyInterpolationType interpolation);
void        gwy_data_field_get_stats        (GwyDataField *data_field,
                                             gdouble *avg,
                                             gdouble *ra,
                                             gdouble *rms,
                                             gdouble *skew,
                                             gdouble *kurtosis);
void        gwy_data_field_area_get_stats   (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height,
                                             gdouble *avg,
                                             gdouble *ra,
                                             gdouble *rms,
                                             gdouble *skew,
                                             gdouble *kurtosis);
gint        gwy_data_field_get_line_stat_function
                                            (GwyDataField *data_field,
                                             GwyDataLine *target_line,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow,
                                             GwySFOutputType type,
                                             GtkOrientation orientation,
                                             GwyInterpolationType interpolation,
                                             GwyWindowingType windowing,
                                             gint nstats);
void        gwy_data_field_slope_distribution
                                            (GwyDataField *dfield,
                                             GwyDataLine *derdist,
                                             gint kernel_size);
gdouble     gwy_data_field_get_area_max     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);
gdouble     gwy_data_field_get_area_min     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);
gdouble     gwy_data_field_get_area_avg     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);
gdouble     gwy_data_field_get_area_rms     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);
gdouble     gwy_data_field_get_area_sum     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);
gdouble     gwy_data_field_get_area_surface_area
                                            (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow,
                                             GwyInterpolationType interpolation);
void        gwy_data_field_get_area_stats   (GwyDataField *data_field,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow,
                                             gdouble *avg,
                                             gdouble *ra,
                                             gdouble *rms,
                                             gdouble *skew,
                                             gdouble *kurtosis);

Description

Details

gwy_data_field_get_max ()

gdouble     gwy_data_field_get_max          (GwyDataField *a);

Get maximum value of the GwyDataField.

a : A data field
Returns :maximum value of the GwyDataField

gwy_data_field_get_min ()

gdouble     gwy_data_field_get_min          (GwyDataField *a);

Get minimum value of the GwyDataField

a : A data field
Returns : minimum value of the GwyDataField

gwy_data_field_get_avg ()

gdouble     gwy_data_field_get_avg          (GwyDataField *a);

Averages values of GwyDataField

a : A data field
Returns : Average value of GwyDataField

gwy_data_field_get_rms ()

gdouble     gwy_data_field_get_rms          (GwyDataField *a);

Evaluates Root mean square value of GwyDataField

a : A data field
Returns : RMS of GwyDataField

gwy_data_field_get_sum ()

gdouble     gwy_data_field_get_sum          (GwyDataField *a);

Sum all the values in GwyDataField

a : A data field
Returns : sum of GwyDataField.

gwy_data_field_get_surface_area ()

gdouble     gwy_data_field_get_surface_area (GwyDataField *a,
                                             GwyInterpolationType interpolation);

Computes surface area.

a : data field
interpolation : interpolation method
Returns : surface area

gwy_data_field_area_get_max ()

gdouble     gwy_data_field_area_get_max     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);

Finds maximum value in a rectangular part of a data field.

dfield : A data field
col : Upper-left column coordinate.
row : Upper-left row coordinate.
width : Area width (number of columns).
height : Area height (number of rows).
Returns : The maximum value, and undefined value (currently -G_MAXDOUBLE) for zero width or height.

Since 1.2:


gwy_data_field_area_get_min ()

gdouble     gwy_data_field_area_get_min     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);

Finds minimum value in a rectangular part of a data field.

dfield : A data field
col : Upper-left column coordinate.
row : Upper-left row coordinate.
width : Area width (number of columns).
height : Area height (number of rows).
Returns : The minimum value, and undefined value (currently G_MAXDOUBLE) for zero width or height.

Since 1.2.


gwy_data_field_area_get_avg ()

gdouble     gwy_data_field_area_get_avg     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);

Averages values of a rectangular part of a data field.

dfield : A data field
col : Upper-left column coordinate.
row : Upper-left row coordinate.
width : Area width (number of columns).
height : Area height (number of rows).
Returns : The average value.

Since 1.2.


gwy_data_field_area_get_rms ()

gdouble     gwy_data_field_area_get_rms     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);

Computes root mean square value of a rectangular part of a data field.

dfield : A data field
col : Upper-left column coordinate.
row : Upper-left row coordinate.
width : Area width (number of columns).
height : Area height (number of rows).
Returns : The root mean square value.

Since 1.2.


gwy_data_field_area_get_sum ()

gdouble     gwy_data_field_area_get_sum     (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height);

Sums values of a rectangular part of a data field.

dfield : A data field
col : Upper-left column coordinate.
row : Upper-left row coordinate.
width : Area width (number of columns).
height : Area height (number of rows).
Returns : The value sum.

Since 1.2.


gwy_data_field_area_get_surface_area ()

gdouble     gwy_data_field_area_get_surface_area
                                            (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height,
                                             GwyInterpolationType interpolation);

Computes surface area of a rectangular part of a data field.

dfield : A data field
col : Upper-left column coordinate.
row : Upper-left row coordinate.
width : Area width (number of columns).
height : Area height (number of rows).
interpolation : Interpolation method.
Returns : The surface area.

Since 1.2.


gwy_data_field_get_stats ()

void        gwy_data_field_get_stats        (GwyDataField *data_field,
                                             gdouble *avg,
                                             gdouble *ra,
                                             gdouble *rms,
                                             gdouble *skew,
                                             gdouble *kurtosis);

Computes basic statistical quantities in one interation over the datafield.

data_field : A data field
avg : average height value of the surface
ra : average value of the irregularities
rms : root mean square value of the irregularities (Rq)
skew : skew (symmetry of height distribution)
kurtosis : kurtosis (peakedness of height ditribution)

gwy_data_field_area_get_stats ()

void        gwy_data_field_area_get_stats   (GwyDataField *dfield,
                                             gint col,
                                             gint row,
                                             gint width,
                                             gint height,
                                             gdouble *avg,
                                             gdouble *ra,
                                             gdouble *rms,
                                             gdouble *skew,
                                             gdouble *kurtosis);

dfield :
col :
row :
width :
height :
avg :
ra :
rms :
skew :
kurtosis :

gwy_data_field_get_line_stat_function ()

gint        gwy_data_field_get_line_stat_function
                                            (GwyDataField *data_field,
                                             GwyDataLine *target_line,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow,
                                             GwySFOutputType type,
                                             GtkOrientation orientation,
                                             GwyInterpolationType interpolation,
                                             GwyWindowingType windowing,
                                             gint nstats);

data_field :
target_line :
ulcol :
ulrow :
brcol :
brrow :
type :
orientation :
interpolation :
windowing :
nstats :
Returns :

gwy_data_field_slope_distribution ()

void        gwy_data_field_slope_distribution
                                            (GwyDataField *dfield,
                                             GwyDataLine *derdist,
                                             gint kernel_size);

Computes angular slope distribution.

dfield : A data field.
derdist : A data line to fill with angular slope distribution. Its resolution determines resolution of the distribution.
kernel_size : If positive, local plane fitting will be used for slope computation; if nonpositive, plain central derivations will be used.

Since 1.4.


gwy_data_field_get_area_max ()

gdouble     gwy_data_field_get_area_max     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);

Warning

gwy_data_field_get_area_max is deprecated and should not be used in newly-written code.

a :
ulcol :
ulrow :
brcol :
brrow :
Returns :

gwy_data_field_get_area_min ()

gdouble     gwy_data_field_get_area_min     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);

Warning

gwy_data_field_get_area_min is deprecated and should not be used in newly-written code.

a :
ulcol :
ulrow :
brcol :
brrow :
Returns :

gwy_data_field_get_area_avg ()

gdouble     gwy_data_field_get_area_avg     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);

Warning

gwy_data_field_get_area_avg is deprecated and should not be used in newly-written code.

a :
ulcol :
ulrow :
brcol :
brrow :
Returns :

gwy_data_field_get_area_rms ()

gdouble     gwy_data_field_get_area_rms     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);

Warning

gwy_data_field_get_area_rms is deprecated and should not be used in newly-written code.

a :
ulcol :
ulrow :
brcol :
brrow :
Returns :

gwy_data_field_get_area_sum ()

gdouble     gwy_data_field_get_area_sum     (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow);

Warning

gwy_data_field_get_area_sum is deprecated and should not be used in newly-written code.

a :
ulcol :
ulrow :
brcol :
brrow :
Returns :

gwy_data_field_get_area_surface_area ()

gdouble     gwy_data_field_get_area_surface_area
                                            (GwyDataField *a,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow,
                                             GwyInterpolationType interpolation);

Warning

gwy_data_field_get_area_surface_area is deprecated and should not be used in newly-written code.

a :
ulcol :
ulrow :
brcol :
brrow :
interpolation :
Returns :

gwy_data_field_get_area_stats ()

void        gwy_data_field_get_area_stats   (GwyDataField *data_field,
                                             gint ulcol,
                                             gint ulrow,
                                             gint brcol,
                                             gint brrow,
                                             gdouble *avg,
                                             gdouble *ra,
                                             gdouble *rms,
                                             gdouble *skew,
                                             gdouble *kurtosis);

Warning

gwy_data_field_get_area_stats is deprecated and should not be used in newly-written code.

data_field :
ulcol :
ulrow :
brcol :
brrow :
avg :
ra :
rms :
skew :
kurtosis :