cdline

cdline — Critical dimension

Synopsis




            GwyCDLineBuiltin;
            GwyCDLine;
            GwyCDLineClass;
gchar*      gwy_cdline_get_name             (GwyCDLine *preset);
gchar*      gwy_cdline_get_definition       (GwyCDLine *preset);
gchar*      gwy_cdline_get_param_name       (GwyCDLine *preset,
                                             gint param);
gdouble     gwy_cdline_get_param_default    (GwyCDLine *preset,
                                             gint param);
gint        gwy_cdline_get_nparams          (GwyCDLine *preset);
void        gwy_cdline_fit                  (GwyCDLine *preset,
                                             gint n_dat,
                                             const gdouble *x,
                                             const gdouble *y,
                                             gint n_param,
                                             gdouble *param,
                                             gdouble *err,
                                             const gboolean *fixed_param,
                                             gpointer user_data);
gdouble     gwy_cdline_get_value            (GwyCDLine *preset,
                                             gdouble x,
                                             const gdouble *params,
                                             gboolean *fres);
GwyInventory* gwy_cdlines                   (void);

Object Hierarchy


  GObject
   +----GwyResource
         +----GwyCDLine

Description

Details

GwyCDLineBuiltin

typedef struct _GwyCDLineBuiltin GwyCDLineBuiltin;


GwyCDLine

typedef struct _GwyCDLine GwyCDLine;


GwyCDLineClass

typedef struct {
    GwyResourceClass parent_class;

    gpointer reserved1;
    gpointer reserved2;
} GwyCDLineClass;


gwy_cdline_get_name ()

gchar*      gwy_cdline_get_name             (GwyCDLine *preset);

Return cdline name (its unique identifier).

preset :
Returns : The cdline name.

gwy_cdline_get_definition ()

gchar*      gwy_cdline_get_definition       (GwyCDLine *preset);

Returns function definition of cdline (as pixmap).

preset :
Returns : The cdline function definition.

gwy_cdline_get_param_name ()

gchar*      gwy_cdline_get_param_name       (GwyCDLine *preset,
                                             gint param);

Returns the name of parameter number param of cdline cdline.

The name may contain Pango markup.

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

gwy_cdline_get_param_default ()

gdouble     gwy_cdline_get_param_default    (GwyCDLine *preset,
                                             gint param);

Returns a suitable constant default parameter value.

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

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

gwy_cdline_get_nparams ()

gint        gwy_cdline_get_nparams          (GwyCDLine *preset);

Return the number of parameters of cdline.

preset :
Returns : The number of function parameters.

gwy_cdline_fit ()

void        gwy_cdline_fit                  (GwyCDLine *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 :

gwy_cdline_get_value ()

gdouble     gwy_cdline_get_value            (GwyCDLine *preset,
                                             gdouble x,
                                             const gdouble *params,
                                             gboolean *fres);

preset :
x :
params :
fres :
Returns :

gwy_cdlines ()

GwyInventory* gwy_cdlines                   (void);

Gets inventory with all the CDLine cdlines.

Returns : CDLine cdline inventory.