Skip to content

transform_funct_1dTransformFunct1dTransformFunct1dtransform_funct_1dT_transform_funct_1d🔗

Short description🔗

transform_funct_1dTransformFunct1dTransformFunct1dtransform_funct_1dT_transform_funct_1d — Transform a function using given transformation parameters.

Signature🔗

transform_funct_1d( function_1d Function, number Params, out function_1d TransformedFunction )void TransformFunct1d( const HTuple& Function, const HTuple& Params, HTuple* TransformedFunction )static void HOperatorSet.TransformFunct1d( HTuple function, HTuple paramsVal, out HTuple transformedFunction )def transform_funct_1d( function: Sequence[Union[float, int]], params: Sequence[float] ) -> Sequence[Union[float, int]]

Herror T_transform_funct_1d( const Htuple Function, const Htuple Params, Htuple* TransformedFunction )

HFunction1D HFunction1D::TransformFunct1d( const HTuple& Params ) const

HFunction1D HFunction1D.TransformFunct1d( HTuple paramsVal )

Description🔗

transform_funct_1dTransformFunct1d transforms the input function Functionfunctionfunction using the transformation parameters given in ParamsparamsValparams. The function Functionfunctionfunction is passed as a tuple (see create_funct_1d_arrayCreateFunct1dArray and create_funct_1d_pairsCreateFunct1dPairs). The following model is used for the transformation between the two functions (see match_funct_1d_transMatchFunct1dTrans):

\[\begin{eqnarray*} y_{t}(x) = a_{1} y(a_{3} x + a_{4}) + a_{2} \enspace . \end{eqnarray*}\]

The output function TransformedFunctiontransformedFunctiontransformed_function is obtained by transforming the x and y values of the input function separately with the above formula, i.e., the output function is not sampled again. Therefore, the parameter \(a_{3}\) is restricted to \(a_{3} \neq 0.0\). To resample a function, the operator sample_funct_1dSampleFunct1d can be used.

Execution information🔗

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🔗

Functionfunctionfunction (input_control) function_1d → (real / integer)HTuple (double / Hlong)HFunction1D, HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)

Input function.

ParamsparamsValparams (input_control) number-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Transformation parameters between the functions.

Number of elements: 4

TransformedFunctiontransformedFunctiontransformed_function (output_control) function_1d → (real / integer)HTuple (double / Hlong)HFunction1D, HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)

Transformed function.

Combinations with other operators🔗

Combinations

Possible predecessors

create_funct_1d_pairsCreateFunct1dPairs, create_funct_1d_arrayCreateFunct1dArray, match_funct_1d_transMatchFunct1dTrans

Module🔗

Foundation