ClassesClasses | | Operators

match_funct_1d_transT_match_funct_1d_transMatchFunct1dTransMatchFunct1dTrans (Operator)

Name

match_funct_1d_transT_match_funct_1d_transMatchFunct1dTransMatchFunct1dTrans — Calculate transformation parameters between two functions.

Signature

match_funct_1d_trans( : : Function1, Function2, Border, ParamsConst, UseParams : Params, ChiSquare, Covar)

Herror T_match_funct_1d_trans(const Htuple Function1, const Htuple Function2, const Htuple Border, const Htuple ParamsConst, const Htuple UseParams, Htuple* Params, Htuple* ChiSquare, Htuple* Covar)

void MatchFunct1dTrans(const HTuple& Function1, const HTuple& Function2, const HTuple& Border, const HTuple& ParamsConst, const HTuple& UseParams, HTuple* Params, HTuple* ChiSquare, HTuple* Covar)

HTuple HFunction1D::MatchFunct1dTrans(const HFunction1D& Function2, const HString& Border, const HTuple& ParamsConst, const HTuple& UseParams, double* ChiSquare, HTuple* Covar) const

HTuple HFunction1D::MatchFunct1dTrans(const HFunction1D& Function2, const char* Border, const HTuple& ParamsConst, const HTuple& UseParams, double* ChiSquare, HTuple* Covar) const

static void HOperatorSet.MatchFunct1dTrans(HTuple function1, HTuple function2, HTuple border, HTuple paramsConst, HTuple useParams, out HTuple paramsVal, out HTuple chiSquare, out HTuple covar)

HTuple HFunction1D.MatchFunct1dTrans(HFunction1D function2, string border, HTuple paramsConst, HTuple useParams, out double chiSquare, out HTuple covar)

Description

match_funct_1d_transmatch_funct_1d_transMatchFunct1dTransMatchFunct1dTransMatchFunct1dTrans calculates the transformation parameters between two functions given as the tuples Function1Function1Function1Function1function1 and Function2Function2Function2Function2function2 (see create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArrayCreateFunct1dArray and create_funct_1d_pairscreate_funct_1d_pairsCreateFunct1dPairsCreateFunct1dPairsCreateFunct1dPairs). The following model is used for the transformation between the two functions:

The transformation parameters are determined by a least-squares minimization of the following function:
The values of the function are obtained by linear interpolation. The parameter BorderBorderBorderBorderborder determines the values of the function Function2Function2Function2Function2function2 outside of its domain. For BorderBorderBorderBorderborder='zero'"zero""zero""zero""zero" these values are set to 0, for BorderBorderBorderBorderborder='constant'"constant""constant""constant""constant" they are set to the corresponding value at the border, for BorderBorderBorderBorderborder='mirror'"mirror""mirror""mirror""mirror" they are mirrored at the border, and for BorderBorderBorderBorderborder='cyclic'"cyclic""cyclic""cyclic""cyclic" they are continued cyclically. The calculated transformation parameters are returned as a 4-tuple in ParamsParamsParamsParamsparamsVal. If some of the parameter values are known, the respective parameters can be excluded from the least-squares adjustment by setting the corresponding value in the tuple UseParamsUseParamsUseParamsUseParamsuseParams to the value 'false'"false""false""false""false". In this case, the tuple ParamsConstParamsConstParamsConstParamsConstparamsConst must contain the known value of the respective parameter. If a parameter is used for the adjustment (UseParamsUseParamsUseParamsUseParamsuseParams = 'true'"true""true""true""true"), the corresponding parameter in ParamsConstParamsConstParamsConstParamsConstparamsConst is ignored. On output, match_funct_1d_transmatch_funct_1d_transMatchFunct1dTransMatchFunct1dTransMatchFunct1dTrans additionally returns the sum of the squared errors ChiSquareChiSquareChiSquareChiSquarechiSquare of the resulting function, i.e., the function obtained by transforming the input function with the transformation parameters, as well as the covariance matrix CovarCovarCovarCovarcovar of the transformation parameters ParamsParamsParamsParamsparamsVal. These parameters can be used to decide whether a successful matching of the functions was possible.

Note that in case that there is no unique solution for the transformation parameters, match_funct_1d_transmatch_funct_1d_transMatchFunct1dTransMatchFunct1dTransMatchFunct1dTrans either returns one selected single solution or returns the error 9205 (Matrix is singular).

Execution Information

Parameters

Function1Function1Function1Function1function1 (input_control)  function_1d HFunction1D, HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Function 1.

Function2Function2Function2Function2function2 (input_control)  function_1d HFunction1D, HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Function 2.

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

Border treatment for function 2.

Default value: 'constant' "constant" "constant" "constant" "constant"

List of values: 'constant'"constant""constant""constant""constant", 'cyclic'"cyclic""cyclic""cyclic""cyclic", 'mirror'"mirror""mirror""mirror""mirror", 'zero'"zero""zero""zero""zero"

ParamsConstParamsConstParamsConstParamsConstparamsConst (input_control)  number-array HTupleHTupleHtuple (real) (double) (double) (double)

Values of the parameters to remain constant.

Number of elements: 4

Default value: [1.0,0.0,1.0,0.0]

UseParamsUseParamsUseParamsUseParamsuseParams (input_control)  string-array HTupleHTupleHtuple (string) (string) (HString) (char*)

Should a parameter be adapted for it?

Number of elements: 4

Default value: ['true','true','true','true'] ["true","true","true","true"] ["true","true","true","true"] ["true","true","true","true"] ["true","true","true","true"]

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

ParamsParamsParamsParamsparamsVal (output_control)  number-array HTupleHTupleHtuple (real) (double) (double) (double)

Transformation parameters between the functions.

Number of elements: 4

ChiSquareChiSquareChiSquareChiSquarechiSquare (output_control)  number HTupleHTupleHtuple (real) (double) (double) (double)

Quadratic error of the output function.

CovarCovarCovarCovarcovar (output_control)  number-array HTupleHTupleHtuple (real) (double) (double) (double)

Covariance Matrix of the transformation parameters.

Number of elements: 16

Possible Predecessors

create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArrayCreateFunct1dArray, create_funct_1d_pairscreate_funct_1d_pairsCreateFunct1dPairsCreateFunct1dPairsCreateFunct1dPairs

See also

gray_projectionsgray_projectionsGrayProjectionsGrayProjectionsGrayProjections

Module

Foundation


ClassesClasses | | Operators