create_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorcreate_scattered_data_interpolatorT_create_scattered_data_interpolator
Short description
create_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorcreate_scattered_data_interpolatorT_create_scattered_data_interpolator — Creates an interpolator for the interpolation of scattered data.
Signature
create_scattered_data_interpolator( string Method, point.y Rows, point.x Columns, number Values, attribute.name GenParamName, attribute.value GenParamValue, out scattered_data_interpolator ScatteredDataInterpolatorHandle )void CreateScatteredDataInterpolator( const HTuple& Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* ScatteredDataInterpolatorHandle )static void HOperatorSet.CreateScatteredDataInterpolator( HTuple method, HTuple rows, HTuple columns, HTuple values, HTuple genParamName, HTuple genParamValue, out HTuple scatteredDataInterpolatorHandle )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
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 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)
public HScatteredDataInterpolator( string method, HTuple rows, HTuple columns, HTuple values, HTuple genParamName, 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 )
void HScatteredDataInterpolator::CreateScatteredDataInterpolator( const wchar_t* Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& GenParamName, const HTuple& GenParamValue ) (Windows only)
void HScatteredDataInterpolator.CreateScatteredDataInterpolator( string method, HTuple rows, HTuple columns, HTuple values, HTuple genParamName, HTuple genParamValue )
Description
create_scattered_data_interpolatorCreateScatteredDataInterpolator creates the interpolator
ScatteredDataInterpolatorHandlescatteredDataInterpolatorHandlescattered_data_interpolator_handle for the interpolation of
scattered data, given as data points in Rowsrowsrows and
Columnscolumnscolumns with the corresponding measurement Valuesvaluesvalues.
With the parameter Methodmethodmethod the algorithm
is specified, which should be used for the interpolation with
interpolate_scattered_dataInterpolateScatteredData. So far, only the
'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 \(r^2 \cdot \log(r)\) where \(r\) defines
the distance of two points. In comparison to
interpolate_scattered_data_imageInterpolateScatteredDataImage,
create_scattered_data_interpolatorCreateScatteredDataInterpolator also supports subpixel
coordinates for Rowsrowsrows and Columnscolumnscolumns. After the creation,
interpolate_scattered_dataInterpolateScatteredData is called for the interpolation of the
unknown values. By splitting up the creation
(create_scattered_data_interpolatorCreateScatteredDataInterpolator)
and the evaluation (interpolate_scattered_dataInterpolateScatteredData) 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 GenParamNamegenParamNamegen_param_name and
GenParamValuegenParamValuegen_param_value:
-
'alpha'"alpha":
The parameter 'alpha'"alpha" is a smoothing factor.
For 'alpha'"alpha" \(=\) 0, all points passed in
Rowsrowsrows, Columnscolumnscolumns, and Valuesvaluesvalues
are interpolated exactly. With 'alpha'"alpha" getting larger, the
interpolation smoothes the points in way that all interpolated points
lie on a common plane.
Default: 00
Restriction: 'alpha'"alpha" \(>=\) 00
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
Methodmethodmethod (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)
Method for the interpolation
Default: 'thin_plate_splines'"thin_plate_splines"
Suggested values: 'thin_plate_splines'"thin_plate_splines"
Rowsrowsrows (input_control) point.y-array → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)
Row coordinates of the points used
for the interpolation
Columnscolumnscolumns (input_control) point.x-array → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)
Column coordinates of the points used
for the interpolation
Valuesvaluesvalues (input_control) number-array → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)
Values of the points used
for the interpolation
GenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)
Names of the generic parameters
that can be adjusted
Default: [][]
Suggested values: 'alpha'"alpha"
GenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → (real / string / integer)HTuple (double / HString / Hlong)HTuple (double / string / int / long)Sequence[Union[str, int, float]]Htuple (double / char* / Hlong)
Values of the generic parameters
that can be adjusted
Default: [][]
Suggested values: 0, 1.0, 10.0, 100.00, 1.0, 10.0, 100.0
ScatteredDataInterpolatorHandlescatteredDataInterpolatorHandlescattered_data_interpolator_handle (output_control) scattered_data_interpolator → (handle)HTuple (HHandle)HScatteredDataInterpolator, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the scattered data interpolator
Result
If the parameters are valid, the operator
create_scattered_data_interpolatorCreateScatteredDataInterpolator returns the value 2 (H_MSG_TRUE).
If necessary, an exception is raised.
Combinations with other operators
Combinations
Possible successors
interpolate_scattered_dataInterpolateScatteredData
Module
Foundation