cdline

cdline — Critical dimension

Synopsis




enum        GwyCDLineType;
gdouble     (*GwyCDLineFitFunc)             (gdouble x,
                                             gint n_param,
                                             gdouble *param,
                                             gpointer user_data,
                                             gboolean *fres);
void        (*GwyCDLineCDFunc)              (const gdouble *x,
                                             const gdouble *y,
                                             gint n_dat,
                                             gdouble *param,
                                             gdouble *err,
                                             gpointer user_data,
                                             gboolean *fres);
struct      GwyCDLinePreset;
struct      GwyCDLineParam;
gint        gwy_cdline_get_npresets         (void);
GwyCDLinePreset* gwy_cdline_get_preset      (gint preset_id);
GwyCDLinePreset* gwy_cdline_get_preset_by_name
                                            (const gchar *name);
gint        gwy_cdline_get_preset_id        (const GwyCDLinePreset *preset);
gchar*      gwy_cdline_get_preset_name      (const GwyCDLinePreset *preset);
gchar*      gwy_cdline_get_preset_formula   (const GwyCDLinePreset *preset);
gchar*      gwy_cdline_get_preset_param_name
                                            (const GwyCDLinePreset *preset,
                                             gint param);
gdouble     gwy_cdline_get_preset_param_default
                                            (const GwyCDLinePreset *preset,
                                             gint param);
gint        gwy_cdline_get_preset_nparams   (const GwyCDLinePreset *preset);
void        gwy_cdline_fit_preset           (const GwyCDLinePreset *preset,
                                             gint n_dat,
                                             const gdouble *x,
                                             const gdouble *y,
                                             gint n_param,
                                             gdouble *param,
                                             gdouble *err,
                                             const gboolean *fixed_param,
                                             gpointer user_data);

Description

Details

enum GwyCDLineType

typedef enum {
      GWY_CD_LINE_ULINEHEIGHT  = 0,
      GWY_CD_LINE_ULINEWIDTH   = 1,
      GWY_CD_LINE_DLINEHEIGHT  = 2,
      GWY_CD_LINE_DLINEWIDTH   = 3,
      GWY_CD_LINE_USTEPHEIGHT  = 4,
      GWY_CD_LINE_DSTEPHEIGHT  = 5,
      GWY_CD_LINE_RECTSIGNAL   = 6,
      GWY_CD_LINE_SAWSIGNAL    = 7,
      GWY_CD_LINE_SINSIGNAL    = 8,
      GWY_CD_LINE_PARTICLE     = 9,
      GWY_CD_LINE_HOLE         = 10
} GwyCDLineType;

GwyCDLineFitFunc ()

gdouble     (*GwyCDLineFitFunc)             (gdouble x,
                                             gint n_param,
                                             gdouble *param,
                                             gpointer user_data,
                                             gboolean *fres);

`x` :
`n_param` :
`param` :
`user_data` :
`fres` :
Returns :

GwyCDLineCDFunc ()

void        (*GwyCDLineCDFunc)              (const gdouble *x,
                                             const gdouble *y,
                                             gint n_dat,
                                             gdouble *param,
                                             gdouble *err,
                                             gpointer user_data,
                                             gboolean *fres);

`x` :
`y` :
`n_dat` :
`param` :
`err` :
`user_data` :
`fres` :

struct GwyCDLinePreset

struct GwyCDLinePreset {

    const gchar *function_name;
    const gchar *group_name;
    const gchar *function_formula;
    GwyCDLineFitFunc function;
    GwyCDLineCDFunc function_fit;
    gint nparams;
    const GwyCDLineParam *param;
    gpointer _reserved1;
};

struct GwyCDLineParam

struct GwyCDLineParam;

gwy_cdline_get_npresets ()

gint        gwy_cdline_get_npresets         (void);

Returns the number of available critical dimension (CD)presets.

Returns :

The number of presets.

gwy_cdline_get_preset ()

GwyCDLinePreset* gwy_cdline_get_preset      (gint preset_id);

Returns: CD preset number preset_id.

Presets are numbered sequentially from 0 to gwy_cdline_get_npresets()-1. The numbers are not guaranteed to be constants, use preset names as unique identifiers.

`preset_id` :	CD preset number.
Returns :	Preset number `preset_id`. Note the returned value must not be modified or freed.

gwy_cdline_get_preset_by_name ()

GwyCDLinePreset* gwy_cdline_get_preset_by_name
                                            (const gchar *name);

Returns CD preset whose name is name.

`name` :	CDpreset name.
Returns :	Preset `name`, `NULL` if not found. Note the returned value must not be modified or freed.

gwy_cdline_get_preset_id ()

gint        gwy_cdline_get_preset_id        (const GwyCDLinePreset *preset);

Returns the id of a CD preset.

`preset` :	A CD preset.
Returns :	The preset number.

gwy_cdline_get_preset_name ()

gchar*      gwy_cdline_get_preset_name      (const GwyCDLinePreset *preset);

Return preset name (its unique identifier).

`preset` :	A NL fitter function preset.
Returns :	The preset name.

gwy_cdline_get_preset_formula ()

gchar*      gwy_cdline_get_preset_formula   (const GwyCDLinePreset *preset);

Returns function formula of preset (with Pango markup).

`preset` :	A CD preset.
Returns :	The preset function formula.

gwy_cdline_get_preset_param_name ()

gchar*      gwy_cdline_get_preset_param_name
                                            (const GwyCDLinePreset *preset,
                                             gint param);

Returns the name of parameter number param of preset preset.

The name may contain Pango markup.

`preset` :	A CD preset.
`param` :	A parameter number.
Returns :	The name of parameter `param`.

gwy_cdline_get_preset_param_default ()

gdouble     gwy_cdline_get_preset_param_default
                                            (const GwyCDLinePreset *preset,
                                             gint param);

Returns a suitable constant default parameter value.

It is usually better to do an educated guess of initial parameter value.

`preset` :	A CD preset.
`param` :	A parameter number.
Returns :	The default parameter value.

gwy_cdline_get_preset_nparams ()

gint        gwy_cdline_get_preset_nparams   (const GwyCDLinePreset *preset);

Return the number of parameters of preset.

`preset` :	A CD preset.
Returns :	The number of function parameters.

gwy_cdline_fit_preset ()

void        gwy_cdline_fit_preset           (const GwyCDLinePreset *preset,
                                             gint n_dat,
                                             const gdouble *x,
                                             const gdouble *y,
                                             gint n_param,
                                             gdouble *param,
                                             gdouble *err,
                                             const gboolean *fixed_param,
                                             gpointer user_data);

`preset` :
`n_dat` :
`x` :
`y` :
`n_param` :
`param` :
`err` :
`fixed_param` :
`user_data` :