#include <val_extract.h>

Collaboration diagram for val_extract_arguments:

Public Attributes
const char *	ifile

int	box_size

double	box_size_km

bool	line_and_pixel

int	start_line

int	end_line

int	start_pixel

int	end_pixel

bool	lat_and_lon

double	start_lat

double	end_lat

double	start_lon

double	end_lon

bool	geospatial_only

bool	geospatial_to_double

char **	products

int	product_count

uint32_t	ignore_flags_mask

char **	ignore_flags

int	ignore_flag_count

uint32_t	count_flags_mask

char **	count_flags

int	count_flag_count

char **	l2qc_flags

double *	l2qc_thresholds

int	l2qc_threshold_count

val_extract_valid_range *	valid_ranges

int	valid_range_count

char **	skip_stats

int	skip_stats_count

bool	global_atts

bool	variable_atts

olog *	log

double	optics_threshold

val_extract_parser	val_extract_parser

void *	user_input

Detailed Description

Passed into the library function to control the processing. Many of the fields will be unspecified.

For the box definition, it accepts either 1) box_size (box_size OR box_size_km) and a center point of start_line and start_pixel or start_lat and start_lon or 2) a region defined by start_ and end_ line and pixel or start_ and end_ lat and lon or 3) nothing, and the whole file is processed.

Definition at line 103 of file val_extract.h.

Member Data Documentation

◆ box_size

int box_size

Box width (and height) for extract, in pixels.

Definition at line 108 of file val_extract.h.

◆ box_size_km

double box_size_km

Box radius for extract, in kilometers.

Definition at line 111 of file val_extract.h.

◆ count_flag_count

int count_flag_count

How many count_flags are present.

Definition at line 158 of file val_extract.h.

◆ count_flags

char** count_flags

If given, count all pixels with ANY of these flags. This is added to count_flags_mask.

Definition at line 156 of file val_extract.h.

◆ count_flags_mask

uint32_t count_flags_mask

If given, count all pixels with ANY of these flag bits sets.

Definition at line 154 of file val_extract.h.

◆ end_lat

double end_lat

End latitude for regions.

Definition at line 129 of file val_extract.h.

◆ end_line

int end_line

End line for regions.

Definition at line 118 of file val_extract.h.

◆ end_lon

double end_lon

End longitude for regions.

Definition at line 133 of file val_extract.h.

◆ end_pixel

int end_pixel

End pixel for regions.

Definition at line 122 of file val_extract.h.

◆ geospatial_only

bool geospatial_only

Only process geospatial variables, those with lines and pixels as the only dimensions.

Definition at line 136 of file val_extract.h.

◆ geospatial_to_double

bool geospatial_to_double

Read all geospatial variables as doubles, regardless of original type, useful for avoiding copy-and-pasting the processing code.

Definition at line 139 of file val_extract.h.

◆ global_atts

bool global_atts

Create .global file containing all global attributes.

Definition at line 180 of file val_extract.h.

◆ ifile

const char* ifile

Path to Level 2 NetCDF file.

Definition at line 105 of file val_extract.h.

◆ ignore_flag_count

int ignore_flag_count

How many ignore_flags are present.

Definition at line 151 of file val_extract.h.

◆ ignore_flags

char** ignore_flags

If given, ignore all pixels with ANY of these flags. This is added to ignore_flags_mask.

Definition at line 149 of file val_extract.h.

◆ ignore_flags_mask

uint32_t ignore_flags_mask

If given, ignore all pixels with ANY of these flag bits sets.

Definition at line 147 of file val_extract.h.

◆ l2qc_flags

char** l2qc_flags

If given, use these flags for the L2QC process, paired with the l2qc_thresholds input.

Definition at line 161 of file val_extract.h.

◆ l2qc_threshold_count

int l2qc_threshold_count

How many l2qc_thresholds are present.

Definition at line 166 of file val_extract.h.

◆ l2qc_thresholds

double* l2qc_thresholds

If given, use these thresholds for the L2QC process, aborting processing if any are thresholds are surpassed.

Definition at line 164 of file val_extract.h.

◆ lat_and_lon

bool lat_and_lon

Whether to use latitudes and longitudes instead of lines and pixels.

Definition at line 125 of file val_extract.h.

◆ line_and_pixel

bool line_and_pixel

Whether to use lines and pixels instead of latitudes and longitudes.

Definition at line 114 of file val_extract.h.

◆ log

olog* log

olog object to use for messages, defaults to global logger.

Definition at line 186 of file val_extract.h.

◆ optics_threshold

double optics_threshold

If given, OPTICS algorithm threshold for preventing reaching over data gaps. Lower = stricter.

Definition at line 189 of file val_extract.h.

◆ product_count

int product_count

How many NetCDF variables should be processed.

Definition at line 144 of file val_extract.h.

◆ products

char** products

If given, only process the NetCDF variables listed.

Definition at line 142 of file val_extract.h.

◆ skip_stats

char** skip_stats

If given, override default list of products where statistics are not meaningful (such as l2_flags).

Definition at line 175 of file val_extract.h.

◆ skip_stats_count

int skip_stats_count

How many skip_stats products are present.

Definition at line 177 of file val_extract.h.

◆ start_lat

double start_lat

Either center latitude for a box extract or the beginning latitude for regions.

Definition at line 127 of file val_extract.h.

◆ start_line

int start_line

Either center line for a box extract or the beginning line for regions.

Definition at line 116 of file val_extract.h.

◆ start_lon

double start_lon

Either center longitude for a box extract or the beginning longitude for regions.

Definition at line 131 of file val_extract.h.

◆ start_pixel

int start_pixel

Either center pixel for a box extract or the beginning pixel for regions.

Definition at line 120 of file val_extract.h.

◆ user_input

void* user_input

If given, this is passed to the val_extract_parser for arbitrary use by the user.

Definition at line 195 of file val_extract.h.

◆ val_extract_parser

val_extract_parser val_extract_parser

Required, this is the function that is given the nc_region and nc_var structures after they are processed.

Definition at line 193 of file val_extract.h.

◆ valid_range_count

int valid_range_count