vector_field_lengthvector_field_lengthVectorFieldLengthvector_field_lengthVectorFieldLengthVectorFieldLength (Operator)

Name

vector_field_lengthvector_field_lengthVectorFieldLengthvector_field_lengthVectorFieldLengthVectorFieldLength — Compute the length of the vectors of a vector field.

Signature

Description

vector_field_lengthvector_field_lengthVectorFieldLengthvector_field_lengthVectorFieldLengthVectorFieldLength compute the length of the vectors of the vector field VectorFieldVectorFieldVectorFieldVectorFieldVectorFieldvectorField and returns them in LengthLengthLengthLengthLengthlength. vector_field_lengthvector_field_lengthVectorFieldLengthvector_field_lengthVectorFieldLengthVectorFieldLength only accepts vector fields of the semantic type 'vector_field_relative'. The parameter ModeModeModeModeModemode can be used to specify how the lengths are computed. For ModeModeModeModeModemode = 'length'"length""length""length""length""length", the Euclidean length of the vectors is computed. For ModeModeModeModeModemode = 'squared_length'"squared_length""squared_length""squared_length""squared_length""squared_length", the square of the length of the vectors is computed. This avoids having to compute a square root internally, which is a costly operation on many processors, and hence saves runtime on these processors. Note that the VectorFieldVectorFieldVectorFieldVectorFieldVectorFieldvectorField must be in relative coordinates as returned by optical_flow_mgoptical_flow_mgOpticalFlowMgoptical_flow_mgOpticalFlowMgOpticalFlowMg.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Automatically parallelized on domain level.
• Automatically parallelized on tuple level.

Parameters

Result

If the parameter values are correct, the operator vector_field_lengthvector_field_lengthVectorFieldLengthvector_field_lengthVectorFieldLengthVectorFieldLength returns the value 2 (H_MSG_TRUE). If the input is empty (no input images are available) the behavior can be set via set_system('no_object_result',<Result>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>). If necessary, an exception is raised.

Possible Predecessors

optical_flow_mgoptical_flow_mgOpticalFlowMgoptical_flow_mgOpticalFlowMgOpticalFlowMg

Possible Successors

thresholdthresholdThresholdthresholdThresholdThreshold

Module

Foundation