DAHITI()

dahitiapi.DAHITI module

class dahitiapi.DAHITI(log_level=20, debug=0, api_key=None)[source]

Bases: API

Client for DAHITI-API.

Handles authentication and data retrieval.

download_bathymetry(dahiti_id, path, **kwargs)[source]

Download bathymetry derived from satellite altimetry and optical imagery for a DAHITI target as GeoTiff

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path of GeoTiff
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

download_discharge_ascii(dahiti_id, **kwargs)[source]

Download time series of river discharge from satellite altimetry and optical imagery for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Discharge time series for a DAHITI target in ASCII format

Return type:

str

download_discharge_ascii_to_file(dahiti_id, path, **kwargs)[source]

Download time series of river discharge from satellite altimetry and optical imagery for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Discharge time series for a DAHITI target in ASCII format

Return type:

str

download_discharge_csv(dahiti_id, **kwargs)[source]

Download time series of river discharge from satellite altimetry and optical imagery for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Discharge time series for a DAHITI target in CSV format

Return type:

str

download_discharge_csv_to_file(dahiti_id, path, **kwargs)[source]

Download time series of river discharge from satellite altimetry and optical imagery for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Discharge time series for a DAHITI target in CSV format

Return type:

str

download_discharge_json(dahiti_id, **kwargs)[source]

Download time series of river discharge from satellite altimetry and optical imagery for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Discharge time series for a DAHITI target in JSON format

Return type:

dict

download_discharge_json_to_file(dahiti_id, path, **kwargs)[source]

Download time series of river discharge from satellite altimetry and optical imagery for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Discharge time series for a DAHITI target in JSON format

Return type:

str

download_discharge_netcdf(dahiti_id, path, **kwargs)[source]

Download time series of river discharge from satellite altimetry and optical imagery for a DAHITI target in NetCDF format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

download_hypsometry(dahiti_id, **kwargs)[source]

Download hypsometry from satellite altimetry and optical imagery for a DAHITI target

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Paramaters of hypsometry model

Return type:

dict

download_land_water_mask(dahiti_id, path, **kwargs)[source]

Download archive of land water masks from optical imagery for a DAHITI target as GeoTiff (compressed as tar.gz archive)

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path of tar.gz archive
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

download_surface_area_ascii(dahiti_id, **kwargs)[source]

Download surface area time series derived from satellite altimetry for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Surface area time series for a DAHITI target in ASCII format

Return type:

str

download_surface_area_ascii_to_file(dahiti_id, path, **kwargs)[source]

Download surface area time series derived from satellite altimetry for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
path – Output path
**kwargs – Optional keyword arguments:

Returns:

Surface area time series for a DAHITI target in ASCII format

Return type:

str

download_surface_area_csv(dahiti_id, **kwargs)[source]

Download surface area time series derived from satellite altimetry for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Surface area time series for a DAHITI target in CSV format

Return type:

str

download_surface_area_csv_to_file(dahiti_id, path, **kwargs)[source]

Download surface area time series derived from satellite altimetry for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
path – Output path
**kwargs – Optional keyword arguments:

Returns:

Surface area time series for a DAHITI target in CSV format

Return type:

str

download_surface_area_json(dahiti_id, **kwargs)[source]

Download surface area time series derived from satellite altimetry for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Surface area time series for a DAHITI target in JSON format

Return type:

dict

download_surface_area_json_to_file(dahiti_id, path, **kwargs)[source]

Download surface area time series derived from satellite altimetry for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
path – Output path
**kwargs – Optional keyword arguments:

Returns:

Surface area time series for a DAHITI target in JSON format

Return type:

dict

download_surface_area_netcdf(dahiti_id, path, **kwargs)[source]

Download surface area time series derived from satellite altimetry for a DAHITI target in NetCDF format

Parameters:

dahiti_id (int) – DAHITI Id
path – Output path
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

download_volume_variation_ascii(dahiti_id, **kwargs)[source]

Download volume variations from satellite altimetry and opical imagery for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Time series of volume variations of DAHITI target in ASCII format

Return type:

str

download_volume_variation_ascii_to_file(dahiti_id, path, **kwargs)[source]

Download volume variations from satellite altimetry and opical imagery for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Time series of volume variations of DAHITI target in ASCII format

Return type:

str

download_volume_variation_csv(dahiti_id, **kwargs)[source]

Download volume variations from satellite altimetry and opical imagery for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Time series of volume variations of DAHITI target in CSV format

Return type:

str

download_volume_variation_csv_to_file(dahiti_id, path, **kwargs)[source]

Download volume variations from satellite altimetry and opical imagery for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Time series of volume variations of DAHITI target in CSV format

Return type:

str

download_volume_variation_json(dahiti_id, **kwargs)[source]

Download volume variations from satellite altimetry and opical imagery for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Time series of volume variations of DAHITI target in JSON format

Return type:

dict

download_volume_variation_json_to_file(dahiti_id, path, **kwargs)[source]

Download volume variations from satellite altimetry and opical imagery for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Time series of volume variations of DAHITI target in JSON format

Return type:

dict

download_volume_variation_netcdf(dahiti_id, path, **kwargs)[source]

Download volume variations from satellite altimetry and opical imagery for a DAHITI target in NetCDF format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

download_water_level_ascii(dahiti_id, **kwargs)[source]

Download water levels from satellite altimetry for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Water level time series for a DAHITI target in ASCII format

Return type:

str

download_water_level_ascii_to_file(dahiti_id, path, **kwargs)[source]

Download water levels from satellite altimetry for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Water level time series for a DAHITI target in ASCII format

Return type:

str

download_water_level_csv(dahiti_id, **kwargs)[source]

Download water levels from satellite altimetry for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Water level time series for a DAHITI target in ASCII format

Return type:

str

download_water_level_csv_to_file(dahiti_id, path, **kwargs)[source]

Download water levels from satellite altimetry for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Water level time series for a DAHITI target in CSV format

Return type:

str

download_water_level_hypsometry_ascii(dahiti_id, **kwargs)[source]

Download water levels from hypsometry derived from satellite altimetry and optical imagery for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Water level time series from hypsometry for a DAHITI target in ASCII format

Return type:

str

download_water_level_hypsometry_ascii_to_file(dahiti_id, path, **kwargs)[source]

Download water levels from hypsometry derived from satellite altimetry and optical imagery for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
path – Output path
**kwargs – Optional keyword arguments:

Returns:

Water level time series from hypsometry for a DAHITI target in ASCII format

Return type:

str

download_water_level_hypsometry_csv(dahiti_id, **kwargs)[source]

Download water levels from hypsometry derived from satellite altimetry and optical imagery for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Water level time series from hypsometry for a DAHITI target in CSV format

Return type:

str

download_water_level_hypsometry_csv_to_file(dahiti_id, path, **kwargs)[source]

Download water levels from hypsometry derived from satellite altimetry and optical imagery for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
path – Output path
**kwargs – Optional keyword arguments:

Returns:

Water level time series from hypsometry for a DAHITI target in CSV format

Return type:

str

download_water_level_hypsometry_json(dahiti_id, **kwargs)[source]

Download water levels from hypsometry derived from satellite altimetry and optical imagery for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Water level time series from hypsometry for a DAHITI target in JSON format

Return type:

dict

download_water_level_hypsometry_json_to_file(dahiti_id, path, **kwargs)[source]

Download water levels from hypsometry derived from satellite altimetry and optical imagery for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
path – Output path
**kwargs – Optional keyword arguments:

Returns:

Water level time series from hypsometry for a DAHITI target in JSON format

Return type:

dict

download_water_level_hypsometry_netcdf(dahiti_id, path, **kwargs)[source]

Download water levels from hypsometry derived from satellite altimetry and optical imagery for a DAHITI target in NetCDF format

Parameters:

dahiti_id (int) – DAHITI Id
path – Output path
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

download_water_level_json(dahiti_id, **kwargs)[source]

Download water levels from satellite altimetry for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

Water level time series for a DAHITI target in JSON format

Return type:

dict

download_water_level_json_to_file(dahiti_id, path, **kwargs)[source]

Download water levels from satellite altimetry for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Water level time series for a DAHITI target in JSON format

Return type:

dict

download_water_level_netcdf(dahiti_id, path, **kwargs)[source]

Download water levels from satellite altimetry for a DAHITI target in NetCDF format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

download_water_occurrence_mask(dahiti_id, path, **kwargs)[source]

Download water occurrence mask derived from optical imagery for a DAHITI target as GeoTiff

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path of GeoTiff
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

download_water_surface_slope_ascii(dahiti_id, **kwargs)[source]

Download time serie of water surface slopes from satellite altimetry for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

time series of water surface slopes for a DAHITI target in ASCII format

Return type:

str

download_water_surface_slope_ascii_to_file(dahiti_id, path, **kwargs)[source]

Download time serie of water surface slopes from satellite altimetry for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

time series of water surface slopes for a DAHITI target in ASCII format

Return type:

str

download_water_surface_slope_csv(dahiti_id, **kwargs)[source]

Download time serie of water surface slopes from satellite altimetry for a DAHITI target in ASCII format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

time series of water surface slopes for a DAHITI target in ASCII format

Return type:

str

download_water_surface_slope_csv_to_file(dahiti_id, path, **kwargs)[source]

Download time serie of water surface slopes from satellite altimetry for a DAHITI target in CSV format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

time series of water surface slopes for a DAHITI target in CSV format

Return type:

str

download_water_surface_slope_json(dahiti_id, **kwargs)[source]

Download time serie of water surface slopes from satellite altimetry for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
**kwargs – Optional keyword arguments:

Returns:

time series of water surface slopes for a DAHITI target in JSON format

Return type:

dict

download_water_surface_slope_json_to_file(dahiti_id, path, **kwargs)[source]

Download time serie of water surface slopes from satellite altimetry for a DAHITI target in JSON format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

time series of water surface slopes for a DAHITI target in JSON format

Return type:

dict

download_water_surface_slope_netcdf(dahiti_id, path, **kwargs)[source]

Download time serie of water surface slopes from satellite altimetry for a DAHITI target in NetCDF format

Parameters:

dahiti_id (int) – DAHITI Id
path (str) – Output path
**kwargs – Optional keyword arguments:

Returns:

Status code of API-request

Return type:

Response

get_nearest_target(longitude, latitude)[source]

get_target_info(dahiti_id, software=None, path=None)[source]

get_targets_by_reach_id(reach_id)[source]

get_targets_in_AOI(aoi)[source]

is_location_in_AOI(longitude, latitude)[source]

list_targets(args)[source]