goes.Goes Class Reference

Public Member Functions
def	__init__ (self, input_file_path)
def	get_abi_channel (self)
def	get_platform_identifier (self)
def	get_start_date (self)
def	get_input_file_path (self)
def	get_obsvalue_rf_data_array (self)
def	get_obsvalue_bt_data_array (self)
def	get_obserror_rf_data_array (self)
def	get_obserror_bt_data_array (self)
def	get_preqc_data_array (self)
def	close (self)
def	load (self)

Private Member Functions
def	_get_metadata_from_input_file_path (self)
def	_open (self)
def	_load_yaw_flip_flag_variable (self)
def	_load_kappa0_variable (self)
def	_load_planck_variables (self)
def	_load_std_dev_radiance_value_of_valid_pixels_variable (self)
def	_load_valid_pixel_count_variable (self)
def	_load_dqf_data_array (self)
def	_load_rad_data_array (self)
def	_filter_data_array_by_yaw_flip_flag (self, data_array)
def	_create_obsvalue_rf_data_array (self)
def	_create_obsvalue_bt_data_array (self)
def	_create_obserror_rf_data_array (self)
def	_create_obserror_bt_data_array (self)

Static Private Member Functions
def	_subsample (rad_data_array, dqf_data_array, increment)
def	_subsample2 (rad_data_array, dqf_data_array, increment)
def	_downscale_1km_to_2km (rad_data_array, dqf_data_array)
def	_downscale_05km_to_2km (rad_data_array, dqf_data_array)
def	_string_to_abimode (string)
def	_string_to_abisectortype (string)

Private Attributes
	_input_file_path
	_rad_data_array
	_dqf_data_array
	_obsvalue_rf_data_array
	_obsvalue_bt_data_array
	_obserror_rf_data_array
	_obserror_bt_data_array
	_metadata_dict
	_input_dataset
	_yaw_flip_flag
	_kappa0
	_planck_bc1
	_planck_bc2
	_planck_fk1
	_planck_fk2
	_std_dev_radiance_value_of_valid_pixels
	_valid_pixel_count

Detailed Description

Definition at line 24 of file goes.py.

Constructor & Destructor Documentation

__init__()

def goes.Goes.__init__	(		self,
			input_file_path
	)

Constructor
input_file_path - a GOES-16 or GOES-17 raw data file for a single ABI channel

Definition at line 26 of file goes.py.

Member Function Documentation

_create_obserror_bt_data_array()

def goes.Goes._create_obserror_bt_data_array (   self )

private

Creates a local data array variable containing the calculated obserror brightness temperature data
after fill value filtering by the DQF flags.

Definition at line 279 of file goes.py.

Here is the caller graph for this function:

_create_obserror_rf_data_array()

def goes.Goes._create_obserror_rf_data_array (   self )

private

Creates a local data array variable containing the calculated obserror reflectance factor data
after fill value filtering by the DQF flags.

Definition at line 270 of file goes.py.

Here is the caller graph for this function:

_create_obsvalue_bt_data_array()

def goes.Goes._create_obsvalue_bt_data_array (   self )

private

Creates a local data array variable containing the calculated obsvalue brightness temperature data
after fill value filtering by the DQF flags.

Definition at line 261 of file goes.py.

Here is the caller graph for this function:

_create_obsvalue_rf_data_array()

def goes.Goes._create_obsvalue_rf_data_array (   self )

private

Creates a local data array variable containing the calculated obsvalue reflectance factor data
after fill value filtering by the DQF flags.

Definition at line 253 of file goes.py.

Here is the caller graph for this function:

_downscale_05km_to_2km()

def goes.Goes._downscale_05km_to_2km (   rad_data_array,   dqf_data_array  )

staticprivate

Returns the dqf and rad data arrays after being down-sampled from 0.5km to 2km resolution taking account for
pixel averaging and the DQF valid pixel flags. This routine is computationally expensive.

Definition at line 181 of file goes.py.

_downscale_1km_to_2km()

def goes.Goes._downscale_1km_to_2km (   rad_data_array,   dqf_data_array  )

staticprivate

Returns the dqf and rad data arrays after being down-sampled from 1km to 2km resolution taking account for
pixel averaging and the DQF valid pixel flags. This routine is computationally expensive.

Definition at line 146 of file goes.py.

_filter_data_array_by_yaw_flip_flag()

def goes.Goes._filter_data_array_by_yaw_flip_flag (   self,   data_array  )

private

Returns data_array after filtering by the yaw_flip_flag.
data_array - the data array to filter

Definition at line 243 of file goes.py.

Here is the caller graph for this function:

_get_metadata_from_input_file_path()

def goes.Goes._get_metadata_from_input_file_path (   self )

private

Creates a dictionary of file metadata from input_file_path

Definition at line 40 of file goes.py.

_load_dqf_data_array()

def goes.Goes._load_dqf_data_array (   self )

private

Creates a local data array for the DQF variable.

Definition at line 97 of file goes.py.

Here is the caller graph for this function:

_load_kappa0_variable()

def goes.Goes._load_kappa0_variable (   self )

private

Creates a local kappa0 variable.

Definition at line 69 of file goes.py.

Here is the caller graph for this function:

_load_planck_variables()

def goes.Goes._load_planck_variables (   self )

private

Creates a local variables for the four Planck constants.

Definition at line 75 of file goes.py.

Here is the caller graph for this function:

_load_rad_data_array()

def goes.Goes._load_rad_data_array (   self )

private

Creates a local data array for the Rad variable.

Definition at line 103 of file goes.py.

Here is the caller graph for this function:

_load_std_dev_radiance_value_of_valid_pixels_variable()

def goes.Goes._load_std_dev_radiance_value_of_valid_pixels_variable (   self )

private

Creates a local variable for the standard deviation of radiance for only valid pixels.

Definition at line 84 of file goes.py.

Here is the caller graph for this function:

_load_valid_pixel_count_variable()

def goes.Goes._load_valid_pixel_count_variable (   self )

private

Creates a local variable of valid pixel counts.

Definition at line 91 of file goes.py.

Here is the caller graph for this function:

_load_yaw_flip_flag_variable()

def goes.Goes._load_yaw_flip_flag_variable (   self )

private

Creates a local yaw_flip_flag variable.

Definition at line 63 of file goes.py.

Here is the caller graph for this function:

_open()

def goes.Goes._open (   self )

private

Opens a netCDF4 dataset using input_file_path.

Definition at line 57 of file goes.py.

Here is the caller graph for this function:

_string_to_abimode()

def goes.Goes._string_to_abimode (   string )

staticprivate

Selects the ABI Mode Enum constant from string.
string - the string used for the match

Definition at line 218 of file goes.py.

_string_to_abisectortype()

def goes.Goes._string_to_abisectortype (   string )

staticprivate

Selects the ABI Sector Type constant from string.
string - the string used for the match

Definition at line 229 of file goes.py.

_subsample()

def goes.Goes._subsample (   rad_data_array,   dqf_data_array,   increment  )

staticprivate

Returns the dqf and rad data arrays after being subsampled with the given increment (aka step)
between data points using array slicing.

Definition at line 110 of file goes.py.

_subsample2()

def goes.Goes._subsample2 (   rad_data_array,   dqf_data_array,   increment  )

staticprivate

Returns the dqf and rad data arrays after being subsampled with the given increment (aka step)
between data points using array looping.

Definition at line 123 of file goes.py.

close()

def goes.Goes.close

(

self

)

Closes this netCDF4 Dataset.

Definition at line 345 of file goes.py.

Here is the caller graph for this function:

get_abi_channel()

def goes.Goes.get_abi_channel

(

self

)

Returns the ABI channel.

Definition at line 291 of file goes.py.

get_input_file_path()

def goes.Goes.get_input_file_path

(

self

)

Returns the input_file_path.

Definition at line 309 of file goes.py.

get_obserror_bt_data_array()

def goes.Goes.get_obserror_bt_data_array

(

self

)

Returns the obserror brightness temperature data array.

Definition at line 333 of file goes.py.

get_obserror_rf_data_array()

def goes.Goes.get_obserror_rf_data_array

(

self

)

Returns the obserror reflectance factor data array.

Definition at line 327 of file goes.py.

get_obsvalue_bt_data_array()

def goes.Goes.get_obsvalue_bt_data_array

(

self

)

Returns the obsvalue brightness temperature data array.

Definition at line 321 of file goes.py.

get_obsvalue_rf_data_array()

def goes.Goes.get_obsvalue_rf_data_array

(

self

)

Returns the obsvalue reflectance factor data array.

Definition at line 315 of file goes.py.

get_platform_identifier()

def goes.Goes.get_platform_identifier

(

self

)

Returns the platform identifier.

Definition at line 297 of file goes.py.

get_preqc_data_array()

def goes.Goes.get_preqc_data_array

(

self

)

Returns the preqc data array.

Definition at line 339 of file goes.py.

get_start_date()

def goes.Goes.get_start_date

(

self

)

Returns the scan's start date.

Definition at line 303 of file goes.py.

load()

def goes.Goes.load

(

self

)

Loads, calculates, subsamples, reshapes, and filters all data arrays required by the GoesConverter class.

Definition at line 351 of file goes.py.

Here is the call graph for this function:

Member Data Documentation

_dqf_data_array

goes.Goes._dqf_data_array

private

Definition at line 34 of file goes.py.

_input_dataset

goes.Goes._input_dataset

private

Definition at line 61 of file goes.py.

_input_file_path

goes.Goes._input_file_path

private

Definition at line 31 of file goes.py.

_kappa0

goes.Goes._kappa0

private

Definition at line 73 of file goes.py.

_metadata_dict

goes.Goes._metadata_dict

private

Definition at line 44 of file goes.py.

_obserror_bt_data_array

goes.Goes._obserror_bt_data_array

private

Definition at line 38 of file goes.py.

_obserror_rf_data_array

goes.Goes._obserror_rf_data_array

private

Definition at line 37 of file goes.py.

_obsvalue_bt_data_array

goes.Goes._obsvalue_bt_data_array

private

Definition at line 36 of file goes.py.

_obsvalue_rf_data_array

goes.Goes._obsvalue_rf_data_array

private

Definition at line 35 of file goes.py.

_planck_bc1

goes.Goes._planck_bc1

private

Definition at line 79 of file goes.py.

_planck_bc2

goes.Goes._planck_bc2

private

Definition at line 80 of file goes.py.

_planck_fk1

goes.Goes._planck_fk1

private

Definition at line 81 of file goes.py.

_planck_fk2

goes.Goes._planck_fk2

private

Definition at line 82 of file goes.py.

_rad_data_array

goes.Goes._rad_data_array

private

Definition at line 33 of file goes.py.

_std_dev_radiance_value_of_valid_pixels

goes.Goes._std_dev_radiance_value_of_valid_pixels

private

Definition at line 88 of file goes.py.

_valid_pixel_count

goes.Goes._valid_pixel_count

private

Definition at line 95 of file goes.py.

_yaw_flip_flag

goes.Goes._yaw_flip_flag

private

Definition at line 67 of file goes.py.

---

The documentation for this class was generated from the following file:

• goes.py