hypso.reading.load

Module Contents

Functions

load_nc(nc_file_path, standardDimensions)

Load l1a.nc Hypso Capture file

get_lat_lon_2d(latitude_dataPath, longitude_dataPath, ...)

Load Latitude and Longitude 2D arrays from generated tmp files

get_local_angles(sat_azimuth_path, sat_zenith_path, ...)

Load Satellite and Solar Angles from generated tmp files

get_metainfo_from_nc_file(nc_file_path, standardDimensions)

Get the metadata from the top folder of the data.

get_raw_cube_from_nc_file(nc_file_path)

Get Raw Cube from Hypso l1a.nc File

Attributes

EXPERIMENTAL_FEATURES

hypso.reading.load.EXPERIMENTAL_FEATURES = True
hypso.reading.load.load_nc(nc_file_path, standardDimensions)

Load l1a.nc Hypso Capture file

Parameters:

  • nc_file_path (pathlib.Path) – Absolute path to the l1a.nc file

  • standardDimensions (dict) – Dictionary with Standard Hypso allowed dimensions

Returns:

“info” Dictionary with Hypso capture information, raw cube numpy array (digital counts) and capture spatial dimensions

Return type:

Tuple[dict, numpy.ndarray, tuple]

hypso.reading.load.get_lat_lon_2d(latitude_dataPath, longitude_dataPath, info, spatialDim)

Load Latitude and Longitude 2D arrays from generated tmp files

Parameters:

  • latitude_dataPath (pathlib.Path) – Absolute path to Latitude .dat file

  • longitude_dataPath (pathlib.Path) – Absolute path to Longitude .dat file

  • info (dict) – Info Dictionary to mutate with new information

  • spatialDim (tuple) – Spatial dimension of the Hypso capture

Returns:

Updated “info” dictionary with the latitude and longitude 2D arrays

Return type:

dict

hypso.reading.load.get_local_angles(sat_azimuth_path, sat_zenith_path, solar_azimuth_path, solar_zenith_path, info, spatialDim)

Load Satellite and Solar Angles from generated tmp files

Parameters:

  • sat_azimuth_path (pathlib.Path) – Absolute path to Satellite (Viewing) Azimuth .dat file

  • sat_zenith_path (pathlib.Path) – Absolute path to Satellite (Viewing) Zenith .dat file

  • solar_azimuth_path (pathlib.Path) – Absolute path to Solar Azimuth .dat file

  • solar_zenith_path (pathlib.Path) – Absolute path to Solar Zenith .dat file

  • info (dict) – Info Dictionary to mutate with new information

  • spatialDim (tuple) – Spatial dimension of the Hypso capture

Returns:

Updated “info” dictionary with the Arrays of the solar and satellite (viewing) angles

Return type:

dict

hypso.reading.load.get_metainfo_from_nc_file(nc_file_path, standardDimensions)

Get the metadata from the top folder of the data.

Parameters:

  • nc_file_path (pathlib.Path) – Path to the name of the tmp folder

  • standardDimensions (dict) – Dictionary with Hypso standard dimensions

Returns:

“info” dictionary with the data and a tuple with spatial dimensions

Return type:

Tuple[dict, tuple]

hypso.reading.load.get_raw_cube_from_nc_file(nc_file_path)

Get Raw Cube from Hypso l1a.nc File

Parameters:

nc_file_path (pathlib.Path) – Absolute path to l1a.nc file

Returns:

Numpy array with raw Cube (digital counts) extracted from nc file

Return type:

numpy.ndarray