oph_mask_array¶

Description¶

Behaviour

It masks measure a with the mask measure b. For each 1 in measure b, take the corresponding element in measure a. For each element of measure b not equal to 1, do not take the corresponding element in measure a. In this case, with oph_int or oph_long, the output element will be 0; with oph_float or oph_double, the output element will be a NaN.

Parameters

• input measure type: Ophidia typing. Supported types are pairs of: ‘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 a: first input measure.
• measure b: second input measure.
• missingvalue : value to be considered as missing value; by default it is NAN (for “oph_double” and “oph_float”).

Return type

Binary-array.

Examples

Mask measure a with the mask in measure b.

oph_mask_array('OPH_DOUBLE|OPH_DOUBLE','OPH_DOUBLE',measure_a,measure_b)

Operation type

Simple.

Arguments¶