IODA Bundle
goes_converter.GoesConverter Class Reference

Public Member Functions

def __init__ (self, input_file_paths, latlon_file_path, output_file_path_rf, output_file_path_bt)
 
def convert (self)
 

Private Member Functions

def _check_arguments (self)
 
def _create_input_data_file_dicts (self)
 
def _check_nadir (self)
 
def _get_nadir_attribute_latlon (self)
 
def _get_nadir_attribute_template (self)
 
def _check_latlon_file_path (self)
 
def _create_latlon_dataset (self)
 
def _close_datasets (self)
 
def _create_metadata_latitude_variables (self)
 
def _create_metadata_longitude_variables (self)
 
def _create_metadata_scan_angle_variables (self)
 
def _create_metadata_elevation_angle_variables (self)
 
def _create_groups (self)
 
def _create_nlocs_dimensions (self)
 
def _create_nchans_dimensions (self)
 
def _create_nvars_dimensions (self)
 
def _create_ndatetime_dimensions (self)
 
def _create_nstring_dimensions (self)
 
def _create_preqc_reflectance_factor_variable (self)
 
def _create_preqc_brightness_temperature_variable (self)
 
def _create_obsvalue_reflectance_factor_variable (self)
 
def _create_obsvalue_brightness_temperature_variable (self)
 
def _create_obserror_reflectance_factor_variable (self)
 
def _create_obserror_brightness_temperature_variable (self)
 
def _create_metadata_time_variables (self)
 
def _create_varmetadata_sensor_channel_variables (self)
 
def _create_varmetadata_variable_names_variables (self)
 
def _create_root_group_attributes (self)
 

Static Private Member Functions

def _get_nlocs (dataset)
 

Private Attributes

 _input_file_paths
 
 _latlon_file_path
 
 _output_file_path_rf
 
 _output_file_path_bt
 
 _latlon_dataset
 
 _output_dataset_bt
 
 _output_dataset_rf
 
 _goes_dict_rf
 
 _goes_dict_bt
 
 _template_input_file_path
 
 _goes_lat_lon
 

Detailed Description

Definition at line 48 of file goes_converter.py.

Constructor & Destructor Documentation

◆ __init__()

def goes_converter.GoesConverter.__init__ (   self,
  input_file_paths,
  latlon_file_path,
  output_file_path_rf,
  output_file_path_bt 
)
Constructor
input_file_paths - A list of the absolute paths to all 16 ABI channels from the same hour
latlon_file_path - The path to an existing Goes LatLon file or if it does not exist the path to write the file
output_file_path_rf - The path to write the IODAv2 reflectance factor data file
output_file_path_bt - The path to write the IODAv2 brightness temperature data file

Definition at line 50 of file goes_converter.py.

Member Function Documentation

◆ _check_arguments()

def goes_converter.GoesConverter._check_arguments (   self)
private
Checks the input arguments.

Definition at line 67 of file goes_converter.py.

◆ _check_latlon_file_path()

def goes_converter.GoesConverter._check_latlon_file_path (   self)
private
Returns a boolean variable indicating whether the Goes LatLon file exists.

Definition at line 126 of file goes_converter.py.

Here is the caller graph for this function:

◆ _check_nadir()

def goes_converter.GoesConverter._check_nadir (   self)
private
Returns a boolean variable indicating whether the nadir has changed by comparing the lat_nadir and lon_nadir
attributes extracted from the GoesLatLon data file and the Goes template data file.

Definition at line 97 of file goes_converter.py.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ _close_datasets()

def goes_converter.GoesConverter._close_datasets (   self)
private
Closes the Goes latlon, reflectance factor, and brightness temperature netCDF4 Datasets.

Definition at line 139 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_groups()

def goes_converter.GoesConverter._create_groups (   self)
private
Creates the required groups in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 188 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_input_data_file_dicts()

def goes_converter.GoesConverter._create_input_data_file_dicts (   self)
private
Create two local dictionaries contained the Goes class instances for brightness temperature (ABI channels 1-6)
and reflectance factor (ABI channels 7-16). Each Goes instance calls the load method. This function also
assigns the file path for a template GOES file from ABI channel 7.

Definition at line 78 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_latlon_dataset()

def goes_converter.GoesConverter._create_latlon_dataset (   self)
private
Creates a new Goes LatLon data file using the GoesLatLon class.

Definition at line 132 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_metadata_elevation_angle_variables()

def goes_converter.GoesConverter._create_metadata_elevation_angle_variables (   self)
private
Creates the /MetaData/elevation_angle variable in the reflectance factor and brightness temperature netCDF4
Datasets.

Definition at line 177 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_metadata_latitude_variables()

def goes_converter.GoesConverter._create_metadata_latitude_variables (   self)
private
Creates the /MetaData/latitude variable in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 147 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_metadata_longitude_variables()

def goes_converter.GoesConverter._create_metadata_longitude_variables (   self)
private
Creates the /MetaData/longitude variable in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 157 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_metadata_scan_angle_variables()

def goes_converter.GoesConverter._create_metadata_scan_angle_variables (   self)
private
Creates the /MetaData/scan_angle variable in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 167 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_metadata_time_variables()

def goes_converter.GoesConverter._create_metadata_time_variables (   self)
private
Creates the /MetaData/datetime and MetaData/time variables and /date_time attribute in the reflectance factor
and brightness temperature netCDF4 Datasets.

Definition at line 390 of file goes_converter.py.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ _create_nchans_dimensions()

def goes_converter.GoesConverter._create_nchans_dimensions (   self)
private
Creates the nchans dimension in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 217 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_ndatetime_dimensions()

def goes_converter.GoesConverter._create_ndatetime_dimensions (   self)
private
Creates the ndatetime dimension in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 243 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_nlocs_dimensions()

def goes_converter.GoesConverter._create_nlocs_dimensions (   self)
private
Creates the nlocs dimension in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 203 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_nstring_dimensions()

def goes_converter.GoesConverter._create_nstring_dimensions (   self)
private
Creates the nstring dimension in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 255 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_nvars_dimensions()

def goes_converter.GoesConverter._create_nvars_dimensions (   self)
private
Creates the nvars dimension in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 230 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_obserror_brightness_temperature_variable()

def goes_converter.GoesConverter._create_obserror_brightness_temperature_variable (   self)
private
Creates the /ObsError/brightness_temperature variable in the brightness temperature netCDF4 Dataset.

Definition at line 372 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_obserror_reflectance_factor_variable()

def goes_converter.GoesConverter._create_obserror_reflectance_factor_variable (   self)
private
Creates the /ObsError/reflectance_factor variable in the reflectance factor netCDF4 Dataset.

Definition at line 355 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_obsvalue_brightness_temperature_variable()

def goes_converter.GoesConverter._create_obsvalue_brightness_temperature_variable (   self)
private
Creates the /ObsValue/brightness_temperature variable in the brightness temperature netCDF4 Dataset.

Definition at line 337 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_obsvalue_reflectance_factor_variable()

def goes_converter.GoesConverter._create_obsvalue_reflectance_factor_variable (   self)
private
Creates the /ObsValue/reflectance_factor variable in the reflectance factor netCDF4 Dataset.

Definition at line 320 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_preqc_brightness_temperature_variable()

def goes_converter.GoesConverter._create_preqc_brightness_temperature_variable (   self)
private
Creates the /PreQC/brightness_temperature variable and associated attributes in the brightness temperature
netCDF4 Dataset.

Definition at line 297 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_preqc_reflectance_factor_variable()

def goes_converter.GoesConverter._create_preqc_reflectance_factor_variable (   self)
private
Creates the /PreQC/reflectance_factor variable variable and associated attributes in the reflectance factor
netCDF4 Dataset.

Definition at line 275 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_root_group_attributes()

def goes_converter.GoesConverter._create_root_group_attributes (   self)
private
Creates several root group attributes in the reflectance factor and brightness temperature netCDF4 Datasets.

Definition at line 437 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_varmetadata_sensor_channel_variables()

def goes_converter.GoesConverter._create_varmetadata_sensor_channel_variables (   self)
private
Creates the /VarMetaData/sensor_channel variable in the reflectance factor and brightness temperature netCDF4
Datasets.

Definition at line 411 of file goes_converter.py.

Here is the caller graph for this function:

◆ _create_varmetadata_variable_names_variables()

def goes_converter.GoesConverter._create_varmetadata_variable_names_variables (   self)
private
Creates the /VarMetaData/variable_names variable in the reflectance factor and brightness temperature netCDF4
Datasets.

Definition at line 421 of file goes_converter.py.

Here is the caller graph for this function:

◆ _get_nadir_attribute_latlon()

def goes_converter.GoesConverter._get_nadir_attribute_latlon (   self)
private
Returns the lat and lon nadir attribute from the Goes LatLon data file.

Definition at line 106 of file goes_converter.py.

Here is the caller graph for this function:

◆ _get_nadir_attribute_template()

def goes_converter.GoesConverter._get_nadir_attribute_template (   self)
private
Returns the lat and lon nadir attribute from the Goes template data file.

Definition at line 116 of file goes_converter.py.

Here is the caller graph for this function:

◆ _get_nlocs()

def goes_converter.GoesConverter._get_nlocs (   dataset)
staticprivate
Returns the nlocs dimension size for the provided netCDF4 Dataset.
dataset - the dataset to extract the nlocs size

Definition at line 268 of file goes_converter.py.

Here is the caller graph for this function:

◆ convert()

def goes_converter.GoesConverter.convert (   self)
Creates the reflectance factor and brightness temperature IODAv2 data files. This functions also checks for
the existence and nadir change of the Goes LatLon data file.

Definition at line 446 of file goes_converter.py.

Here is the call graph for this function:

Member Data Documentation

◆ _goes_dict_bt

goes_converter.GoesConverter._goes_dict_bt
private

Definition at line 86 of file goes_converter.py.

◆ _goes_dict_rf

goes_converter.GoesConverter._goes_dict_rf
private

Definition at line 85 of file goes_converter.py.

◆ _goes_lat_lon

goes_converter.GoesConverter._goes_lat_lon
private

Definition at line 136 of file goes_converter.py.

◆ _input_file_paths

goes_converter.GoesConverter._input_file_paths
private

Definition at line 58 of file goes_converter.py.

◆ _latlon_dataset

goes_converter.GoesConverter._latlon_dataset
private

Definition at line 62 of file goes_converter.py.

◆ _latlon_file_path

goes_converter.GoesConverter._latlon_file_path
private

Definition at line 59 of file goes_converter.py.

◆ _output_dataset_bt

goes_converter.GoesConverter._output_dataset_bt
private

Definition at line 63 of file goes_converter.py.

◆ _output_dataset_rf

goes_converter.GoesConverter._output_dataset_rf
private

Definition at line 64 of file goes_converter.py.

◆ _output_file_path_bt

goes_converter.GoesConverter._output_file_path_bt
private

Definition at line 61 of file goes_converter.py.

◆ _output_file_path_rf

goes_converter.GoesConverter._output_file_path_rf
private

Definition at line 60 of file goes_converter.py.

◆ _template_input_file_path

goes_converter.GoesConverter._template_input_file_path
private

Definition at line 95 of file goes_converter.py.


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