Previous topic

scikits.hydroclimpy.enso.grouped_indices_limits

Next topic

Loading information

This Page

scikits.hydroclimpy.enso.apply_on_phase

apply_on_phase(series, func, *args, **kwargs)

Applies the function func to each phase of the ClimateSeries series.

Parameters:

series : ClimateSeries object

Input climate data. The ENSO indices must have been defined by setting a ENSOIndicator object.

func : function

Function to apply.

args : {None, sequence}, optional

Mandatory arguments of the function func.

kwargs : {None, dictionary}, optional

Optional parameters of the function func.

Returns:

result :

A structured MaskedArray of results, with a four fields:

  • global for the result of the function on the whole series.
  • cold for the result of the function on La Niña episodes
  • neutral for the result of the function on Neutral episodes
  • warm for the result of the function on El Niño episodes.