| Gwyddion Data Processing Library Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
#include <libprocess/gwyprocess.h> struct GwyCDLine; struct GwyCDLineClass; GwyInventory * gwy_cdlines (void); const gchar * gwy_cdline_get_name (GwyCDLine *cdline); const gchar * gwy_cdline_get_definition (GwyCDLine *cdline); const gchar * gwy_cdline_get_param_name (GwyCDLine *cdline,gint param); gdouble gwy_cdline_get_param_default (GwyCDLine *cdline,gint param); GwySIUnit * gwy_cdline_get_param_units (GwyCDLine *cdline,gint param,GwySIUnit *siunit_x,GwySIUnit *siunit_y); gint gwy_cdline_get_nparams (GwyCDLine *cdline); void gwy_cdline_fit (GwyCDLine *cdline,gint n_dat,const gdouble *x,const gdouble *y,gint n_param,gdouble *params,gdouble *err,const gboolean *fixed_param,gpointer user_data); void gwy_cdline_fit_with_caldata (GwyCDLine *cdline,gint n_dat,const gdouble *x,const gdouble *y,gdouble *params,gdouble *err,GwyCurveCalibrationData *cdata); gdouble gwy_cdline_get_value (GwyCDLine *cdline,gdouble x,const gdouble *params,gboolean *fres); GwyCDLineBuiltin;
struct GwyCDLineClass {
GwyResourceClass parent_class;
void (*reserved1)(void);
void (*reserved2)(void);
};
GwyInventory * gwy_cdlines (void);
Gets inventory with all the critical dimension evaluators.
Returns : |
Critical dimension evaluator inventory. |
const gchar * gwy_cdline_get_name (GwyCDLine *cdline);
Return cdline name (its unique identifier).
|
A critical dimension evaluator. |
Returns : |
The cdline name. |
const gchar * gwy_cdline_get_definition (GwyCDLine *cdline);
Gets the name of the image file with critical dimension evaluator description.
|
A critical dimension evaluator. |
Returns : |
The cdline function definition. |
const gchar * gwy_cdline_get_param_name (GwyCDLine *cdline,gint param);
Returns the name of a critical dimension evaluator parameter.
The name may contain Pango markup.
|
A NL evaluator function cdline. |
|
A parameter number. |
Returns : |
The name of parameter param. |
gdouble gwy_cdline_get_param_default (GwyCDLine *cdline,gint param);
gwy_cdline_get_param_default is deprecated and should not be used in newly-written code.
Returns a constant default parameter value.
|
A NL evaluator function cdline. |
|
A parameter number. |
Returns : |
The default parameter value, unrelated to the actual data fitted. It is worthless. |
GwySIUnit * gwy_cdline_get_param_units (GwyCDLine *cdline,gint param,GwySIUnit *siunit_x,GwySIUnit *siunit_y);
Derives the SI unit of a critical dimension parameter from the units of abscissa and ordinate.
|
A critical dimension evaluator. |
|
A parameter number. |
|
SI unit of abscissa. |
|
SI unit of ordinate. |
Returns : |
A newly created GwySIUnit with the units of the parameter param.
If the units of param are not representable as GwySIUnit,
the result is unitless (i.e. it will be presented as a mere
number). |
Since 2.5
gint gwy_cdline_get_nparams (GwyCDLine *cdline);
Return the number of parameters of cdline.
|
A critical dimension evaluator. |
Returns : |
The number of function parameters. |
void gwy_cdline_fit (GwyCDLine *cdline,gint n_dat,const gdouble *x,const gdouble *y,gint n_param,gdouble *params,gdouble *err,const gboolean *fixed_param,gpointer user_data);
Performs a critical dimension evaulation (fit), allowing user to pass uncertainties.
|
A critical dimension evaluator. |
|
The number of data points (number of items in x and y). |
|
Abscissa points. |
|
Ordinate points. |
|
Array to store fitted parameter values to. |
|
Array to store parameter errros to, may be NULL. |
void gwy_cdline_fit_with_caldata (GwyCDLine *cdline,gint n_dat,const gdouble *x,const gdouble *y,gdouble *params,gdouble *err,GwyCurveCalibrationData *cdata);
gdouble gwy_cdline_get_value (GwyCDLine *cdline,gdouble x,const gdouble *params,gboolean *fres);
Calculates critical dimension function value in a single point with given parameters.