| Top | Description | Object Hierarchy | Implemented Interfaces |
#include <libprocess/gwyprocess.h>
GwyCurveCalibrationData;
#define gwy_caldata_duplicate (caldata)
GwyCalData * gwy_caldata_new (gint ndata);
void gwy_caldata_resize (GwyCalData *caldata,
gint ndata);
void gwy_caldata_append (GwyCalData *caldata,
GwyCalData *sec);
gint gwy_caldata_get_ndata (GwyCalData *caldata);
gdouble * gwy_caldata_get_x (GwyCalData *caldata);
gdouble * gwy_caldata_get_y (GwyCalData *caldata);
gdouble * gwy_caldata_get_z (GwyCalData *caldata);
gdouble * gwy_caldata_get_xerr (GwyCalData *caldata);
gdouble * gwy_caldata_get_yerr (GwyCalData *caldata);
gdouble * gwy_caldata_get_zerr (GwyCalData *caldata);
gdouble * gwy_caldata_get_xunc (GwyCalData *caldata);
gdouble * gwy_caldata_get_yunc (GwyCalData *caldata);
gdouble * gwy_caldata_get_zunc (GwyCalData *caldata);
void gwy_caldata_get_range (GwyCalData *caldata,
gdouble *xfrom,
gdouble *xto,
gdouble *yfrom,
gdouble *yto,
gdouble *zfrom,
gdouble *zto);
void gwy_caldata_set_range (GwyCalData *caldata,
gdouble xfrom,
gdouble xto,
gdouble yfrom,
gdouble yto,
gdouble zfrom,
gdouble zto);
GwySIUnit * gwy_caldata_get_si_unit_x (GwyCalData *caldata);
GwySIUnit * gwy_caldata_get_si_unit_y (GwyCalData *caldata);
GwySIUnit * gwy_caldata_get_si_unit_z (GwyCalData *caldata);
void gwy_caldata_set_si_unit_x (GwyCalData *caldata,
GwySIUnit *si_unit);
void gwy_caldata_set_si_unit_y (GwyCalData *caldata,
GwySIUnit *si_unit);
void gwy_caldata_set_si_unit_z (GwyCalData *caldata,
GwySIUnit *si_unit);
void gwy_caldata_setup_interpolation (GwyCalData *caldata);
void gwy_caldata_interpolate (GwyCalData *caldata,
gdouble x,
gdouble y,
gdouble z,
gdouble *xerr,
gdouble *yerr,
gdouble *zerr,
gdouble *xunc,
gdouble *yunc,
gdouble *zunc);
void gwy_caldata_save_data (GwyCalData *caldata,
gchar *filename);
gboolean gwy_caldata_inside (GwyCalData *caldata,
gdouble x,
gdouble y,
gdouble z);
GwyCalDataClass;
GwyCalData;
GwyCalData is an object representing general calibration data of a SPM system. Any point in the volume that can be reached by SPM scanner can be characterized by two vectors: error and uncertainty. Errors can be used for further data correction, uncertainties for propagation and determination of final uncertainty of results of direct measurements or statistical functions. Using different strategies a different number of these local calibration data can be obtained, starting from single uncertainty applied for whole system up to complex determination of local SPM errors and uncertainties.
typedef struct {
gdouble *xerr;
gdouble *yerr;
gdouble *zerr;
gdouble *xunc;
gdouble *yunc;
gdouble *zunc;
gint n;
} GwyCurveCalibrationData;
GwyCalData * gwy_caldata_new (gint ndata);
Creates new calibration data.
|
Number of calibration data |
Returns : |
A newly created calibration data. |
void gwy_caldata_resize (GwyCalData *caldata,gint ndata);
Sets number of calibration data entries, resizing arrays for holding them.
Preserves actual values up to new calibration data size.
|
Calibration data |
|
New number of data points |
void gwy_caldata_append (GwyCalData *caldata,GwyCalData *sec);
Appends calibration data entries, resizing arrays for holding them.
|
Calibration data |
|
Calibration data to be appended |
Since 2.23
gint gwy_caldata_get_ndata (GwyCalData *caldata);
Gets the number of calibration data entries.
|
Calibration data |
Returns : |
Number of calibration data entries. |
Since 2.23
gdouble * gwy_caldata_get_x (GwyCalData *caldata);
Gets the Y data for calibration data.
|
Calibration data. |
Returns : |
x array pointer for given calibration data. |
Since 2.23
gdouble * gwy_caldata_get_y (GwyCalData *caldata);
Gets the Y data for calibration data.
|
Calibration data. |
Returns : |
y array pointer for given calibration data. |
Since 2.23
gdouble * gwy_caldata_get_z (GwyCalData *caldata);
Gets the Z data for calibration data.
|
Calibration data. |
Returns : |
z array pointer for given calibration data. |
Since 2.23
gdouble * gwy_caldata_get_xerr (GwyCalData *caldata);
Gets the X error data for calibration data.
|
Calibration data. |
Returns : |
x error array pointer for given calibration data. |
Since 2.23
gdouble * gwy_caldata_get_yerr (GwyCalData *caldata);
Gets the Y error data for calibration data.
|
Calibration data. |
Returns : |
y error array pointer for given calibration data. |
Since 2.23
gdouble * gwy_caldata_get_zerr (GwyCalData *caldata);
Gets the Z error data for calibration data.
|
Calibration data. |
Returns : |
z error array pointer for given calibration data. |
Since 2.23
gdouble * gwy_caldata_get_xunc (GwyCalData *caldata);
Gets the X uncertainty data for calibration data.
|
Calibration data. |
Returns : |
x uncertainty array pointer for given calibration data. |
Since 2.23
gdouble * gwy_caldata_get_yunc (GwyCalData *caldata);
Gets the Y uncertainty data for calibration data.
|
Calibration data. |
Returns : |
y uncertainty array pointer for given calibration data. |
Since 2.23
gdouble * gwy_caldata_get_zunc (GwyCalData *caldata);
Gets the Z uncertainty data for calibration data.
|
Calibration data. |
Returns : |
z uncertainty array pointer for given calibration data. |
Since 2.23
void gwy_caldata_get_range (GwyCalData *caldata,gdouble *xfrom,gdouble *xto,gdouble *yfrom,gdouble *yto,gdouble *zfrom,gdouble *zto);
Sets boundaries of calibration data validity.
|
Calibration data. |
|
x minimum |
|
x maximum |
|
y minimum |
|
y maximum |
|
z minimum |
|
z maximum |
Since 2.23
void gwy_caldata_set_range (GwyCalData *caldata,gdouble xfrom,gdouble xto,gdouble yfrom,gdouble yto,gdouble zfrom,gdouble zto);
GwySIUnit * gwy_caldata_get_si_unit_x (GwyCalData *caldata);
Returns lateral SI unit of calibration data.
|
Calibration data |
Returns : |
SI unit corresponding to the lateral (X) dimension of the calibration data Its reference count is not incremented. |
Since 2.23
GwySIUnit * gwy_caldata_get_si_unit_y (GwyCalData *caldata);
Returns lateral SI unit of calibration data
|
Calibration data. |
Returns : |
SI unit corresponding to the lateral (Y) dimension of the calibration data. Its reference count is not incremented. |
Since 2.23
GwySIUnit * gwy_caldata_get_si_unit_z (GwyCalData *caldata);
Returns value SI unit of calibration data
|
Calibration data. |
Returns : |
SI unit corresponding to the "height" (Z) dimension of calibration data. Its reference count is not incremented. |
Since 2.23
void gwy_caldata_set_si_unit_x (GwyCalData *caldata,GwySIUnit *si_unit);
Sets the SI unit corresponding to the lateral (X) dimension of calibration data.
It does not assume a reference on si_unit, instead it adds its own
reference.
|
Calibration data. |
|
SI unit to be set. |
Since 2.23
void gwy_caldata_set_si_unit_y (GwyCalData *caldata,GwySIUnit *si_unit);
Sets the SI unit corresponding to the lateral (Y) dimension of calibration data.
It does not assume a reference on si_unit, instead it adds its own
reference.
|
Calibration data. |
|
SI unit to be set. |
Since 2.23
void gwy_caldata_set_si_unit_z (GwyCalData *caldata,GwySIUnit *si_unit);
Sets the SI unit corresponding to the "height" (Z) dimension of calibration data.
It does not assume a reference on si_unit, instead it adds its own
reference.
|
Calibration data. |
|
SI unit to be set. |
Since 2.23
void gwy_caldata_setup_interpolation (GwyCalData *caldata);
Prepares data for interpolating the calibration data (building Delaunay triangulation, etc.).
|
Calibration data. |
Since 2.23
void gwy_caldata_interpolate (GwyCalData *caldata,gdouble x,gdouble y,gdouble z,gdouble *xerr,gdouble *yerr,gdouble *zerr,gdouble *xunc,gdouble *yunc,gdouble *zunc);
Determines (interpolates) caldata parameters for given position.
|
Calibration data. |
|
x coordinate of requested position |
|
y coordinate of requested position |
|
z coordinate of requested position |
|
x error at given position |
|
y error at given position |
|
z error at given position |
|
x uncertainty at given position |
|
y uncertainty at given position |
|
z uncertainty at given position |
Since 2.23
gboolean gwy_caldata_inside (GwyCalData *caldata,gdouble x,gdouble y,gdouble z);
Tests whether a point is inside calibration data range.
|
Calibration data. |
|
x position |
|
y position |
|
z position |
Returns : |
TRUE if xyz position is inside calibration data range. |
Since 2.23