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

fit(x, y)
Performs a critical dimension evaulation (fit).

source code

get_value(x, params)
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. (string)

get_definition()

source code

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

Returns:: The cdline function definition. (string)

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. (string)

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. (float)

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.

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). (SIUnit)

Since: 2.5

get_nparams()

source code

Return the number of parameters of cdline.

Returns:: The number of function parameters. (int)

fit(x, y)

source code

Performs a critical dimension evaulation (fit).

Parameters:

x - Abscissa points. (list)
y - Ordinate points. (list)

Returns:

Tuple consisting of 2 values (params, err). ((list), (list))

get_value(x, params)

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. (list)

Returns:

Tuple consisting of 2 values (value, fres). ((float), (BooleanOutArg))