ClassesClasses | | Operators

create_scattered_data_interpolatorT_create_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolator (Operator)

Name

create_scattered_data_interpolatorT_create_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolator — Creates an interpolator for the interpolation of scattered data.

Signature

create_scattered_data_interpolator( : : Method, Rows, Columns, Values, GenParamName, GenParamValue : ScatteredDataInterpolatorHandle)

Herror T_create_scattered_data_interpolator(const Htuple Method, const Htuple Rows, const Htuple Columns, const Htuple Values, const Htuple GenParamName, const Htuple GenParamValue, Htuple* ScatteredDataInterpolatorHandle)

void CreateScatteredDataInterpolator(const HTuple& Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* ScatteredDataInterpolatorHandle)

void HScatteredDataInterpolator::HScatteredDataInterpolator(const HString& Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& GenParamName, const HTuple& GenParamValue)

void HScatteredDataInterpolator::HScatteredDataInterpolator(const char* Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& GenParamName, const HTuple& GenParamValue)

void HScatteredDataInterpolator::CreateScatteredDataInterpolator(const HString& Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& GenParamName, const HTuple& GenParamValue)

void HScatteredDataInterpolator::CreateScatteredDataInterpolator(const char* Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& GenParamName, const HTuple& GenParamValue)

static void HOperatorSet.CreateScatteredDataInterpolator(HTuple method, HTuple rows, HTuple columns, HTuple values, HTuple genParamName, HTuple genParamValue, out HTuple scatteredDataInterpolatorHandle)

public HScatteredDataInterpolator(string method, HTuple rows, HTuple columns, HTuple values, HTuple genParamName, HTuple genParamValue)

void HScatteredDataInterpolator.CreateScatteredDataInterpolator(string method, HTuple rows, HTuple columns, HTuple values, HTuple genParamName, HTuple genParamValue)

Description

create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolator creates the interpolator ScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandlescatteredDataInterpolatorHandle for the interpolation of scattered data, given as data points in RowsRowsRowsRowsrows and ColumnsColumnsColumnsColumnscolumns with the corresponding measurement ValuesValuesValuesValuesvalues. With the parameter MethodMethodMethodMethodmethod the algorithm is specified, which should be used for the interpolation with interpolate_scattered_datainterpolate_scattered_dataInterpolateScatteredDataInterpolateScatteredDataInterpolateScatteredData. So far, only the 'thin_plate_splines'"thin_plate_splines""thin_plate_splines""thin_plate_splines""thin_plate_splines" are supported. This method interpolates on a global scale, which means that all points are regarded for the interpolation, no matter how far away they are. The influence of far points is correlated to where r defines the distance of two points. In comparison to interpolate_scattered_data_imageinterpolate_scattered_data_imageInterpolateScatteredDataImageInterpolateScatteredDataImageInterpolateScatteredDataImage, create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolator also supports subpixel coordinates for RowsRowsRowsRowsrows and ColumnsColumnsColumnsColumnscolumns. After the creation, interpolate_scattered_datainterpolate_scattered_dataInterpolateScatteredDataInterpolateScatteredDataInterpolateScatteredData is called for the interpolation of the unknown values. By splitting up the creation (create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolator) and the evaluation (interpolate_scattered_datainterpolate_scattered_dataInterpolateScatteredDataInterpolateScatteredDataInterpolateScatteredData) of the interpolator, interpolating at different data points in subsequent steps becomes more efficient since the interpolator has to be created only once.

The following parameters can be adjusted with GenParamNameGenParamNameGenParamNameGenParamNamegenParamName and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue:

'alpha'"alpha""alpha""alpha""alpha":

The parameter 'alpha'"alpha""alpha""alpha""alpha" is a smoothing factor. For 'alpha'"alpha""alpha""alpha""alpha" = 0, all points passed in RowsRowsRowsRowsrows, ColumnsColumnsColumnsColumnscolumns, and ValuesValuesValuesValuesvalues are interpolated exactly. With 'alpha'"alpha""alpha""alpha""alpha" getting larger, the interpolation smoothes the points in way that all interpolated points lie on a common plane. Default value is 0. Restrictions: 'alpha'"alpha""alpha""alpha""alpha" >= 0

Execution Information

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

MethodMethodMethodMethodmethod (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Method for the interpolation

Default value: 'thin_plate_splines' "thin_plate_splines" "thin_plate_splines" "thin_plate_splines" "thin_plate_splines"

Suggested values: 'thin_plate_splines'"thin_plate_splines""thin_plate_splines""thin_plate_splines""thin_plate_splines"

RowsRowsRowsRowsrows (input_control)  point.y-array HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row coordinates of the points used for the interpolation

ColumnsColumnsColumnsColumnscolumns (input_control)  point.x-array HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Column coordinates of the points used for the interpolation

ValuesValuesValuesValuesvalues (input_control)  number-array HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Values of the points used for the interpolation

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name-array HTupleHTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters that can be adjusted

Default value: []

Suggested values: 'alpha'"alpha""alpha""alpha""alpha"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control)  attribute.value-array HTupleHTupleHtuple (real / string / integer) (double / string / int / long) (double / HString / Hlong) (double / char* / Hlong)

Values of the generic parameters that can be adjusted

Default value: []

Suggested values: 0, 1.0, 10.0, 100.0

ScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandlescatteredDataInterpolatorHandle (output_control)  scattered_data_interpolator HScatteredDataInterpolator, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the scattered data interpolator

Result

If the parameters are valid, the operator create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolator returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Successors

interpolate_scattered_datainterpolate_scattered_dataInterpolateScatteredDataInterpolateScatteredDataInterpolateScatteredData

Module

Foundation


ClassesClasses | | Operators