Module gwy :: Class CDLine

[frames] | no frames]

Class CDLine

source code

Instance Methods

[hide private]

get_name()
Return cdline name (its unique identifier).

source code

get_definition()
Gets the name of the image file with critical dimension evaluator description.

source code

get_param_name(param)
Returns the name of a critical dimension evaluator parameter.

source code

get_param_default(param)
Returns a constant default parameter value.

source code

get_param_units(param, siunit_x, siunit_y)
Derives the SI unit of a critical dimension parameter from the units of abscissa and ordinate.

source code

get_nparams()
Return the number of parameters of cdline. source code

UNIMPLEMENTED_fit(n_dat, x, y, n_param, params, err, fixed_param, user_data)
Performs a critical dimension evaulation (fit), allowing user to pass uncertainties.

source code

UNIMPLEMENTED_fit_with_caldata(n_dat, x, y, params, err, cdata)

source code

UNIMPLEMENTED_get_value(x, params, fres)
Calculates critical dimension function value in a single point with given parameters.

source code

Method Details

[hide private]

get_name()

source code

Return cdline name (its unique identifier).

Returns:: The cdline name.

get_definition()

source code

Gets the name of the image file with critical dimension evaluator description.

Returns:: The cdline function definition.

get_param_name(param)

source code

Returns the name of a critical dimension evaluator parameter.

The name may contain Pango markup.

Parameters:

param - A parameter number. (int)

Returns:

The name of parameter @param.

get_param_default(param)

source code

Returns a constant default parameter value.

Parameters:

param - A parameter number. (int)

Returns:

The default parameter value, unrelated to the actual data fitted. It is worthless.

get_param_units(param, siunit_x, siunit_y)

source code

Derives the SI unit of a critical dimension parameter from the units of abscissa and ordinate.

Since: 2.5

Parameters:

param - A parameter number. (int)
siunit_x - SI unit of abscissa. (SIUnit)
siunit_y - SI unit of ordinate. (SIUnit)

Returns:

A newly created SIUnit with the units of the parameter @param. If the units of @param are not representable as SIUnit, the result is unitless (i.e. it will be presented as a mere number).

get_nparams()

source code

Return the number of parameters of cdline.

Returns:: The number of function parameters.

UNIMPLEMENTED_fit(n_dat, x, y, n_param, params, err, fixed_param, user_data)

source code

Performs a critical dimension evaulation (fit), allowing user to pass uncertainties.

Parameters:

n_dat - The number of data points (number of items in x and y). (int)
x - Abscissa points. (const-gdouble*)
y - Ordinate points. (const-gdouble*)
params - Array to store fitted parameter values to. (gdouble*)
err - Array to store parameter errros to, may be NULL. (gdouble*)
cdata - Curve calibration data, may be NULL.

UNIMPLEMENTED_get_value(x, params, fres)

source code

Calculates critical dimension function value in a single point with given parameters.

Parameters:

x - The point to compute value at. (float)
params - Evaluator parameter values. (const-gdouble*)
fres - Set to True if succeeds, False on failure. (gboolean*)

Returns:

The function value.