act.retrievals.calculate_irradiance_stats

act.retrievals.calculate_irradiance_stats(obj, variable=None, variable2=None, diff_output_variable=None, ratio_output_variable=None, threshold=None)[source]

Function to calculate the difference and ratio between two irradiance.

Parameters:
  • obj (ACT object) – Object where variables for these calculations are stored

  • variable (str) – Name of the first irradiance variable

  • variable2 (str) – Name of the second irradiance variable

  • diff_output_variable (str) – Variable name to store the difference results Defaults to ‘diff[underscore]’+variable

  • ratio_output_variable (str) – Variable name to store the ratio results Defaults to ‘ratio[underscore]’+variable

Returns:

obj (ACT Object) – Object with calculations included as new variables.