Operator Reference

create_scattered_data_interpolatorT_create_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorcreate_scattered_data_interpolator (Operator)

create_scattered_data_interpolatorT_create_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorcreate_scattered_data_interpolator — 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::HScatteredDataInterpolator(const wchar_t* Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& GenParamName, const HTuple& GenParamValue)   ( Windows only)

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)

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

def create_scattered_data_interpolator(method: str, rows: Sequence[Union[float, int]], columns: Sequence[Union[float, int]], values: Sequence[Union[float, int]], gen_param_name: Sequence[str], gen_param_value: Sequence[Union[str, int, float]]) -> HHandle

Description

create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorcreate_scattered_data_interpolator creates the interpolator ScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandlescatteredDataInterpolatorHandlescattered_data_interpolator_handle 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_dataInterpolateScatteredDataInterpolateScatteredDatainterpolate_scattered_data. 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_imageInterpolateScatteredDataImageInterpolateScatteredDataImageinterpolate_scattered_data_image, create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorcreate_scattered_data_interpolator also supports subpixel coordinates for RowsRowsRowsrowsrows and ColumnsColumnsColumnscolumnscolumns. After the creation, interpolate_scattered_datainterpolate_scattered_dataInterpolateScatteredDataInterpolateScatteredDatainterpolate_scattered_data is called for the interpolation of the unknown values. By splitting up the creation (create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorcreate_scattered_data_interpolator) and the evaluation (interpolate_scattered_datainterpolate_scattered_dataInterpolateScatteredDataInterpolateScatteredDatainterpolate_scattered_data) 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 GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value:

'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: 0

Restriction: 'alpha'"alpha""alpha""alpha""alpha" >= 0

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

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 HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Method for the interpolation

Default: '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 HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row coordinates of the points used for the interpolation

ColumnsColumnsColumnscolumnscolumns (input_control)  point.x-array HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Column coordinates of the points used for the interpolation

ValuesValuesValuesvaluesvalues (input_control)  number-array HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Values of the points used for the interpolation

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name-array HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters that can be adjusted

Default: []

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

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value-array HTupleSequence[Union[str, int, float]]HTupleHtuple (real / string / integer) (double / string / int / long) (double / HString / Hlong) (double / char* / Hlong)

Values of the generic parameters that can be adjusted

Default: []

Suggested values: 0, 1.0, 10.0, 100.0

ScatteredDataInterpolatorHandleScatteredDataInterpolatorHandleScatteredDataInterpolatorHandlescatteredDataInterpolatorHandlescattered_data_interpolator_handle (output_control)  scattered_data_interpolator HScatteredDataInterpolator, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the scattered data interpolator

Result

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

Possible Successors

interpolate_scattered_datainterpolate_scattered_dataInterpolateScatteredDataInterpolateScatteredDatainterpolate_scattered_data

Module

Foundation