vector_field_length🔗
Short description🔗
vector_field_length — Compute the length of the vectors of a vector field.
Signature🔗
vector_field_length( image VectorField, out image Length, string Mode )
Description🔗
vector_field_length compute the length of the vectors of the
vector field VectorField and returns them in
Length. vector_field_length only accepts vector fields of
the semantic type vector_field_relative.
The parameter Mode can
be used to specify how the lengths are computed. For Mode =
'length', the Euclidean length of the vectors is computed.
For Mode = '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
VectorField must be in relative coordinates as returned by
optical_flow_mg.
Execution information🔗
Execution information
-
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🔗
VectorField (input_object) singlechannelimage(-array) → object (vector_field)
Input vector field
Length (output_object) singlechannelimage(-array) → object (real)
Length of the vectors of the vector field.
Mode (input_control) string → (string)
Mode for computing the length of the vectors.
Default: 'length'
List of values: 'length', 'squared_length'
Result🔗
If the parameter values are correct, the operator
vector_field_length 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>). If necessary, an
exception is raised.
Combinations with other operators🔗
Module🔗
Foundation