oph_sum_scalar

Description

Behaviour

It sums the scalar value to each element of the measure array.

Parameters

  • input measure type: Ophidia typing. Supported types are: ‘oph_double’; ‘oph_float’; ‘oph_long’; ‘oph_int’; ‘oph_short’; ‘oph_byte’.
  • output measure type: Ophidia typing. Supported types are: ‘oph_double’; ‘oph_float’; ‘oph_long’; ‘oph_int’; ‘oph_short’; ‘oph_byte’.
  • measure: input measure.
  • scalar value: number to be added to each element of the input measure. Default is 0.
  • missingvalue : value to be considered as missing value; by default it is NAN (for ‘oph_double’ and ‘oph_float’).

Return type

Binary-array.

Examples

Add 2 to each element of the input array.

oph_sum_scalar('OPH_DOUBLE','OPH_DOUBLE',measure,2)

Operation type

Simple.

Arguments

Argument name Type Mandatory Values Default Min/Max-value Min/Max-times
input measure type “oph_type” “yes” “‘oph_double’|’oph_float’|’oph_int’|’oph_long’|’oph_short’|’oph_byte’”     “1” / “1”
output measure type “oph_type” “yes” “‘oph_double’|’oph_float’|’oph_int’|’oph_long’|’oph_short’|’oph_byte’”     “1” / “1”
measure “binary-array” “yes”       “1” / “1”
scalar value “double” “no”   “0”   “0” / “1”
missingvalue “double” “no”   “NAN”   “0” / “1”