SASHE_VAP  1.0
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Groups
Cloud Screening

Data Structures

struct  CloudScreen
 Cloud Screening Structure. More...

Functions

void cloud_screen_free (CloudScreen *cloud_screen)
 Free a CloudScreen Structure.
CloudScreencloud_screen_init (size_t ntimes, CloudScreen *cloud_screen)
 Initialize a CloudScreen Structure.
int * cloud_screen_run (CloudScreen *cloud_screen)
 Alexandrov's Cloud Screening Algorithm.

Detailed Description


Function Documentation

void cloud_screen_free ( CloudScreen cloud_screen)

Free a CloudScreen Structure.

Parameters:
cloud_screen- pointer to the CloudScreen structure.

Definition at line 61 of file Alexandrov_cloud_screen.c.

CloudScreen* cloud_screen_init ( size_t  ntimes,
CloudScreen cloud_screen 
)

Initialize a CloudScreen Structure.

The memory used by the returned structure is dynamically allocated and must be freed using the cloud_screen_free() function.

Parameters:
ntimes- the number of times in the input data
cloud_screen- pointer to the CloudScreen structure, or NULL to create a new CloudScreen structure.
Returns:
:
  • pointer to the CloudScreen structure
  • NULL if a memory allocation error occurred

Definition at line 92 of file Alexandrov_cloud_screen.c.

int* cloud_screen_run ( CloudScreen cloud_screen)

Alexandrov's Cloud Screening Algorithm.

Alexandrov, M. D., A. Marshak, B. Cairns, A. A. Lacis, and B. E. Carlson (2004), Automated cloud screening algorithm for MFRSR data, Geophys. Res. Lett., 31, L04118, doi:10.1029/2003GL019105.

Parameters:
cloud_screenpointer to the CloudScreen structure, or NULL to create a new CloudScreen structure.
Return values:
cloud_flagspointer to the array of cloud detection flags:
  • -1 = input tau < 0.0
  • 0 = no cloud detected
  • 1 = point recaptured by envelope logic
  • 2 = cloud detected (tau_prime <= 0.0)
  • 3 = cloud detected (epsilon >= threshold)

Definition at line 155 of file Alexandrov_cloud_screen.c.