Operator Reference

interpolate_scattered_data_points_to_imageT_interpolate_scattered_data_points_to_imageInterpolateScatteredDataPointsToImageInterpolateScatteredDataPointsToImageinterpolate_scattered_data_points_to_image (Operator)

interpolate_scattered_data_points_to_imageT_interpolate_scattered_data_points_to_imageInterpolateScatteredDataPointsToImageInterpolateScatteredDataPointsToImageinterpolate_scattered_data_points_to_image — Creating an image from the interpolation of scattered data.

Signature

interpolate_scattered_data_points_to_image( : ImageInterpolated : Method, Rows, Columns, Values, Width, Height, GenParamName, GenParamValue : )

Herror T_interpolate_scattered_data_points_to_image(Hobject* ImageInterpolated, const Htuple Method, const Htuple Rows, const Htuple Columns, const Htuple Values, const Htuple Width, const Htuple Height, const Htuple GenParamName, const Htuple GenParamValue)

void InterpolateScatteredDataPointsToImage(HObject* ImageInterpolated, const HTuple& Method, const HTuple& Rows, const HTuple& Columns, const HTuple& Values, const HTuple& Width, const HTuple& Height, const HTuple& GenParamName, const HTuple& GenParamValue)

def interpolate_scattered_data_points_to_image(method: str, rows: Sequence[Union[float, int]], columns: Sequence[Union[float, int]], values: Sequence[Union[float, int]], width: int, height: int, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[str, int, float]]) -> HObject

Description

interpolate_scattered_data_points_to_imageinterpolate_scattered_data_points_to_imageInterpolateScatteredDataPointsToImageInterpolateScatteredDataPointsToImageinterpolate_scattered_data_points_to_image interpolates the data points, given in RowsRowsRowsrowsrows and ColumnsColumnsColumnscolumnscolumns with the corresponding measurement ValuesValuesValuesvaluesvalues, and returns the result in ImageInterpolatedImageInterpolatedImageInterpolatedimageInterpolatedimage_interpolated. The size of the output image is defined by its WidthWidthWidthwidthwidth and its HeightHeightHeightheightheight with the upper left corner at (0,0). In order to interpolate at negative coordinates of (RowsRowsRowsrowsrows,ColumnsColumnsColumnscolumnscolumns), simply translate all input points accordingly. With the parameter MethodMethodMethodmethodmethod the interpolation algorithm is specified. 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, interpolate_scattered_data_points_to_imageinterpolate_scattered_data_points_to_imageInterpolateScatteredDataPointsToImageInterpolateScatteredDataPointsToImageinterpolate_scattered_data_points_to_image also supports subpixel coordinates for RowsRowsRowsrowsrows and ColumnsColumnsColumnscolumnscolumns. If the same data points (RowsRowsRowsrowsrows,ColumnsColumnsColumnscolumnscolumns,ValuesValuesValuesvaluesvalues) are used for the interpolation of different output images in subsequent steps, the operator create_scattered_data_interpolatorcreate_scattered_data_interpolatorCreateScatteredDataInterpolatorCreateScatteredDataInterpolatorcreate_scattered_data_interpolator may be more efficient.

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,ValuesValuesValuesvaluesvalues) are interpolated exactly. With 'alpha'"alpha""alpha""alpha""alpha" getting larger, the interpolation smoothes the points in way that all interpolated points of the result image ImageInterpolatedImageInterpolatedImageInterpolatedimageInterpolatedimage_interpolated 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.

Parameters

ImageInterpolatedImageInterpolatedImageInterpolatedimageInterpolatedimage_interpolated (output_object)  singlechannelimage objectHImageHObjectHObjectHobject * (real)

Interpolated image

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

WidthWidthWidthwidthwidth (input_control)  extent.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of the interpolated image

Default: 640

HeightHeightHeightheightheight (input_control)  extent.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of the interpolated image

Default: 480

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

Result

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

Alternatives

interpolate_scattered_data_imageinterpolate_scattered_data_imageInterpolateScatteredDataImageInterpolateScatteredDataImageinterpolate_scattered_data_image

Module

Foundation