Functions
def	convert_str_to_int (short_str)

def	find_extension (format_data_list, search_term)

def	get_base_element (data_files, target_program, clopts)

def	get_end_doy_year (data_files)

def	get_l0_timestamp (l0_file_name)

def	get_days_diff (day1, day2)

def	get_end_day_year (metadata)

def	get_extension (program, clopts)

def	get_extra_bits (data_files, target_program, clopts)

def	get_l3_time (data_files)

def	get_level (program, data_files)

def	get_output_name (data_files, target_program, clopts)

def	get_platform_indicator (data_file)

def	get_start_doy_year (data_files)

def	get_start_day_year (metadata)

def	get_time_period_extension (start_date_str, end_date_str)

def	is_month (day1, day2)

def	is_year (day1, day2)

def	read_fileformats ()

Variables
bool	DEBUG = False

Detailed Description

Utility functions for get_output_name.

Function Documentation

◆ convert_str_to_int()

def mlp.get_output_name_utils.convert_str_to_int ( short_str )

Returns an integer taken from the passed in string.

Definition at line 25 of file get_output_name_utils.py.

◆ find_extension()

def mlp.get_output_name_utils.find_extension	(	format_data_list,
		search_term
	)

Returns the extension from format_data_list that is indicated by
search_term.

Definition at line 36 of file get_output_name_utils.py.

◆ get_base_element()

def mlp.get_output_name_utils.get_base_element	(	data_files,
		target_program,
		clopts
	)

Returns the base element from input filename.

Definition at line 60 of file get_output_name_utils.py.

◆ get_days_diff()

def mlp.get_output_name_utils.get_days_diff	(	day1,
		day2
	)

Returns the number of days between two days, by subtracting day2 from day1.

Definition at line 154 of file get_output_name_utils.py.

◆ get_end_day_year()

def mlp.get_output_name_utils.get_end_day_year ( metadata )

Returns the end day and year for a file, determined from the contents of
metadata as ints.

Definition at line 160 of file get_output_name_utils.py.

◆ get_end_doy_year()

def mlp.get_output_name_utils.get_end_doy_year ( data_files )

Extract a day of year and year from an L0 file's metadata and return
them as integer values .

Definition at line 90 of file get_output_name_utils.py.

◆ get_extension()

def mlp.get_output_name_utils.get_extension	(	program,
		clopts
	)

Returns the extension appropriate for the program.

Definition at line 188 of file get_output_name_utils.py.

◆ get_extra_bits()

def mlp.get_output_name_utils.get_extra_bits	(	data_files,
		target_program,
		clopts
	)

A method to get the extra bits for l2bin, l3mapgen.

Definition at line 255 of file get_output_name_utils.py.

◆ get_l0_timestamp()

def mlp.get_output_name_utils.get_l0_timestamp ( l0_file_name )

A method to get the date/time stamp from L0 files.

Definition at line 128 of file get_output_name_utils.py.

◆ get_l3_time()

def mlp.get_output_name_utils.get_l3_time ( data_files )

An internal method to return the L3bin time from an L2 or
L3bin file.

Definition at line 305 of file get_output_name_utils.py.

◆ get_level()

def mlp.get_output_name_utils.get_level	(	program,
		data_files
	)

Returns the level element for the target_program.

Definition at line 334 of file get_output_name_utils.py.

◆ get_output_name()

def mlp.get_output_name_utils.get_output_name	(	data_files,
		target_program,
		clopts
	)

Returns the file name derived from the input file name, target program name and oformat .

Definition at line 372 of file get_output_name_utils.py.

◆ get_platform_indicator()

def mlp.get_output_name_utils.get_platform_indicator ( data_file )

Returns a character which indicates what platform (instrument) the
data in the file is from.

Definition at line 386 of file get_output_name_utils.py.

◆ get_start_day_year()

def mlp.get_output_name_utils.get_start_day_year ( metadata )

Returns the start day and year for a file, determined from the contents of
metadata as ints.

Definition at line 520 of file get_output_name_utils.py.

◆ get_start_doy_year()

def mlp.get_output_name_utils.get_start_doy_year ( data_files )

Extract a day of year and year from a file's metadata and return
them as integer values .

Definition at line 501 of file get_output_name_utils.py.

◆ get_time_period_extension()

def mlp.get_output_name_utils.get_time_period_extension	(	start_date_str,
		end_date_str
	)

Return the part of the file extension based on the time period within the
start and end dates.

Definition at line 548 of file get_output_name_utils.py.

◆ is_month()

def mlp.get_output_name_utils.is_month	(	day1,
		day2
	)

Returns True if the days are the endpoints of a month; False otherwise.

Definition at line 568 of file get_output_name_utils.py.

◆ is_year()

def mlp.get_output_name_utils.is_year	(	day1,
		day2
	)

Returns True if the days are the endpoints of a year; False otherwise.

Definition at line 575 of file get_output_name_utils.py.

◆ read_fileformats()

def mlp.get_output_name_utils.read_fileformats ( )

Returns a tuple containing the file formats.

Definition at line 582 of file get_output_name_utils.py.

Variable Documentation

◆ DEBUG

bool DEBUG = False

Definition at line 22 of file get_output_name_utils.py.

Functions

Variables