From 9ef0b42d2359ff3c1731ec7295ba0855a3d1fd7b Mon Sep 17 00:00:00 2001 From: jan <152862650+j-haacker@users.noreply.github.com> Date: Thu, 10 Oct 2024 23:54:47 +0200 Subject: [PATCH] add docs --- _sources/tutorials.rst.txt | 18 ++++++++++++++++-- searchindex.js | 2 +- tutorials.html | 12 ++++++++++-- 3 files changed, 27 insertions(+), 5 deletions(-) diff --git a/_sources/tutorials.rst.txt b/_sources/tutorials.rst.txt index af61f9c..e37f0ee 100644 --- a/_sources/tutorials.rst.txt +++ b/_sources/tutorials.rst.txt @@ -4,6 +4,20 @@ Tutorials There is a small number of tutorials that will be extended if I find support. Those are Jupyter notebooks located in ``scripts`` with names starting with "tutorial". -``scripts/tutorial.ipynb`` will contain a step-by-step guide to retrieve gridded glacier surface elevation trends from raw (L1b) data. +`scripts/tutorial.ipynb +`_ +will contain a step-by-step guide to retrieve gridded glacier surface +elevation trends from raw (L1b) data. -``scripts/tutorial__poca.ipynb`` shows how the points of closest approach (POCA), that have a special meaning, can be retrieved. +`scripts/tutorial__process_first_waveform.ipynb +`_ +explains how to visualize single waveforms. + +`scripts/tutorial__process_first_swath.ipynb +`_ +teaches the retrieval of elevation estimates for a ceratin satellite track. + +`scripts/tutorial__poca.ipynb +`_ +shows how the points of closest approach (POCA), that have a special +meaning, can be retrieved. diff --git a/searchindex.js b/searchindex.js index 11bc8b9..9454588 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Contents:": [[8, null]], "Data dependencies": [[9, "data-dependencies"]], "Getting started": [[7, null]], "Installation": [[9, "installation"]], "Module contents": [[6, "module-cryoswath.test_plots"]], "Prerequisites": [[9, null]], "Processing the first swath": [[7, "processing-the-first-swath"]], "Processing the first waveform": [[7, "processing-the-first-waveform"]], "Software dependencies": [[9, "software-dependencies"]], "Submodules": [[6, "submodules"]], "Tests": [[10, null]], "Tutorials": [[11, null]], "Welcome to cryoswath\u2019s documentation!": [[8, null]], "cryoswath.gis module": [[0, null]], "cryoswath.l1b module": [[1, null]], "cryoswath.l2 module": [[2, null]], "cryoswath.l3 module": [[3, null]], "cryoswath.l4 module": [[4, null]], "cryoswath.misc module": [[5, null]], "cryoswath.test_plots package": [[6, null]], "cryoswath.test_plots.maps module": [[6, "cryoswath-test-plots-maps-module"]], "cryoswath.test_plots.timeseries module": [[6, "cryoswath-test-plots-timeseries-module"]], "cryoswath.test_plots.waveform module": [[6, "module-cryoswath.test_plots.waveform"]]}, "docnames": ["cryoswath.gis", "cryoswath.l1b", "cryoswath.l2", "cryoswath.l3", "cryoswath.l4", "cryoswath.misc", "cryoswath.test_plots", "getting_started", "index", "prerequisites", "tests", "tutorials"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["cryoswath.gis.rst", "cryoswath.l1b.rst", "cryoswath.l2.rst", "cryoswath.l3.rst", "cryoswath.l4.rst", "cryoswath.misc.rst", "cryoswath.test_plots.rst", "getting_started.rst", "index.rst", "prerequisites.rst", "tests.rst", "tutorials.rst"], "indexentries": {"add() (cryoswath.misc.binary_chache method)": [[5, "cryoswath.misc.binary_chache.add", false]], "append_ambiguous_reference_elevation() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.append_ambiguous_reference_elevation", false]], "append_basin_group() (in module cryoswath.l3)": [[3, "cryoswath.l3.append_basin_group", false]], "append_basin_id() (in module cryoswath.l3)": [[3, "cryoswath.l3.append_basin_id", false]], "append_best_fit_phase_index() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.append_best_fit_phase_index", false]], "append_elev_diff_to_ref() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.append_elev_diff_to_ref", false]], "append_elevation_reference() (in module cryoswath.l3)": [[3, "cryoswath.l3.append_elevation_reference", false]], "append_exclude_mask() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.append_exclude_mask", false]], "append_poca_and_swath_idxs() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.append_poca_and_swath_idxs", false]], "append_smoothed_complex_phase() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.append_smoothed_complex_phase", false]], "binary_chache (class in cryoswath.misc)": [[5, "cryoswath.misc.binary_chache", false]], "buffer_4326_shp() (in module cryoswath.gis)": [[0, "cryoswath.gis.buffer_4326_shp", false]], "build_dataset() (in module cryoswath.l3)": [[3, "cryoswath.l3.build_dataset", false]], "build_flag_mask() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.build_flag_mask", false]], "build_path() (in module cryoswath.l3)": [[3, "cryoswath.l3.build_path", false]], "cache (cryoswath.misc.binary_chache property)": [[5, "cryoswath.misc.binary_chache.cache", false]], "convert_all_esri_to_feather() (in module cryoswath.misc)": [[5, "cryoswath.misc.convert_all_esri_to_feather", false]], "cryoswath.gis": [[0, "module-cryoswath.gis", false]], "cryoswath.l1b": [[1, "module-cryoswath.l1b", false]], "cryoswath.l2": [[2, "module-cryoswath.l2", false]], "cryoswath.l3": [[3, "module-cryoswath.l3", false]], "cryoswath.l4": [[4, "module-cryoswath.l4", false]], "cryoswath.misc": [[5, "module-cryoswath.misc", false]], "cryoswath.test_plots": [[6, "module-cryoswath.test_plots", false]], "cryoswath.test_plots.waveform": [[6, "module-cryoswath.test_plots.waveform", false]], "cs_id_to_time() (in module cryoswath.misc)": [[5, "cryoswath.misc.cs_id_to_time", false]], "cs_time_to_id() (in module cryoswath.misc)": [[5, "cryoswath.misc.cs_time_to_id", false]], "dem_transect() (in module cryoswath.test_plots.waveform)": [[6, "cryoswath.test_plots.waveform.dem_transect", false]], "difference_to_reference_dem() (in module cryoswath.l4)": [[4, "cryoswath.l4.difference_to_reference_dem", false]], "differential_change() (in module cryoswath.l4)": [[4, "cryoswath.l4.differential_change", false]], "download_files() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.download_files", false]], "download_single_file() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.download_single_file", false]], "download_wrapper() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.download_wrapper", false]], "drop_waveform() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.drop_waveform", false]], "ensure_pyproj_crs() (in module cryoswath.gis)": [[0, "cryoswath.gis.ensure_pyproj_crs", false]], "esri_to_feather() (in module cryoswath.gis)": [[0, "cryoswath.gis.esri_to_feather", false]], "extend_filename() (in module cryoswath.misc)": [[5, "cryoswath.misc.extend_filename", false]], "fill_missing_coords() (in module cryoswath.l3)": [[3, "cryoswath.l3.fill_missing_coords", false]], "fill_voids() (in module cryoswath.l3)": [[3, "cryoswath.l3.fill_voids", false]], "filter_kwargs() (in module cryoswath.misc)": [[5, "cryoswath.misc.filter_kwargs", false]], "find_planar_crs() (in module cryoswath.gis)": [[0, "cryoswath.gis.find_planar_crs", false]], "find_region_id() (in module cryoswath.misc)": [[5, "cryoswath.misc.find_region_id", false]], "fit_trend() (in module cryoswath.l4)": [[4, "cryoswath.l4.fit_trend", false]], "flag_outliers() (in module cryoswath.misc)": [[5, "cryoswath.misc.flag_outliers", false]], "flag_translator() (in module cryoswath.misc)": [[5, "cryoswath.misc.flag_translator", false]], "from_id() (cryoswath.l1b.l1bdata class method)": [[1, "cryoswath.l1b.L1bData.from_id", false]], "from_id() (in module cryoswath.l2)": [[2, "cryoswath.l2.from_id", false]], "from_processed_l1b() (in module cryoswath.l2)": [[2, "cryoswath.l2.from_processed_l1b", false]], "gauss_filter_dataarray() (in module cryoswath.misc)": [[5, "cryoswath.misc.gauss_filter_DataArray", false]], "get_4326_to_dem_transformer() (in module cryoswath.gis)": [[0, "cryoswath.gis.get_4326_to_dem_Transformer", false]], "get_dem_reader() (in module cryoswath.misc)": [[5, "cryoswath.misc.get_dem_reader", false]], "get_lon_origin() (in module cryoswath.gis)": [[0, "cryoswath.gis.get_lon_origin", false]], "get_rgi_o2() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.get_rgi_o2", false]], "interpolate_hypsometrically() (in module cryoswath.misc)": [[5, "cryoswath.misc.interpolate_hypsometrically", false]], "interpolate_hypsometrically_poly3() (in module cryoswath.l3)": [[3, "cryoswath.l3.interpolate_hypsometrically_poly3", false]], "l1bdata (class in cryoswath.l1b)": [[1, "cryoswath.l1b.L1bData", false]], "limit_filter() (in module cryoswath.l2)": [[2, "cryoswath.l2.limit_filter", false]], "load_basins() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_basins", false]], "load_cs_full_file_names() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_cs_full_file_names", false]], "load_cs_ground_tracks() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_cs_ground_tracks", false]], "load_glacier_outlines() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_glacier_outlines", false]], "load_o1region() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_o1region", false]], "load_o2region() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_o2region", false]], "locate_ambiguous_origin() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.locate_ambiguous_origin", false]], "med_iqr_cnt() (in module cryoswath.l3)": [[3, "cryoswath.l3.med_iqr_cnt", false]], "merge_l2_cache() (in module cryoswath.misc)": [[5, "cryoswath.misc.merge_l2_cache", false]], "module": [[0, "module-cryoswath.gis", false], [1, "module-cryoswath.l1b", false], [2, "module-cryoswath.l2", false], [3, "module-cryoswath.l3", false], [4, "module-cryoswath.l4", false], [5, "module-cryoswath.misc", false], [6, "module-cryoswath.test_plots", false], [6, "module-cryoswath.test_plots.waveform", false]], "nan_unique() (in module cryoswath.misc)": [[5, "cryoswath.misc.nan_unique", false]], "phase_jump() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.phase_jump", false]], "phase_outlier() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.phase_outlier", false]], "points_on_glacier() (in module cryoswath.gis)": [[0, "cryoswath.gis.points_on_glacier", false]], "process_and_save() (in module cryoswath.l2)": [[2, "cryoswath.l2.process_and_save", false]], "ref_range() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.ref_range", false]], "relative_change() (in module cryoswath.l4)": [[4, "cryoswath.l4.relative_change", false]], "repair_l2_cache() (in module cryoswath.misc)": [[5, "cryoswath.misc.repair_l2_cache", false]], "request_workers() (in module cryoswath.misc)": [[5, "cryoswath.misc.request_workers", false]], "rgi_code_translator() (in module cryoswath.misc)": [[5, "cryoswath.misc.rgi_code_translator", false]], "rgi_o1region_translator() (in module cryoswath.misc)": [[5, "cryoswath.misc.rgi_o1region_translator", false]], "rgi_o2region_translator() (in module cryoswath.misc)": [[5, "cryoswath.misc.rgi_o2region_translator", false]], "simplify_4326_shp() (in module cryoswath.gis)": [[0, "cryoswath.gis.simplify_4326_shp", false]], "subdivide_region() (in module cryoswath.gis)": [[0, "cryoswath.gis.subdivide_region", false]], "tag_groups() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.tag_groups", false]], "to_l2() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.to_l2", false]], "unwrap_phase_diff() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.unwrap_phase_diff", false]], "weighted_mean_excl_outliers() (in module cryoswath.misc)": [[5, "cryoswath.misc.weighted_mean_excl_outliers", false]], "xycut() (in module cryoswath.misc)": [[5, "cryoswath.misc.xycut", false]]}, "objects": {"cryoswath": [[0, 0, 0, "-", "gis"], [1, 0, 0, "-", "l1b"], [2, 0, 0, "-", "l2"], [3, 0, 0, "-", "l3"], [4, 0, 0, "-", "l4"], [5, 0, 0, "-", "misc"], [6, 0, 0, "-", "test_plots"]], "cryoswath.gis": [[0, 1, 1, "", "buffer_4326_shp"], [0, 1, 1, "", "ensure_pyproj_crs"], [0, 1, 1, "", "esri_to_feather"], [0, 1, 1, "", "find_planar_crs"], [0, 1, 1, "", "get_4326_to_dem_Transformer"], [0, 1, 1, "", "get_lon_origin"], [0, 1, 1, "", "points_on_glacier"], [0, 1, 1, "", "simplify_4326_shp"], [0, 1, 1, "", "subdivide_region"]], "cryoswath.l1b": [[1, 2, 1, "", "L1bData"], [1, 1, 1, "", "append_exclude_mask"], [1, 1, 1, "", "append_poca_and_swath_idxs"], [1, 1, 1, "", "build_flag_mask"], [1, 1, 1, "", "download_files"], [1, 1, 1, "", "download_single_file"], [1, 1, 1, "", "download_wrapper"], [1, 1, 1, "", "drop_waveform"]], "cryoswath.l1b.L1bData": [[1, 3, 1, "", "append_ambiguous_reference_elevation"], [1, 3, 1, "", "append_best_fit_phase_index"], [1, 3, 1, "", "append_elev_diff_to_ref"], [1, 3, 1, "", "append_smoothed_complex_phase"], [1, 3, 1, "", "from_id"], [1, 3, 1, "", "get_rgi_o2"], [1, 3, 1, "", "locate_ambiguous_origin"], [1, 3, 1, "", "phase_jump"], [1, 3, 1, "", "phase_outlier"], [1, 3, 1, "", "ref_range"], [1, 3, 1, "", "tag_groups"], [1, 3, 1, "", "to_l2"], [1, 3, 1, "", "unwrap_phase_diff"]], "cryoswath.l2": [[2, 1, 1, "", "from_id"], [2, 1, 1, "", "from_processed_l1b"], [2, 1, 1, "", "limit_filter"], [2, 1, 1, "", "process_and_save"]], "cryoswath.l3": [[3, 1, 1, "", "append_basin_group"], [3, 1, 1, "", "append_basin_id"], [3, 1, 1, "", "append_elevation_reference"], [3, 1, 1, "", "build_dataset"], [3, 1, 1, "", "build_path"], [3, 1, 1, "", "fill_missing_coords"], [3, 1, 1, "", "fill_voids"], [3, 1, 1, "", "interpolate_hypsometrically_poly3"], [3, 1, 1, "", "med_iqr_cnt"]], "cryoswath.l4": [[4, 1, 1, "", "difference_to_reference_dem"], [4, 1, 1, "", "differential_change"], [4, 1, 1, "", "fit_trend"], [4, 1, 1, "", "relative_change"]], "cryoswath.misc": [[5, 2, 1, "", "binary_chache"], [5, 1, 1, "", "convert_all_esri_to_feather"], [5, 1, 1, "", "cs_id_to_time"], [5, 1, 1, "", "cs_time_to_id"], [5, 1, 1, "", "extend_filename"], [5, 1, 1, "", "filter_kwargs"], [5, 1, 1, "", "find_region_id"], [5, 1, 1, "", "flag_outliers"], [5, 1, 1, "", "flag_translator"], [5, 1, 1, "", "gauss_filter_DataArray"], [5, 1, 1, "", "get_dem_reader"], [5, 1, 1, "", "interpolate_hypsometrically"], [5, 1, 1, "", "load_basins"], [5, 1, 1, "", "load_cs_full_file_names"], [5, 1, 1, "", "load_cs_ground_tracks"], [5, 1, 1, "", "load_glacier_outlines"], [5, 1, 1, "", "load_o1region"], [5, 1, 1, "", "load_o2region"], [5, 1, 1, "", "merge_l2_cache"], [5, 1, 1, "", "nan_unique"], [5, 1, 1, "", "repair_l2_cache"], [5, 1, 1, "", "request_workers"], [5, 1, 1, "", "rgi_code_translator"], [5, 1, 1, "", "rgi_o1region_translator"], [5, 1, 1, "", "rgi_o2region_translator"], [5, 1, 1, "", "weighted_mean_excl_outliers"], [5, 1, 1, "", "xycut"]], "cryoswath.misc.binary_chache": [[5, 3, 1, "", "add"], [5, 4, 1, "", "cache"]], "cryoswath.test_plots": [[6, 0, 0, "-", "waveform"]], "cryoswath.test_plots.waveform": [[6, 1, 1, "", "dem_transect"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:property"}, "terms": {"": [1, 5, 7, 9, 10], "0": [1, 3, 5, 6, 9], "01": 5, "01_alaska": 5, "05": 5, "1": [0, 1, 3, 5, 6], "10": 1, "100": 5, "10000": 2, "11": 5, "12": 4, "15": 5, "150": 3, "1d": 5, "2": [1, 5], "20": 5, "2010": [1, 4, 5], "2024": 9, "2030": 5, "2035": 1, "3": [3, 5, 9], "30000": 1, "30_000": [1, 5], "3489795003921636": 5, "4": 5, "4326": 5, "459": 9, "5": [3, 5, 6], "500": 3, "6": [1, 5, 6], "60000": 5, "7": [1, 5], "8": [1, 2, 5], "9": [4, 9], "90000000": 3, "As": 5, "By": 1, "For": [1, 5, 9], "If": [1, 5, 7, 9, 10], "In": 10, "It": [1, 5], "Not": 5, "One": 5, "The": [1, 5, 9], "Then": 9, "There": [9, 11], "To": [5, 8, 9], "_count": 3, "_description_": 5, "_iqr": 3, "_lib": 3, "_median": 3, "_nestedsequ": 5, "_supportsarrai": 5, "abort": 1, "about": 7, "abov": [5, 9], "accept": 5, "activ": 9, "add": [1, 5, 9], "addit": 1, "advantag": 9, "affect": 1, "after": [1, 5], "again": 7, "against": 10, "agc_error": 1, "agg_func_and_meta": 3, "aggreg": 5, "aggregation_period": 3, "all": [1, 5], "allow": [1, 5], "along": [1, 5], "alreadi": 7, "also": [1, 5], "altimetry_project": 9, "an": [1, 5, 9], "analog": 5, "analyz": 7, "angl": 1, "ani": [1, 5, 6, 9], "anyth": 5, "appart": 5, "append": 5, "append_ambiguous_reference_elev": 1, "append_basin_group": 3, "append_basin_id": 3, "append_best_fit_phase_index": 1, "append_elev_diff_to_ref": 1, "append_elevation_refer": 3, "append_exclude_mask": 1, "append_poca_and_swath_idx": 1, "append_smoothed_complex_phas": 1, "appli": 5, "applic": 7, "approach": 11, "appropri": 5, "ar": [1, 5, 7, 9, 10, 11], "arcgi": 5, "arcticdem": [5, 9], "arg": [1, 5], "argument": 5, "around": [1, 9], "arrai": 5, "arraylik": 5, "assign": [1, 5], "associ": 8, "assumpt": 5, "attempt": 5, "attribut": [1, 5], "automat": 5, "auxiliari": [5, 9], "avail": 5, "averag": 5, "awar": 5, "ax": 6, "backup": 5, "backward": 5, "band": 5, "base": [0, 1, 5, 9], "baselin": 1, "basin": [0, 3, 5, 9], "basin_gdf": [0, 3], "basin_group": 3, "basin_shap": [3, 4], "befor": 5, "begin": 1, "behavior": 5, "being": 1, "believ": 5, "below": [1, 9], "benefici": 9, "between": 5, "bin": 5, "binari": 5, "binary_chach": 5, "black": [5, 6], "blacklist": 5, "blank_block": 1, "block_degrad": 1, "blue": 6, "bool": [0, 1, 2, 3, 4, 5, 6], "boolean": 5, "both": [1, 2, 5, 9], "bound": 5, "box": 5, "broader": 10, "buffer": [1, 5], "buffer_4326_shp": 0, "buffer_period_bi": 5, "buffer_region_bi": [1, 2, 5], "build": 10, "build_dataset": [3, 5], "build_flag_mask": 1, "build_path": 3, "bung": 9, "byte": 5, "c": 9, "cach": 5, "cache_filenam": 3, "cache_filename_extra": 3, "cache_fullnam": 2, "calcul": [1, 5], "callabl": [3, 5], "campaign": 10, "can": [1, 5, 7, 10, 11], "cannot": 1, "case": 10, "center": [1, 9], "central": [0, 1], "certain": 5, "chang": [1, 5, 9], "check": 5, "checklist": 1, "choic": 1, "choos": 5, "chosen": 1, "chunk": 5, "class": [1, 5], "classmethod": 1, "clone": 9, "closest": 11, "code": [5, 9], "coher": 1, "coherence_threshold": 1, "collect": 5, "color": 6, "column": [2, 5], "com": [8, 9], "compar": [5, 10], "compat": 5, "complex": [5, 9], "compon": 10, "conda": 9, "conda_requir": 9, "connect": [5, 9], "consid": 5, "contain": [1, 5, 9, 11], "context": 5, "continu": 5, "conveni": 5, "convert": [1, 5], "convert_all_esri_to_feath": 5, "convolv": 5, "coord": 0, "coordin": 1, "copi": 5, "core": [2, 10], "corrupt": 5, "cr": [0, 3, 5], "creat": [5, 9], "creation": 1, "cristal": 1, "crosssect": 10, "cryosat": [1, 5], "cryoswath": [7, 9, 10], "cs_id": 5, "cs_id_to_tim": 5, "cs_l1b_d": 1, "cs_l1b_flag": [1, 5], "cs_time_to_id": 5, "current": [5, 9], "custom": [1, 5], "custom_xarrai": 9, "d": [1, 3, 5], "da": 5, "data": [1, 2, 3, 4, 5, 7, 11], "dataarrai": [1, 3, 5], "databas": 5, "datafram": [2, 5], "dataset": [1, 3, 4, 5], "datasetread": [0, 5], "datation_degrad": 1, "dateoffset": 4, "datetimeindex": [1, 2], "decid": 1, "default": [0, 1, 5], "defin": 1, "degre": 0, "dem": [5, 6, 9], "dem_path": 9, "dem_read": 0, "dem_transect": 6, "depend": 5, "deposit": 9, "deriv": 5, "design": 1, "desir": 5, "destin": 5, "destination_file_nam": 5, "detach": 9, "detect": 5, "determin": 5, "deviat": 5, "deviation_factor": 5, "devid": 0, "df": [3, 5], "dict": [1, 3, 5, 6], "dictionari": 1, "differ": [1, 9], "difference_to_reference_dem": 4, "differential_chang": 4, "dim": [1, 5], "dimens": 5, "dir": 9, "dir_path": 5, "directori": [5, 9, 10], "disabl": 5, "discrib": 8, "disk": 5, "disregard": 5, "distanc": [1, 5], "do": [5, 10], "docker": 9, "doe": [1, 5], "domain": 10, "don": 1, "done": [1, 7], "download": [1, 5, 9], "download_fil": 1, "download_single_fil": 1, "download_wrapp": 1, "drop": [1, 5], "drop_outsid": 1, "drop_waveform": 1, "drop_waveforms_by_flag": 1, "dtype": 5, "duplic": 5, "e": [1, 5, 9], "each": 5, "easiest": 9, "echo": 1, "echo_rx1_error": 1, "echo_rx2_error": 1, "echo_satur": 1, "edg": 10, "edu": 9, "effect": 5, "either": [1, 5, 9], "elev": [1, 3, 5, 9, 10, 11], "els": 5, "enabl": 5, "encourag": 10, "end": 5, "end_datetim": [1, 2, 3, 5], "ensure_pyproj_cr": 0, "env_nam": 9, "environ": [8, 9], "epsg": 5, "erfinv": 5, "error": [1, 3, 5], "esa": [1, 5, 9], "esri": 5, "esri_to_feath": 0, "estim": [1, 5, 10], "evalu": 10, "event": 1, "evolut": 7, "except": 5, "exclud": [1, 5, 6], "exclude_endswith": 5, "exec": 9, "exist": 5, "exit": 1, "expect": 5, "extend": [5, 11], "extend_filenam": 5, "extens": 5, "extent": 5, "extra": 5, "f8": 3, "facecolor": 6, "factor": [5, 9], "fals": [3, 4, 5], "far": 5, "favorit": 9, "feather": 5, "file": [1, 5, 9], "file_nam": 5, "file_path": 0, "filenotfounderror": 5, "filepath": 5, "fill": 5, "fill_missing_coord": 3, "fill_void": 3, "filter": 5, "filter_kwarg": 5, "find": [1, 5, 7, 8, 9, 10, 11], "find_planar_cr": 0, "find_region_id": 5, "fire": 9, "first": [5, 10], "fit": 5, "fit_trend": 4, "flag": [1, 5], "flag_mask": [1, 5], "flag_mcd_20_ku": 1, "flag_outli": 5, "flag_transl": 5, "flag_val_list": 1, "flag_valu": [1, 5], "float": [0, 1, 2, 3, 5], "float64": 5, "follow": [7, 8, 9], "footprint": 5, "forc": 5, "form": 1, "format": 5, "foundat": 7, "frequent": 5, "from": [1, 5, 9, 11], "from_id": [1, 2], "from_processed_l1b": 2, "frozen": 9, "ftp": 5, "fulfil": 1, "full": 5, "full_nam": 5, "func": 5, "function": [1, 3, 5], "further": [5, 9], "g": [5, 9], "gap": 5, "gauss": 5, "gauss_filter_dataarrai": 5, "gdf_kwarg": 2, "geo": 5, "geodatafram": [0, 1, 2, 3, 4, 5], "geometri": [0, 3, 5], "geopanda": 5, "geoseri": 0, "geospati": 9, "geospatial_d": 3, "get": 8, "get_4326_to_dem_transform": 0, "get_dem_read": [5, 9], "get_lon_origin": 0, "get_rgi_o2": 1, "gi": 8, "git": 9, "github": [8, 9], "give": [7, 9], "given": 5, "glac_ref_year": 4, "glacier": [1, 5, 7, 9, 10, 11], "glob": 5, "go": 9, "gpd": [0, 1, 5], "grace": 1, "green": 6, "greenland": 5, "grid": 11, "group": 1, "guid": [8, 11], "haacker": [8, 9], "hand": 7, "handi": 5, "handl": 1, "hash": 9, "have": [1, 5, 9, 11], "haven": 7, "hdf": 5, "height": 1, "help": [5, 7], "helper": 5, "here": 5, "higher": 7, "hint": 9, "hour": 5, "how": [7, 11], "howev": [5, 9], "http": [8, 9], "hypsometr": 5, "i": [1, 5, 7, 9, 10, 11], "i8": 3, "ic": 6, "id": [5, 9], "identifi": [1, 5], "implement": [5, 10], "includ": [1, 5, 9], "incontrast": 5, "increas": 5, "index": [0, 5], "indic": 1, "infer": 5, "inform": 7, "init": 1, "input": [1, 5], "insert": 5, "insid": 5, "instead": 5, "int": [1, 2, 3, 4, 5], "interact": 9, "interest": 5, "intern": 5, "interpol": 5, "interpolate_hypsometr": 5, "interpolate_hypsometrically_poly3": 3, "interpret": [1, 5], "invalid": 5, "inventori": 9, "io": 5, "ipynb": [7, 10, 11], "issu": 9, "its": [5, 7], "j": [8, 9], "jupyt": 11, "kei": 5, "keyword": 5, "kind": 7, "km": 5, "knowledg": 7, "known": [1, 5], "kw": 5, "kwarg": [1, 2, 5], "l1b": [5, 8, 9, 11], "l1b_d": 1, "l1b_data": [1, 2], "l1b_filenam": 1, "l1b_swath_start": 10, "l1b_waveform": 10, "l1bdata": [1, 2], "l2": [1, 5, 8], "l2_dem_comparison": 10, "l2_from_id_kwarg": 3, "l2_tested_data_comparison": 10, "l2_type": 3, "l3": [5, 8], "l3_data": [3, 4], "l4": 8, "larg": 9, "larger": [5, 7], "last": 5, "lat": [0, 1, 5], "lat_bin_width_degre": 0, "latest": 5, "latitud": 0, "least": 5, "less": 5, "level": 7, "like": [5, 7, 9], "limit": 2, "limit_filt": 2, "line": 9, "line_properti": 6, "linestyl": 6, "linewidth": 6, "list": [0, 1, 5, 9], "load": 5, "load_basin": 5, "load_cs_full_file_nam": 5, "load_cs_ground_track": 5, "load_glacier_outlin": 5, "load_o1region": 5, "load_o2region": 5, "local": 5, "locat": [5, 11], "locate_ambiguous_origin": 1, "logic": 5, "lon": [0, 1, 5], "lon_bin_width_degre": 0, "long": 5, "long_cod": [1, 5], "longer": 9, "longitud": 0, "look": [1, 7], "low": 5, "lower": 1, "lstsq": 5, "lta": 5, "m": 5, "mad": 5, "mai": [5, 7, 9], "main_var": [3, 5], "mainli": 5, "make": [5, 9], "mani": [5, 10], "manual": 9, "mark": [1, 5], "marker": 6, "markers": 6, "mask": [1, 5], "mask_coherence_gt1": 1, "match": [1, 5], "max_elev_diff": [2, 3], "maxi": 3, "maxx": 3, "mayb": 9, "mean": [5, 11], "meant": 5, "med_iqr_cnt": 3, "median": 5, "merge_l2_cach": 5, "meta": 5, "meter": [1, 5], "might": 7, "mind": 5, "mini": 3, "minnesota": 9, "minut": 5, "minx": 3, "misc": [8, 9], "miss": [5, 9], "model": [9, 10], "modifi": 10, "modul": 8, "more": [1, 5], "most": 5, "mother": 10, "much": [5, 7], "multipl": 1, "multipolygon": [0, 5], "multitud": 5, "my": 9, "n": 5, "n_thread": [1, 5], "n_worker": 5, "nadir": 1, "name": [1, 5, 9, 11], "nan": 5, "nan_uniqu": 5, "ndarrai": 5, "need": [1, 7, 8, 9], "netcdf": 5, "new": [5, 7], "new_part": 5, "nightli": 9, "none": [0, 1, 2, 3, 4, 5, 6], "normal": 5, "note": [5, 9], "notebook": [10, 11], "notimplementederror": 5, "np": 5, "npm_error": 1, "number": [1, 5, 11], "numpi": 5, "o": 6, "o1": 5, "o1cod": 5, "o2": [1, 5], "o2cod": 5, "object": 5, "offl": 5, "one": [1, 5], "onli": [1, 5, 10], "oper": 9, "option": [0, 1, 5], "orbit_prop_error": 1, "order": 5, "organ": 5, "origin": [1, 5], "other": [5, 9], "other_echo_error": 1, "out_typ": 5, "out_var": 1, "outlier": 5, "outlier_iter": 3, "outlier_limit": 3, "outlier_replac": [3, 5], "outlin": 5, "outsid": 1, "overlai": 10, "own": 9, "packag": [8, 9], "panda": [3, 5], "parallel": 5, "paramet": [0, 1, 5], "part": [0, 5, 7], "pass": 5, "patch": 9, "path": [5, 9], "pattern": 5, "pd": [1, 5], "per": [1, 3, 5], "period": 5, "pgc": 9, "phase": 1, "phase_jump": 1, "phase_outli": 1, "pictur": 7, "pink": 6, "pip": 9, "pivot": 4, "pivot_month": 4, "planar": 5, "poca": [1, 6, 11], "point": [0, 1, 5, 11], "points_on_glaci": 0, "polar": 9, "polygon": [1, 2, 3, 5], "polynomi": 5, "posit": 5, "possibl": 1, "power": 1, "power_scale_error": 1, "power_threshold": 1, "prerequisit": [7, 8], "present": 5, "process": 1, "process_and_sav": 2, "product": [1, 5, 9], "project": 5, "properti": [1, 5], "provid": [1, 5, 9], "proxim": 5, "py": 9, "pyproj": 3, "queri": 5, "queue": 5, "quick": 5, "quickstart": 8, "radiu": 0, "rais": [1, 5], "randolph": 9, "rang": [0, 1, 5], "rasterio": 5, "rather": 5, "raw": 11, "read": [1, 5, 7, 9], "reader": 5, "reason": 5, "reciproc": 5, "recogn": 5, "recurs": 5, "reduc": 5, "ref_elev": [3, 5], "ref_elev_nam": 3, "ref_rang": 1, "refer": [1, 5, 9, 10], "referenc": 5, "refin": 5, "refus": 5, "region": [0, 1, 5], "region_id": 0, "region_of_interest": [1, 2, 3, 5], "regular": 5, "relative_chang": 4, "relativedelta": 5, "reli": 1, "rema": [5, 9], "remain": 5, "remov": 5, "repair": 5, "repair_l2_cach": 5, "replac": [1, 5], "report": 10, "repositori": [8, 9], "reprocess": [2, 3], "reproject": 5, "request": [0, 1, 5], "request_work": 5, "requir": [1, 5, 9], "reson": 10, "resourc": 9, "restrict": 9, "result": [5, 10], "result_queu": 5, "retain_var": 1, "retriev": [1, 5, 11], "return": [0, 1, 5], "return_mask": 5, "return_raw": 4, "rgi": [1, 5, 9], "rgi_code_transl": 5, "rgi_id": 5, "rgi_o1region_transl": 5, "rgi_o2region_transl": 5, "rgi_path": 9, "rgiv7": 1, "root": 5, "routin": 5, "run": [9, 10], "safe": 5, "safeti": 5, "same": 5, "sampl": [1, 5], "sarin": 1, "sarin_rx1_error": 1, "sarin_rx2_error": 1, "satisfi": 10, "save_or_return": 2, "save_to_disk": 4, "scale": [5, 9], "scaling_factor": 5, "scipi": 5, "scope": 5, "script": [7, 11], "se": 5, "second": 5, "see": [5, 8], "select": 1, "selected_phase_onli": 6, "self": 1, "sens": 5, "separ": 1, "seri": 5, "set": [5, 8], "setup": 9, "sh": 9, "shape": [1, 3, 5, 9], "shoud": 10, "should": 5, "show": [10, 11], "shp": [0, 5], "side": 5, "signatur": 5, "similar": [1, 5, 7], "simpli": 9, "simplifi": 0, "simplify_4326_shp": 0, "singl": [5, 7], "size": 5, "slice": 1, "slightli": 9, "small": [9, 11], "smaller": 0, "smallest": 7, "snr": 1, "so": 7, "solid": 6, "some": [5, 9], "sort": 5, "sourc": [0, 1, 2, 3, 4, 5, 6, 9], "source_glob": 5, "span": 5, "spatial_res_met": 3, "special": [5, 11], "specif": 5, "specifi": 5, "squar": 5, "stage": 5, "standard": 5, "start": [1, 5, 8, 10, 11], "start_datetim": [1, 2, 3, 5], "stat": 5, "statist": 5, "std": 5, "step": [5, 7, 8, 9, 10, 11], "stop_ev": 1, "str": [0, 1, 2, 3, 4, 5, 6], "string": 5, "structur": [5, 9], "sub": 0, "subdivid": 0, "subdivide_region": 0, "subregion": 5, "subset": 1, "success": 1, "suffici": 5, "support": [9, 11], "sure": [5, 9], "surfac": [10, 11], "sw": 5, "swath": [1, 3, 6, 10], "swath_or_poca": 1, "system": 5, "t": [1, 5, 7], "tab": 6, "tabl": 1, "tag": [1, 5], "tag_group": 1, "take": [1, 5, 9], "target": 5, "task": 5, "task_func": 5, "tell": 7, "term": [5, 9], "termin": 1, "test": [5, 8], "test_plot": 8, "than": 5, "thei": [1, 5], "them": [5, 9], "thi": [1, 5, 7, 9, 10], "third": 5, "thoroughli": 10, "those": [1, 5, 9, 11], "thread": 1, "threshold": 1, "tick": 1, "time": [1, 5], "time_20_ku_mask": 1, "timestamp": [1, 2, 3, 5], "timestep_month": [3, 4], "tmp": 5, "tmp_path": 5, "to_l2": 1, "tol": 1, "toler": 0, "too": 5, "total": 5, "track": [1, 5, 7], "track_id": 1, "track_idx": [1, 2], "transform": 0, "translat": 5, "trend": 11, "trk_echo_error": 1, "true": [0, 1, 2, 4, 5, 6], "tslib": 3, "tupl": [1, 2, 3], "tutori": [7, 8], "tutorial__poca": 11, "tutorial__process_first_swath": 7, "tutorial__process_first_track": [], "tutorial__process_first_waveform": 7, "two": [1, 9], "txt": 9, "type": [0, 1, 5, 9], "typic": 5, "umn": 9, "understand": 7, "understood": 5, "undesir": 5, "uneven": 5, "unfortun": 9, "union": 5, "uniqu": 5, "unit": 5, "univers": 9, "unix": 5, "unwrap": 1, "unwrap_phase_diff": 1, "up": [8, 9], "updat": [1, 5], "us": [1, 5, 7, 9], "usual": 5, "v7": [1, 5], "valid": 10, "valu": [1, 5, 9], "valueerror": [1, 5], "variabl": [1, 5, 9], "varianc": 5, "variou": 5, "vector": 5, "veri": 5, "verifi": 10, "versatil": 5, "version": [1, 9], "via": 5, "view": 7, "visual": 7, "void": 5, "volum": 9, "w": 5, "wa": [5, 10], "wafeform": 1, "want": 9, "waveform": [1, 5, 10], "waveform_select": 1, "weight": 5, "weighted_mean_excl_outli": 5, "were": 5, "what": 1, "when": [1, 9], "where": [1, 5], "whether": 5, "which": [5, 9, 10], "while": [5, 7], "whitelist": 5, "width": 5, "window": [1, 5], "window_delay_error": 1, "window_ext": 5, "window_ntimestep": 3, "within": 5, "without": [1, 5], "wonder": 7, "word": 5, "work": [5, 8, 9], "worker": 5, "would": 9, "wrap": 1, "wrt": 1, "www": 9, "x": [1, 5, 6], "x_chunk_met": 5, "xarrai": [5, 9], "xkcd": 6, "xph_dist": 1, "xph_elev": 1, "xph_lat": 1, "xph_lon": 1, "xph_theta": 1, "xr": [1, 5], "xycut": 5, "y": [1, 5], "y_chunk_met": 5, "you": [5, 7, 9, 10], "your": [5, 9, 10]}, "titles": ["cryoswath.gis module", "cryoswath.l1b module", "cryoswath.l2 module", "cryoswath.l3 module", "cryoswath.l4 module", "cryoswath.misc module", "cryoswath.test_plots package", "Getting started", "Welcome to cryoswath\u2019s documentation!", "Prerequisites", "Tests", "Tutorials"], "titleterms": {"": 8, "content": [6, 8], "cryoswath": [0, 1, 2, 3, 4, 5, 6, 8], "data": 9, "depend": 9, "document": 8, "first": 7, "get": 7, "gi": 0, "instal": 9, "l1b": 1, "l2": 2, "l3": 3, "l4": 4, "map": 6, "misc": 5, "modul": [0, 1, 2, 3, 4, 5, 6], "packag": 6, "prerequisit": 9, "process": 7, "softwar": 9, "start": 7, "submodul": 6, "swath": 7, "test": 10, "test_plot": 6, "timeseri": 6, "track": [], "tutori": 11, "waveform": [6, 7], "welcom": 8}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Contents:": [[8, null]], "Data dependencies": [[9, "data-dependencies"]], "Getting started": [[7, null]], "Installation": [[9, "installation"]], "Module contents": [[6, "module-cryoswath.test_plots"]], "Prerequisites": [[9, null]], "Processing the first swath": [[7, "processing-the-first-swath"]], "Processing the first waveform": [[7, "processing-the-first-waveform"]], "Software dependencies": [[9, "software-dependencies"]], "Submodules": [[6, "submodules"]], "Tests": [[10, null]], "Tutorials": [[11, null]], "Welcome to cryoswath\u2019s documentation!": [[8, null]], "cryoswath.gis module": [[0, null]], "cryoswath.l1b module": [[1, null]], "cryoswath.l2 module": [[2, null]], "cryoswath.l3 module": [[3, null]], "cryoswath.l4 module": [[4, null]], "cryoswath.misc module": [[5, null]], "cryoswath.test_plots package": [[6, null]], "cryoswath.test_plots.maps module": [[6, "cryoswath-test-plots-maps-module"]], "cryoswath.test_plots.timeseries module": [[6, "cryoswath-test-plots-timeseries-module"]], "cryoswath.test_plots.waveform module": [[6, "module-cryoswath.test_plots.waveform"]]}, "docnames": ["cryoswath.gis", "cryoswath.l1b", "cryoswath.l2", "cryoswath.l3", "cryoswath.l4", "cryoswath.misc", "cryoswath.test_plots", "getting_started", "index", "prerequisites", "tests", "tutorials"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["cryoswath.gis.rst", "cryoswath.l1b.rst", "cryoswath.l2.rst", "cryoswath.l3.rst", "cryoswath.l4.rst", "cryoswath.misc.rst", "cryoswath.test_plots.rst", "getting_started.rst", "index.rst", "prerequisites.rst", "tests.rst", "tutorials.rst"], "indexentries": {"add() (cryoswath.misc.binary_chache method)": [[5, "cryoswath.misc.binary_chache.add", false]], "append_ambiguous_reference_elevation() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.append_ambiguous_reference_elevation", false]], "append_basin_group() (in module cryoswath.l3)": [[3, "cryoswath.l3.append_basin_group", false]], "append_basin_id() (in module cryoswath.l3)": [[3, "cryoswath.l3.append_basin_id", false]], "append_best_fit_phase_index() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.append_best_fit_phase_index", false]], "append_elev_diff_to_ref() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.append_elev_diff_to_ref", false]], "append_elevation_reference() (in module cryoswath.l3)": [[3, "cryoswath.l3.append_elevation_reference", false]], "append_exclude_mask() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.append_exclude_mask", false]], "append_poca_and_swath_idxs() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.append_poca_and_swath_idxs", false]], "append_smoothed_complex_phase() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.append_smoothed_complex_phase", false]], "binary_chache (class in cryoswath.misc)": [[5, "cryoswath.misc.binary_chache", false]], "buffer_4326_shp() (in module cryoswath.gis)": [[0, "cryoswath.gis.buffer_4326_shp", false]], "build_dataset() (in module cryoswath.l3)": [[3, "cryoswath.l3.build_dataset", false]], "build_flag_mask() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.build_flag_mask", false]], "build_path() (in module cryoswath.l3)": [[3, "cryoswath.l3.build_path", false]], "cache (cryoswath.misc.binary_chache property)": [[5, "cryoswath.misc.binary_chache.cache", false]], "convert_all_esri_to_feather() (in module cryoswath.misc)": [[5, "cryoswath.misc.convert_all_esri_to_feather", false]], "cryoswath.gis": [[0, "module-cryoswath.gis", false]], "cryoswath.l1b": [[1, "module-cryoswath.l1b", false]], "cryoswath.l2": [[2, "module-cryoswath.l2", false]], "cryoswath.l3": [[3, "module-cryoswath.l3", false]], "cryoswath.l4": [[4, "module-cryoswath.l4", false]], "cryoswath.misc": [[5, "module-cryoswath.misc", false]], "cryoswath.test_plots": [[6, "module-cryoswath.test_plots", false]], "cryoswath.test_plots.waveform": [[6, "module-cryoswath.test_plots.waveform", false]], "cs_id_to_time() (in module cryoswath.misc)": [[5, "cryoswath.misc.cs_id_to_time", false]], "cs_time_to_id() (in module cryoswath.misc)": [[5, "cryoswath.misc.cs_time_to_id", false]], "dem_transect() (in module cryoswath.test_plots.waveform)": [[6, "cryoswath.test_plots.waveform.dem_transect", false]], "difference_to_reference_dem() (in module cryoswath.l4)": [[4, "cryoswath.l4.difference_to_reference_dem", false]], "differential_change() (in module cryoswath.l4)": [[4, "cryoswath.l4.differential_change", false]], "download_files() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.download_files", false]], "download_single_file() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.download_single_file", false]], "download_wrapper() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.download_wrapper", false]], "drop_waveform() (in module cryoswath.l1b)": [[1, "cryoswath.l1b.drop_waveform", false]], "ensure_pyproj_crs() (in module cryoswath.gis)": [[0, "cryoswath.gis.ensure_pyproj_crs", false]], "esri_to_feather() (in module cryoswath.gis)": [[0, "cryoswath.gis.esri_to_feather", false]], "extend_filename() (in module cryoswath.misc)": [[5, "cryoswath.misc.extend_filename", false]], "fill_missing_coords() (in module cryoswath.l3)": [[3, "cryoswath.l3.fill_missing_coords", false]], "fill_voids() (in module cryoswath.l3)": [[3, "cryoswath.l3.fill_voids", false]], "filter_kwargs() (in module cryoswath.misc)": [[5, "cryoswath.misc.filter_kwargs", false]], "find_planar_crs() (in module cryoswath.gis)": [[0, "cryoswath.gis.find_planar_crs", false]], "find_region_id() (in module cryoswath.misc)": [[5, "cryoswath.misc.find_region_id", false]], "fit_trend() (in module cryoswath.l4)": [[4, "cryoswath.l4.fit_trend", false]], "flag_outliers() (in module cryoswath.misc)": [[5, "cryoswath.misc.flag_outliers", false]], "flag_translator() (in module cryoswath.misc)": [[5, "cryoswath.misc.flag_translator", false]], "from_id() (cryoswath.l1b.l1bdata class method)": [[1, "cryoswath.l1b.L1bData.from_id", false]], "from_id() (in module cryoswath.l2)": [[2, "cryoswath.l2.from_id", false]], "from_processed_l1b() (in module cryoswath.l2)": [[2, "cryoswath.l2.from_processed_l1b", false]], "gauss_filter_dataarray() (in module cryoswath.misc)": [[5, "cryoswath.misc.gauss_filter_DataArray", false]], "get_4326_to_dem_transformer() (in module cryoswath.gis)": [[0, "cryoswath.gis.get_4326_to_dem_Transformer", false]], "get_dem_reader() (in module cryoswath.misc)": [[5, "cryoswath.misc.get_dem_reader", false]], "get_lon_origin() (in module cryoswath.gis)": [[0, "cryoswath.gis.get_lon_origin", false]], "get_rgi_o2() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.get_rgi_o2", false]], "interpolate_hypsometrically() (in module cryoswath.misc)": [[5, "cryoswath.misc.interpolate_hypsometrically", false]], "interpolate_hypsometrically_poly3() (in module cryoswath.l3)": [[3, "cryoswath.l3.interpolate_hypsometrically_poly3", false]], "l1bdata (class in cryoswath.l1b)": [[1, "cryoswath.l1b.L1bData", false]], "limit_filter() (in module cryoswath.l2)": [[2, "cryoswath.l2.limit_filter", false]], "load_basins() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_basins", false]], "load_cs_full_file_names() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_cs_full_file_names", false]], "load_cs_ground_tracks() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_cs_ground_tracks", false]], "load_glacier_outlines() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_glacier_outlines", false]], "load_o1region() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_o1region", false]], "load_o2region() (in module cryoswath.misc)": [[5, "cryoswath.misc.load_o2region", false]], "locate_ambiguous_origin() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.locate_ambiguous_origin", false]], "med_iqr_cnt() (in module cryoswath.l3)": [[3, "cryoswath.l3.med_iqr_cnt", false]], "merge_l2_cache() (in module cryoswath.misc)": [[5, "cryoswath.misc.merge_l2_cache", false]], "module": [[0, "module-cryoswath.gis", false], [1, "module-cryoswath.l1b", false], [2, "module-cryoswath.l2", false], [3, "module-cryoswath.l3", false], [4, "module-cryoswath.l4", false], [5, "module-cryoswath.misc", false], [6, "module-cryoswath.test_plots", false], [6, "module-cryoswath.test_plots.waveform", false]], "nan_unique() (in module cryoswath.misc)": [[5, "cryoswath.misc.nan_unique", false]], "phase_jump() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.phase_jump", false]], "phase_outlier() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.phase_outlier", false]], "points_on_glacier() (in module cryoswath.gis)": [[0, "cryoswath.gis.points_on_glacier", false]], "process_and_save() (in module cryoswath.l2)": [[2, "cryoswath.l2.process_and_save", false]], "ref_range() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.ref_range", false]], "relative_change() (in module cryoswath.l4)": [[4, "cryoswath.l4.relative_change", false]], "repair_l2_cache() (in module cryoswath.misc)": [[5, "cryoswath.misc.repair_l2_cache", false]], "request_workers() (in module cryoswath.misc)": [[5, "cryoswath.misc.request_workers", false]], "rgi_code_translator() (in module cryoswath.misc)": [[5, "cryoswath.misc.rgi_code_translator", false]], "rgi_o1region_translator() (in module cryoswath.misc)": [[5, "cryoswath.misc.rgi_o1region_translator", false]], "rgi_o2region_translator() (in module cryoswath.misc)": [[5, "cryoswath.misc.rgi_o2region_translator", false]], "simplify_4326_shp() (in module cryoswath.gis)": [[0, "cryoswath.gis.simplify_4326_shp", false]], "subdivide_region() (in module cryoswath.gis)": [[0, "cryoswath.gis.subdivide_region", false]], "tag_groups() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.tag_groups", false]], "to_l2() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.to_l2", false]], "unwrap_phase_diff() (cryoswath.l1b.l1bdata method)": [[1, "cryoswath.l1b.L1bData.unwrap_phase_diff", false]], "weighted_mean_excl_outliers() (in module cryoswath.misc)": [[5, "cryoswath.misc.weighted_mean_excl_outliers", false]], "xycut() (in module cryoswath.misc)": [[5, "cryoswath.misc.xycut", false]]}, "objects": {"cryoswath": [[0, 0, 0, "-", "gis"], [1, 0, 0, "-", "l1b"], [2, 0, 0, "-", "l2"], [3, 0, 0, "-", "l3"], [4, 0, 0, "-", "l4"], [5, 0, 0, "-", "misc"], [6, 0, 0, "-", "test_plots"]], "cryoswath.gis": [[0, 1, 1, "", "buffer_4326_shp"], [0, 1, 1, "", "ensure_pyproj_crs"], [0, 1, 1, "", "esri_to_feather"], [0, 1, 1, "", "find_planar_crs"], [0, 1, 1, "", "get_4326_to_dem_Transformer"], [0, 1, 1, "", "get_lon_origin"], [0, 1, 1, "", "points_on_glacier"], [0, 1, 1, "", "simplify_4326_shp"], [0, 1, 1, "", "subdivide_region"]], "cryoswath.l1b": [[1, 2, 1, "", "L1bData"], [1, 1, 1, "", "append_exclude_mask"], [1, 1, 1, "", "append_poca_and_swath_idxs"], [1, 1, 1, "", "build_flag_mask"], [1, 1, 1, "", "download_files"], [1, 1, 1, "", "download_single_file"], [1, 1, 1, "", "download_wrapper"], [1, 1, 1, "", "drop_waveform"]], "cryoswath.l1b.L1bData": [[1, 3, 1, "", "append_ambiguous_reference_elevation"], [1, 3, 1, "", "append_best_fit_phase_index"], [1, 3, 1, "", "append_elev_diff_to_ref"], [1, 3, 1, "", "append_smoothed_complex_phase"], [1, 3, 1, "", "from_id"], [1, 3, 1, "", "get_rgi_o2"], [1, 3, 1, "", "locate_ambiguous_origin"], [1, 3, 1, "", "phase_jump"], [1, 3, 1, "", "phase_outlier"], [1, 3, 1, "", "ref_range"], [1, 3, 1, "", "tag_groups"], [1, 3, 1, "", "to_l2"], [1, 3, 1, "", "unwrap_phase_diff"]], "cryoswath.l2": [[2, 1, 1, "", "from_id"], [2, 1, 1, "", "from_processed_l1b"], [2, 1, 1, "", "limit_filter"], [2, 1, 1, "", "process_and_save"]], "cryoswath.l3": [[3, 1, 1, "", "append_basin_group"], [3, 1, 1, "", "append_basin_id"], [3, 1, 1, "", "append_elevation_reference"], [3, 1, 1, "", "build_dataset"], [3, 1, 1, "", "build_path"], [3, 1, 1, "", "fill_missing_coords"], [3, 1, 1, "", "fill_voids"], [3, 1, 1, "", "interpolate_hypsometrically_poly3"], [3, 1, 1, "", "med_iqr_cnt"]], "cryoswath.l4": [[4, 1, 1, "", "difference_to_reference_dem"], [4, 1, 1, "", "differential_change"], [4, 1, 1, "", "fit_trend"], [4, 1, 1, "", "relative_change"]], "cryoswath.misc": [[5, 2, 1, "", "binary_chache"], [5, 1, 1, "", "convert_all_esri_to_feather"], [5, 1, 1, "", "cs_id_to_time"], [5, 1, 1, "", "cs_time_to_id"], [5, 1, 1, "", "extend_filename"], [5, 1, 1, "", "filter_kwargs"], [5, 1, 1, "", "find_region_id"], [5, 1, 1, "", "flag_outliers"], [5, 1, 1, "", "flag_translator"], [5, 1, 1, "", "gauss_filter_DataArray"], [5, 1, 1, "", "get_dem_reader"], [5, 1, 1, "", "interpolate_hypsometrically"], [5, 1, 1, "", "load_basins"], [5, 1, 1, "", "load_cs_full_file_names"], [5, 1, 1, "", "load_cs_ground_tracks"], [5, 1, 1, "", "load_glacier_outlines"], [5, 1, 1, "", "load_o1region"], [5, 1, 1, "", "load_o2region"], [5, 1, 1, "", "merge_l2_cache"], [5, 1, 1, "", "nan_unique"], [5, 1, 1, "", "repair_l2_cache"], [5, 1, 1, "", "request_workers"], [5, 1, 1, "", "rgi_code_translator"], [5, 1, 1, "", "rgi_o1region_translator"], [5, 1, 1, "", "rgi_o2region_translator"], [5, 1, 1, "", "weighted_mean_excl_outliers"], [5, 1, 1, "", "xycut"]], "cryoswath.misc.binary_chache": [[5, 3, 1, "", "add"], [5, 4, 1, "", "cache"]], "cryoswath.test_plots": [[6, 0, 0, "-", "waveform"]], "cryoswath.test_plots.waveform": [[6, 1, 1, "", "dem_transect"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:property"}, "terms": {"": [1, 5, 7, 9, 10], "0": [1, 3, 5, 6, 9], "01": 5, "01_alaska": 5, "05": 5, "1": [0, 1, 3, 5, 6], "10": 1, "100": 5, "10000": 2, "11": 5, "12": 4, "15": 5, "150": 3, "1d": 5, "2": [1, 5], "20": 5, "2010": [1, 4, 5], "2024": 9, "2030": 5, "2035": 1, "3": [3, 5, 9], "30000": 1, "30_000": [1, 5], "3489795003921636": 5, "4": 5, "4326": 5, "459": 9, "5": [3, 5, 6], "500": 3, "6": [1, 5, 6], "60000": 5, "7": [1, 5], "8": [1, 2, 5], "9": [4, 9], "90000000": 3, "As": 5, "By": 1, "For": [1, 5, 9], "If": [1, 5, 7, 9, 10], "In": 10, "It": [1, 5], "Not": 5, "One": 5, "The": [1, 5, 9], "Then": 9, "There": [9, 11], "To": [5, 8, 9], "_count": 3, "_description_": 5, "_iqr": 3, "_lib": 3, "_median": 3, "_nestedsequ": 5, "_supportsarrai": 5, "abort": 1, "about": 7, "abov": [5, 9], "accept": 5, "activ": 9, "add": [1, 5, 9], "addit": 1, "advantag": 9, "affect": 1, "after": [1, 5], "again": 7, "against": 10, "agc_error": 1, "agg_func_and_meta": 3, "aggreg": 5, "aggregation_period": 3, "all": [1, 5], "allow": [1, 5], "along": [1, 5], "alreadi": 7, "also": [1, 5], "altimetry_project": 9, "an": [1, 5, 9], "analog": 5, "analyz": 7, "angl": 1, "ani": [1, 5, 6, 9], "anyth": 5, "appart": 5, "append": 5, "append_ambiguous_reference_elev": 1, "append_basin_group": 3, "append_basin_id": 3, "append_best_fit_phase_index": 1, "append_elev_diff_to_ref": 1, "append_elevation_refer": 3, "append_exclude_mask": 1, "append_poca_and_swath_idx": 1, "append_smoothed_complex_phas": 1, "appli": 5, "applic": 7, "approach": 11, "appropri": 5, "ar": [1, 5, 7, 9, 10, 11], "arcgi": 5, "arcticdem": [5, 9], "arg": [1, 5], "argument": 5, "around": [1, 9], "arrai": 5, "arraylik": 5, "assign": [1, 5], "associ": 8, "assumpt": 5, "attempt": 5, "attribut": [1, 5], "automat": 5, "auxiliari": [5, 9], "avail": 5, "averag": 5, "awar": 5, "ax": 6, "backup": 5, "backward": 5, "band": 5, "base": [0, 1, 5, 9], "baselin": 1, "basin": [0, 3, 5, 9], "basin_gdf": [0, 3], "basin_group": 3, "basin_shap": [3, 4], "befor": 5, "begin": 1, "behavior": 5, "being": 1, "believ": 5, "below": [1, 9], "benefici": 9, "between": 5, "bin": 5, "binari": 5, "binary_chach": 5, "black": [5, 6], "blacklist": 5, "blank_block": 1, "block_degrad": 1, "blue": 6, "bool": [0, 1, 2, 3, 4, 5, 6], "boolean": 5, "both": [1, 2, 5, 9], "bound": 5, "box": 5, "broader": 10, "buffer": [1, 5], "buffer_4326_shp": 0, "buffer_period_bi": 5, "buffer_region_bi": [1, 2, 5], "build": 10, "build_dataset": [3, 5], "build_flag_mask": 1, "build_path": 3, "bung": 9, "byte": 5, "c": 9, "cach": 5, "cache_filenam": 3, "cache_filename_extra": 3, "cache_fullnam": 2, "calcul": [1, 5], "callabl": [3, 5], "campaign": 10, "can": [1, 5, 7, 10, 11], "cannot": 1, "case": 10, "center": [1, 9], "central": [0, 1], "ceratin": 11, "certain": 5, "chang": [1, 5, 9], "check": 5, "checklist": 1, "choic": 1, "choos": 5, "chosen": 1, "chunk": 5, "class": [1, 5], "classmethod": 1, "clone": 9, "closest": 11, "code": [5, 9], "coher": 1, "coherence_threshold": 1, "collect": 5, "color": 6, "column": [2, 5], "com": [8, 9], "compar": [5, 10], "compat": 5, "complex": [5, 9], "compon": 10, "conda": 9, "conda_requir": 9, "connect": [5, 9], "consid": 5, "contain": [1, 5, 9, 11], "context": 5, "continu": 5, "conveni": 5, "convert": [1, 5], "convert_all_esri_to_feath": 5, "convolv": 5, "coord": 0, "coordin": 1, "copi": 5, "core": [2, 10], "corrupt": 5, "cr": [0, 3, 5], "creat": [5, 9], "creation": 1, "cristal": 1, "crosssect": 10, "cryosat": [1, 5], "cryoswath": [7, 9, 10], "cs_id": 5, "cs_id_to_tim": 5, "cs_l1b_d": 1, "cs_l1b_flag": [1, 5], "cs_time_to_id": 5, "current": [5, 9], "custom": [1, 5], "custom_xarrai": 9, "d": [1, 3, 5], "da": 5, "data": [1, 2, 3, 4, 5, 7, 11], "dataarrai": [1, 3, 5], "databas": 5, "datafram": [2, 5], "dataset": [1, 3, 4, 5], "datasetread": [0, 5], "datation_degrad": 1, "dateoffset": 4, "datetimeindex": [1, 2], "decid": 1, "default": [0, 1, 5], "defin": 1, "degre": 0, "dem": [5, 6, 9], "dem_path": 9, "dem_read": 0, "dem_transect": 6, "depend": 5, "deposit": 9, "deriv": 5, "design": 1, "desir": 5, "destin": 5, "destination_file_nam": 5, "detach": 9, "detect": 5, "determin": 5, "deviat": 5, "deviation_factor": 5, "devid": 0, "df": [3, 5], "dict": [1, 3, 5, 6], "dictionari": 1, "differ": [1, 9], "difference_to_reference_dem": 4, "differential_chang": 4, "dim": [1, 5], "dimens": 5, "dir": 9, "dir_path": 5, "directori": [5, 9, 10], "disabl": 5, "discrib": 8, "disk": 5, "disregard": 5, "distanc": [1, 5], "do": [5, 10], "docker": 9, "doe": [1, 5], "domain": 10, "don": 1, "done": [1, 7], "download": [1, 5, 9], "download_fil": 1, "download_single_fil": 1, "download_wrapp": 1, "drop": [1, 5], "drop_outsid": 1, "drop_waveform": 1, "drop_waveforms_by_flag": 1, "dtype": 5, "duplic": 5, "e": [1, 5, 9], "each": 5, "easiest": 9, "echo": 1, "echo_rx1_error": 1, "echo_rx2_error": 1, "echo_satur": 1, "edg": 10, "edu": 9, "effect": 5, "either": [1, 5, 9], "elev": [1, 3, 5, 9, 10, 11], "els": 5, "enabl": 5, "encourag": 10, "end": 5, "end_datetim": [1, 2, 3, 5], "ensure_pyproj_cr": 0, "env_nam": 9, "environ": [8, 9], "epsg": 5, "erfinv": 5, "error": [1, 3, 5], "esa": [1, 5, 9], "esri": 5, "esri_to_feath": 0, "estim": [1, 5, 10, 11], "evalu": 10, "event": 1, "evolut": 7, "except": 5, "exclud": [1, 5, 6], "exclude_endswith": 5, "exec": 9, "exist": 5, "exit": 1, "expect": 5, "explain": 11, "extend": [5, 11], "extend_filenam": 5, "extens": 5, "extent": 5, "extra": 5, "f8": 3, "facecolor": 6, "factor": [5, 9], "fals": [3, 4, 5], "far": 5, "favorit": 9, "feather": 5, "file": [1, 5, 9], "file_nam": 5, "file_path": 0, "filenotfounderror": 5, "filepath": 5, "fill": 5, "fill_missing_coord": 3, "fill_void": 3, "filter": 5, "filter_kwarg": 5, "find": [1, 5, 7, 8, 9, 10, 11], "find_planar_cr": 0, "find_region_id": 5, "fire": 9, "first": [5, 10], "fit": 5, "fit_trend": 4, "flag": [1, 5], "flag_mask": [1, 5], "flag_mcd_20_ku": 1, "flag_outli": 5, "flag_transl": 5, "flag_val_list": 1, "flag_valu": [1, 5], "float": [0, 1, 2, 3, 5], "float64": 5, "follow": [7, 8, 9], "footprint": 5, "forc": 5, "form": 1, "format": 5, "foundat": 7, "frequent": 5, "from": [1, 5, 9, 11], "from_id": [1, 2], "from_processed_l1b": 2, "frozen": 9, "ftp": 5, "fulfil": 1, "full": 5, "full_nam": 5, "func": 5, "function": [1, 3, 5], "further": [5, 9], "g": [5, 9], "gap": 5, "gauss": 5, "gauss_filter_dataarrai": 5, "gdf_kwarg": 2, "geo": 5, "geodatafram": [0, 1, 2, 3, 4, 5], "geometri": [0, 3, 5], "geopanda": 5, "geoseri": 0, "geospati": 9, "geospatial_d": 3, "get": 8, "get_4326_to_dem_transform": 0, "get_dem_read": [5, 9], "get_lon_origin": 0, "get_rgi_o2": 1, "gi": 8, "git": 9, "github": [8, 9], "give": [7, 9], "given": 5, "glac_ref_year": 4, "glacier": [1, 5, 7, 9, 10, 11], "glob": 5, "go": 9, "gpd": [0, 1, 5], "grace": 1, "green": 6, "greenland": 5, "grid": 11, "group": 1, "guid": [8, 11], "haacker": [8, 9], "hand": 7, "handi": 5, "handl": 1, "hash": 9, "have": [1, 5, 9, 11], "haven": 7, "hdf": 5, "height": 1, "help": [5, 7], "helper": 5, "here": 5, "higher": 7, "hint": 9, "hour": 5, "how": [7, 11], "howev": [5, 9], "http": [8, 9], "hypsometr": 5, "i": [1, 5, 7, 9, 10, 11], "i8": 3, "ic": 6, "id": [5, 9], "identifi": [1, 5], "implement": [5, 10], "includ": [1, 5, 9], "incontrast": 5, "increas": 5, "index": [0, 5], "indic": 1, "infer": 5, "inform": 7, "init": 1, "input": [1, 5], "insert": 5, "insid": 5, "instead": 5, "int": [1, 2, 3, 4, 5], "interact": 9, "interest": 5, "intern": 5, "interpol": 5, "interpolate_hypsometr": 5, "interpolate_hypsometrically_poly3": 3, "interpret": [1, 5], "invalid": 5, "inventori": 9, "io": 5, "ipynb": [7, 10, 11], "issu": 9, "its": [5, 7], "j": [8, 9], "jupyt": 11, "kei": 5, "keyword": 5, "kind": 7, "km": 5, "knowledg": 7, "known": [1, 5], "kw": 5, "kwarg": [1, 2, 5], "l1b": [5, 8, 9, 11], "l1b_d": 1, "l1b_data": [1, 2], "l1b_filenam": 1, "l1b_swath_start": 10, "l1b_waveform": 10, "l1bdata": [1, 2], "l2": [1, 5, 8], "l2_dem_comparison": 10, "l2_from_id_kwarg": 3, "l2_tested_data_comparison": 10, "l2_type": 3, "l3": [5, 8], "l3_data": [3, 4], "l4": 8, "larg": 9, "larger": [5, 7], "last": 5, "lat": [0, 1, 5], "lat_bin_width_degre": 0, "latest": 5, "latitud": 0, "least": 5, "less": 5, "level": 7, "like": [5, 7, 9], "limit": 2, "limit_filt": 2, "line": 9, "line_properti": 6, "linestyl": 6, "linewidth": 6, "list": [0, 1, 5, 9], "load": 5, "load_basin": 5, "load_cs_full_file_nam": 5, "load_cs_ground_track": 5, "load_glacier_outlin": 5, "load_o1region": 5, "load_o2region": 5, "local": 5, "locat": [5, 11], "locate_ambiguous_origin": 1, "logic": 5, "lon": [0, 1, 5], "lon_bin_width_degre": 0, "long": 5, "long_cod": [1, 5], "longer": 9, "longitud": 0, "look": [1, 7], "low": 5, "lower": 1, "lstsq": 5, "lta": 5, "m": 5, "mad": 5, "mai": [5, 7, 9], "main_var": [3, 5], "mainli": 5, "make": [5, 9], "mani": [5, 10], "manual": 9, "mark": [1, 5], "marker": 6, "markers": 6, "mask": [1, 5], "mask_coherence_gt1": 1, "match": [1, 5], "max_elev_diff": [2, 3], "maxi": 3, "maxx": 3, "mayb": 9, "mean": [5, 11], "meant": 5, "med_iqr_cnt": 3, "median": 5, "merge_l2_cach": 5, "meta": 5, "meter": [1, 5], "might": 7, "mind": 5, "mini": 3, "minnesota": 9, "minut": 5, "minx": 3, "misc": [8, 9], "miss": [5, 9], "model": [9, 10], "modifi": 10, "modul": 8, "more": [1, 5], "most": 5, "mother": 10, "much": [5, 7], "multipl": 1, "multipolygon": [0, 5], "multitud": 5, "my": 9, "n": 5, "n_thread": [1, 5], "n_worker": 5, "nadir": 1, "name": [1, 5, 9, 11], "nan": 5, "nan_uniqu": 5, "ndarrai": 5, "need": [1, 7, 8, 9], "netcdf": 5, "new": [5, 7], "new_part": 5, "nightli": 9, "none": [0, 1, 2, 3, 4, 5, 6], "normal": 5, "note": [5, 9], "notebook": [10, 11], "notimplementederror": 5, "np": 5, "npm_error": 1, "number": [1, 5, 11], "numpi": 5, "o": 6, "o1": 5, "o1cod": 5, "o2": [1, 5], "o2cod": 5, "object": 5, "offl": 5, "one": [1, 5], "onli": [1, 5, 10], "oper": 9, "option": [0, 1, 5], "orbit_prop_error": 1, "order": 5, "organ": 5, "origin": [1, 5], "other": [5, 9], "other_echo_error": 1, "out_typ": 5, "out_var": 1, "outlier": 5, "outlier_iter": 3, "outlier_limit": 3, "outlier_replac": [3, 5], "outlin": 5, "outsid": 1, "overlai": 10, "own": 9, "packag": [8, 9], "panda": [3, 5], "parallel": 5, "paramet": [0, 1, 5], "part": [0, 5, 7], "pass": 5, "patch": 9, "path": [5, 9], "pattern": 5, "pd": [1, 5], "per": [1, 3, 5], "period": 5, "pgc": 9, "phase": 1, "phase_jump": 1, "phase_outli": 1, "pictur": 7, "pink": 6, "pip": 9, "pivot": 4, "pivot_month": 4, "planar": 5, "poca": [1, 6, 11], "point": [0, 1, 5, 11], "points_on_glaci": 0, "polar": 9, "polygon": [1, 2, 3, 5], "polynomi": 5, "posit": 5, "possibl": 1, "power": 1, "power_scale_error": 1, "power_threshold": 1, "prerequisit": [7, 8], "present": 5, "process": 1, "process_and_sav": 2, "product": [1, 5, 9], "project": 5, "properti": [1, 5], "provid": [1, 5, 9], "proxim": 5, "py": 9, "pyproj": 3, "queri": 5, "queue": 5, "quick": 5, "quickstart": 8, "radiu": 0, "rais": [1, 5], "randolph": 9, "rang": [0, 1, 5], "rasterio": 5, "rather": 5, "raw": 11, "read": [1, 5, 7, 9], "reader": 5, "reason": 5, "reciproc": 5, "recogn": 5, "recurs": 5, "reduc": 5, "ref_elev": [3, 5], "ref_elev_nam": 3, "ref_rang": 1, "refer": [1, 5, 9, 10], "referenc": 5, "refin": 5, "refus": 5, "region": [0, 1, 5], "region_id": 0, "region_of_interest": [1, 2, 3, 5], "regular": 5, "relative_chang": 4, "relativedelta": 5, "reli": 1, "rema": [5, 9], "remain": 5, "remov": 5, "repair": 5, "repair_l2_cach": 5, "replac": [1, 5], "report": 10, "repositori": [8, 9], "reprocess": [2, 3], "reproject": 5, "request": [0, 1, 5], "request_work": 5, "requir": [1, 5, 9], "reson": 10, "resourc": 9, "restrict": 9, "result": [5, 10], "result_queu": 5, "retain_var": 1, "retriev": [1, 5, 11], "return": [0, 1, 5], "return_mask": 5, "return_raw": 4, "rgi": [1, 5, 9], "rgi_code_transl": 5, "rgi_id": 5, "rgi_o1region_transl": 5, "rgi_o2region_transl": 5, "rgi_path": 9, "rgiv7": 1, "root": 5, "routin": 5, "run": [9, 10], "safe": 5, "safeti": 5, "same": 5, "sampl": [1, 5], "sarin": 1, "sarin_rx1_error": 1, "sarin_rx2_error": 1, "satellit": 11, "satisfi": 10, "save_or_return": 2, "save_to_disk": 4, "scale": [5, 9], "scaling_factor": 5, "scipi": 5, "scope": 5, "script": [7, 11], "se": 5, "second": 5, "see": [5, 8], "select": 1, "selected_phase_onli": 6, "self": 1, "sens": 5, "separ": 1, "seri": 5, "set": [5, 8], "setup": 9, "sh": 9, "shape": [1, 3, 5, 9], "shoud": 10, "should": 5, "show": [10, 11], "shp": [0, 5], "side": 5, "signatur": 5, "similar": [1, 5, 7], "simpli": 9, "simplifi": 0, "simplify_4326_shp": 0, "singl": [5, 7, 11], "size": 5, "slice": 1, "slightli": 9, "small": [9, 11], "smaller": 0, "smallest": 7, "snr": 1, "so": 7, "solid": 6, "some": [5, 9], "sort": 5, "sourc": [0, 1, 2, 3, 4, 5, 6, 9], "source_glob": 5, "span": 5, "spatial_res_met": 3, "special": [5, 11], "specif": 5, "specifi": 5, "squar": 5, "stage": 5, "standard": 5, "start": [1, 5, 8, 10, 11], "start_datetim": [1, 2, 3, 5], "stat": 5, "statist": 5, "std": 5, "step": [5, 7, 8, 9, 10, 11], "stop_ev": 1, "str": [0, 1, 2, 3, 4, 5, 6], "string": 5, "structur": [5, 9], "sub": 0, "subdivid": 0, "subdivide_region": 0, "subregion": 5, "subset": 1, "success": 1, "suffici": 5, "support": [9, 11], "sure": [5, 9], "surfac": [10, 11], "sw": 5, "swath": [1, 3, 6, 10], "swath_or_poca": 1, "system": 5, "t": [1, 5, 7], "tab": 6, "tabl": 1, "tag": [1, 5], "tag_group": 1, "take": [1, 5, 9], "target": 5, "task": 5, "task_func": 5, "teach": 11, "tell": 7, "term": [5, 9], "termin": 1, "test": [5, 8], "test_plot": 8, "than": 5, "thei": [1, 5], "them": [5, 9], "thi": [1, 5, 7, 9, 10], "third": 5, "thoroughli": 10, "those": [1, 5, 9, 11], "thread": 1, "threshold": 1, "tick": 1, "time": [1, 5], "time_20_ku_mask": 1, "timestamp": [1, 2, 3, 5], "timestep_month": [3, 4], "tmp": 5, "tmp_path": 5, "to_l2": 1, "tol": 1, "toler": 0, "too": 5, "total": 5, "track": [1, 5, 7, 11], "track_id": 1, "track_idx": [1, 2], "transform": 0, "translat": 5, "trend": 11, "trk_echo_error": 1, "true": [0, 1, 2, 4, 5, 6], "tslib": 3, "tupl": [1, 2, 3], "tutori": [7, 8], "tutorial__poca": 11, "tutorial__process_first_swath": [7, 11], "tutorial__process_first_track": [], "tutorial__process_first_waveform": [7, 11], "two": [1, 9], "txt": 9, "type": [0, 1, 5, 9], "typic": 5, "umn": 9, "understand": 7, "understood": 5, "undesir": 5, "uneven": 5, "unfortun": 9, "union": 5, "uniqu": 5, "unit": 5, "univers": 9, "unix": 5, "unwrap": 1, "unwrap_phase_diff": 1, "up": [8, 9], "updat": [1, 5], "us": [1, 5, 7, 9], "usual": 5, "v7": [1, 5], "valid": 10, "valu": [1, 5, 9], "valueerror": [1, 5], "variabl": [1, 5, 9], "varianc": 5, "variou": 5, "vector": 5, "veri": 5, "verifi": 10, "versatil": 5, "version": [1, 9], "via": 5, "view": 7, "visual": [7, 11], "void": 5, "volum": 9, "w": 5, "wa": [5, 10], "wafeform": 1, "want": 9, "waveform": [1, 5, 10, 11], "waveform_select": 1, "weight": 5, "weighted_mean_excl_outli": 5, "were": 5, "what": 1, "when": [1, 9], "where": [1, 5], "whether": 5, "which": [5, 9, 10], "while": [5, 7], "whitelist": 5, "width": 5, "window": [1, 5], "window_delay_error": 1, "window_ext": 5, "window_ntimestep": 3, "within": 5, "without": [1, 5], "wonder": 7, "word": 5, "work": [5, 8, 9], "worker": 5, "would": 9, "wrap": 1, "wrt": 1, "www": 9, "x": [1, 5, 6], "x_chunk_met": 5, "xarrai": [5, 9], "xkcd": 6, "xph_dist": 1, "xph_elev": 1, "xph_lat": 1, "xph_lon": 1, "xph_theta": 1, "xr": [1, 5], "xycut": 5, "y": [1, 5], "y_chunk_met": 5, "you": [5, 7, 9, 10], "your": [5, 9, 10]}, "titles": ["cryoswath.gis module", "cryoswath.l1b module", "cryoswath.l2 module", "cryoswath.l3 module", "cryoswath.l4 module", "cryoswath.misc module", "cryoswath.test_plots package", "Getting started", "Welcome to cryoswath\u2019s documentation!", "Prerequisites", "Tests", "Tutorials"], "titleterms": {"": 8, "content": [6, 8], "cryoswath": [0, 1, 2, 3, 4, 5, 6, 8], "data": 9, "depend": 9, "document": 8, "first": 7, "get": 7, "gi": 0, "instal": 9, "l1b": 1, "l2": 2, "l3": 3, "l4": 4, "map": 6, "misc": 5, "modul": [0, 1, 2, 3, 4, 5, 6], "packag": 6, "prerequisit": 9, "process": 7, "softwar": 9, "start": 7, "submodul": 6, "swath": 7, "test": 10, "test_plot": 6, "timeseri": 6, "track": [], "tutori": 11, "waveform": [6, 7], "welcom": 8}}) \ No newline at end of file diff --git a/tutorials.html b/tutorials.html index 95e37c3..4b158bd 100644 --- a/tutorials.html +++ b/tutorials.html @@ -87,8 +87,16 @@

Tutorials

There is a small number of tutorials that will be extended if I find support. Those are Jupyter notebooks located in scripts with names starting with “tutorial”.

-

scripts/tutorial.ipynb will contain a step-by-step guide to retrieve gridded glacier surface elevation trends from raw (L1b) data.

-

scripts/tutorial__poca.ipynb shows how the points of closest approach (POCA), that have a special meaning, can be retrieved.

+

scripts/tutorial.ipynb +will contain a step-by-step guide to retrieve gridded glacier surface +elevation trends from raw (L1b) data.

+

scripts/tutorial__process_first_waveform.ipynb +explains how to visualize single waveforms.

+

scripts/tutorial__process_first_swath.ipynb +teaches the retrieval of elevation estimates for a ceratin satellite track.

+

scripts/tutorial__poca.ipynb +shows how the points of closest approach (POCA), that have a special +meaning, can be retrieved.