OPH_INTERCUBE

Description

Type

Data Process.

Behaviour

It executes an operation between two datacubes with the same fragmentation structure and returns a new datacube as result of the specified operation applied element by element.

Parameters

  • cube: name of the first operand datacube. The name must be in PID format.
  • cube2: name of the second operand datacube. The name must be in PID format.
  • operation: type of inter-cube operation among these (default is sub):
    • sum: sums correspondent elements one by one
    • sub: subtracts the elements of the second operand from the first operand one by one (default)
    • mul: multiplies correspondent elements one by one
    • div: divides the elements of the first operand by the elements of the second operand one by one
    • abs: computes the modulus of corresponding elements one by one
    • arg: computes the phase of corresponding elements one by one
    • corr: computes the Pearson correlation coefficient row by row
    • mask: takes all elements of cube corresponding to 1s in cube2, remaining elements are set to 0 (int, byte, short or long) or NaN (float or double)
    • max: return the maximum value between the corresponding elements one by one
    • min: return the minimum value between the corresponding elements one by one
  • missingvalue: value to be considered as missing value; by default it is NAN (for float and double).
  • measure: name of the new measure resulting from the specified operation.
  • schedule: scheduling algorithm. The only possible value is 0, for a static linear block distribution of resources.
  • container: name of the container to be used to store the output cube; by default, it is the container of the first cube.
  • description: additional description to be associated with the output cube.

System parameters

  • exec_mode: operator execution mode. Possible values are async (default) for asynchronous mode, sync for synchronous mode with json-compliant output.
  • ncores: number of parallel processes to be used (min. 1).
  • sessionid: session identifier used server-side to manage sessions and jobs. Usually, users don’t need to use/modify it, except when it is necessary to create a new session or switch to another one.
  • objkey_filter: filter on the output of the operator written to file (default=all => no filter, none => no output, intercube => shows operator’s output PID as text).

Examples

Sum the datacubes identified by the PIDs “URL/1/1” and “URL/1/2”:

[OPH_TERM] >>  oph_intercube cube=URL/1/1;cube2=URL/1/2;operation=sum;measure=new_pressure;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” /
exec_mode “string” “no” “async|sync” “async”  
cube “string” “yes”      
cube2 “string” “yes”      
operation “string” “no” “sum|sub|mul|div|abs|arg|corr|mask|max|min” “sub”  
missingvalue “real” “no”   “NAN”  
measure “string” “no”   “null”  
schedule “int” “no” “0” “0”  
container “string” “no”   “-“  
description “string” “no”   “-“  
objkey_filter “string” “no” “all|none|intercube” “all”