Module gwy :: Class CDLine
[show private | hide private]
[frames | no frames]

Class CDLine


Method Summary
  get_definition()
Gets the name of the image file with critical dimension evaluator description.
  get_name()
Return cdline name (its unique identifier).
  get_nparams()
Return the number of parameters of cdline.
  get_param_default(param)
Returns: The default parameter value, unrelated to the actual data fitted.
  get_param_name(param)
Returns: The name of parameter @param.
  get_param_units(param, siunit_x, siunit_y)
Derives the SI unit of a critical dimension parameter from the units of abscissa and ordinate.
  UNIMPLEMENTED_fit(n_dat, x, y, n_param, params, err, fixed_param, user_data)
Performs a critical dimension evaulation (fit).
  UNIMPLEMENTED_get_value(x, params, fres)
Calculates critical dimension function value in a single point with given parameters.

Method Details

get_definition()

Gets the name of the image file with critical dimension evaluator description.
Returns:
The cdline function definition.

get_name()

Return cdline name (its unique identifier).
Returns:
The cdline name.

get_nparams()

Return the number of parameters of cdline.
Returns:
The number of function parameters.

get_param_default(param)

Returns: The default parameter value, unrelated to the actual data fitted.
Parameters:
param - A parameter number. (int)
Returns:
The default parameter value, unrelated to the actual data fitted. It is worthless.

get_param_name(param)

Returns: The name of parameter @param.
Parameters:
param - A parameter number. (int)
Returns:
The name of parameter @param.

get_param_units(param, siunit_x, siunit_y)

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

Since: 2.5

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

Performs a critical dimension evaulation (fit).
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*)
n_param - The number of parameters. This argument is ignored as the evaluator knows how many parameters it has, it is safe to pass 0. (int)
params - Array to store fitted parameter values to. (gdouble*)
err - Array to store parameter errros to, may be NULL. (gdouble*)
fixed_param - Which parameters should be treated as fixed. It is ignored, pass NULL. (const-gboolean*)
user_data - Ignored, pass NULL. (gpointer)

UNIMPLEMENTED_get_value(x, params, fres)

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.

Generated by Epydoc 2.1 on Tue Dec 30 04:01:42 2008 http://epydoc.sf.net