"""
Calculates the radar wavelength from the radar frequency.
- Units:
+ Units
+ -----
- frequency: radar frequency [Hz]
- wavelength: radar wavelength [m]
- speed of light: speed of light [m s-1]
diff --git a/_modules/orbital_radar/readers/radar.html b/_modules/orbital_radar/readers/radar.html
index 5f7e16c..39c1f55 100644
--- a/_modules/orbital_radar/readers/radar.html
+++ b/_modules/orbital_radar/readers/radar.html
@@ -108,17 +108,17 @@ Source code for orbital_radar.readers.radar
Implemented readers
-------------------
- bco: Barbados Cloud Observatory, Barbados
- jue: JOYCE, Juelich, Germany
- mag: Magurele, Romania
- min: Mindelo, Cape Verde
- nor: Norunda, Sweden
- nya: Ny-Alesund, Svalbard
- mirac_p5: Polar 5, Mirac radar
- rasta: Falcon, RASTA radar
- arm: ARM sites
- pamtra: PAMTRA simulations
- cloudnet: cloudnet format
+ - bco: Barbados Cloud Observatory, Barbados
+ - jue: JOYCE, Juelich, Germany
+ - mag: Magurele, Romania
+ - min: Mindelo, Cape Verde
+ - nor: Norunda, Sweden
+ - nya: Ny-Alesund, Svalbard
+ - mirac_p5: Polar 5, Mirac radar
+ - rasta: Falcon, RASTA radar
+ - arm: ARM sites
+ - pamtra: PAMTRA simulations
+ - cloudnet: cloudnet format
"""
def __init__(self, date, site_name, path, input_radar_format) -> None:
diff --git a/api/radarspec.html b/api/radarspec.html
index 3044fc6..8ec06d1 100644
--- a/api/radarspec.html
+++ b/api/radarspec.html
@@ -249,10 +249,6 @@ References
calculate_wavelength()[source]ΒΆ
Calculates the radar wavelength from the radar frequency.
-Units:
-- frequency: radar frequency [Hz]
-- wavelength: radar wavelength [m]
-- speed of light: speed of light [m s-1]
diff --git a/searchindex.js b/searchindex.js
index 888a864..7cdb6f8 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["acknowledgments", "api-reference", "api/helpers", "api/plotting", "api/radarspec", "api/readers", "api/simulator", "api/suborbital", "api/writers", "getting_started", "index", "installation", "output_description", "overview"], "filenames": ["acknowledgments.rst", "api-reference.rst", "api/helpers.rst", "api/plotting.rst", "api/radarspec.rst", "api/readers.rst", "api/simulator.rst", "api/suborbital.rst", "api/writers.rst", "getting_started.rst", "index.rst", "installation.rst", "output_description.rst", "overview.rst"], "titles": ["Acknowledgments", "API Reference", "Helpers", "Plotting", "Radarspec", "Readers", "Simulator", "Groundbased", "Writers", "Getting Started with Orbital-Radar", "Orbital-radar", "Installation", "Variable List - Output file", "Overview"], "terms": {"The": [0, 4, 5, 6, 7, 9, 12, 13], "code": [0, 5, 10], "wa": [0, 7], "develop": [0, 11, 13], "part": 0, "two": [0, 4, 5], "esa": [0, 13], "fund": 0, "project": 0, "frm4radar": 0, "cloud": [0, 5, 13], "profil": [0, 6, 13], "valid": [0, 5], "contract": 0, "No": [0, 5], "4000122916": 0, "17": 0, "i": [0, 5, 7], "ef": 0, "acpv": 0, "best": [0, 5, 12, 13], "practic": 0, "protocol": 0, "aerosol": 0, "precipit": [0, 5], "4000140645": 0, "23": 0, "ns": 0, "thank": 0, "support": [0, 10], "from": [0, 2, 4, 5, 6, 7, 9, 11, 12, 13], "univers": [0, 13], "cologn": [0, 5, 13], "stonybrook": 0, "mcgill": 0, "colleagu": 0, "involv": 0, "luka": 0, "pfitzenmai": [0, 13], "nil": 0, "riss": 0, "pavlo": 0, "kollia": [0, 4, 7], "bernat": 0, "puigdom\u00e8nech": 0, "treserra": 0, "imk": 0, "schirmach": [0, 4], "simul": [1, 2, 5, 7, 8, 10, 12, 13], "radarspec": [1, 10], "groundbas": [1, 5, 9, 10], "helper": [1, 10], "plot": [1, 6, 10], "along": [1, 4, 6, 7, 9, 12, 13], "track": [1, 4, 6, 7, 9, 12, 13], "reader": [1, 10], "cloudnet": [1, 7, 9, 13], "config": [1, 9], "radar": [1, 2, 4, 6, 7, 8, 11, 12, 13], "rang": [1, 4, 6, 7, 9, 12], "weight": [1, 4, 6, 9], "function": [1, 2, 4, 6, 7, 8, 9], "spaceview": 1, "writer": [1, 10], "thi": [2, 4, 5, 6, 7, 8, 9, 13], "modul": [2, 4, 7, 10], "contain": [2, 4, 5, 6, 7, 8, 9, 12, 13], "orbit": [2, 6, 8, 11, 12, 13], "orbital_radar": [2, 4, 5, 6, 7, 8, 9, 11], "db2li": 2, "x": [2, 6], "sourc": [2, 4, 5, 6, 7, 8, 9, 11, 13], "convers": [2, 7, 13], "db": [2, 6], "linear": 2, "paramet": [2, 4, 5, 6, 7, 8, 9], "float": [2, 4, 5, 6], "ani": [2, 5, 6], "valu": [2, 5, 6, 7], "arrai": [2, 4, 5, 6, 7], "convert": [2, 5, 7, 9], "unit": [2, 4, 5, 7], "li2db": 2, "satellit": [4, 6, 7, 9, 12, 13], "class": [4, 5, 6, 7], "calcul": [4, 6, 7, 9, 13], "averag": [4, 6], "main": [4, 5], "method": [4, 5, 6, 7, 13], "definit": 4, "base": [4, 5, 6, 7, 9, 12, 13], "lamer": 4, "et": [4, 7, 9, 13], "al": [4, 7, 9, 13], "2020": 4, "2023": 4, "pre": [4, 6, 7], "defin": [4, 6, 7, 9], "ar": [4, 5, 6, 7, 9, 13], "avail": [4, 5, 9, 11], "earthcar": [4, 5, 9, 12, 13], "cloudsat": [4, 13], "frequenc": [4, 7, 9], "2014": 4, "tabl": [4, 6, 9], "1": [4, 5, 6, 9, 10], "veloc": [4, 5, 6, 7, 9, 12, 13], "eq": 4, "4": [4, 5, 6, 10], "antenna": [4, 5, 12], "diamet": 4, "altitud": [4, 7, 9], "puls": [4, 5, 7, 9], "length": [4, 5, 7, 9], "resolut": [4, 6, 9, 12], "ifov_factor": 4, "2022": [4, 5, 9], "ifov_scal": 4, "tanelli": 4, "2008": 4, "long": 4, "noth": 4, "report": 4, "s": [4, 5, 6, 9, 13], "detect": [4, 6], "limit": [4, 6], "pule": 4, "repetit": 4, "prf": 4, "noise_z": 4, "ze_bin": 4, "hogan": 4, "2005": 4, "ze_std": 4, "ze_std_background": 4, "vm_bins_broad": 4, "figur": [4, 13], "7": [4, 5, 9], "vm_std_broad": [4, 6], "vm_std_broad_background": 4, "arctic": 4, "integr": [4, 6, 9, 12], "accureci": 4, "0": [4, 5, 6, 9, 11, 12, 13], "968": 4, "us": [4, 5, 6, 7, 9, 10, 11], "http": [4, 7, 9, 13], "doi": [4, 7, 9], "org": [4, 7, 9], "10": [4, 7, 9], "1175": 4, "jtech1768": 4, "jtech": 4, "d": [4, 9], "11": [4, 11], "00202": 4, "3389": 4, "frsen": 4, "860284": 4, "5194": [4, 7], "amt": [4, 7], "13": 4, "2363": 4, "eguspher": 4, "636": 4, "1109": 4, "tgr": 4, "2002030": 4, "radarbeam": 4, "file_earthcar": [4, 6, 9], "none": [4, 6], "sat_nam": [4, 6, 9], "nyquist_from_prf": [4, 6], "fals": [4, 6, 9], "sat_param": 4, "manag": 4, "specif": [4, 5, 7, 11, 12, 13], "user": [4, 5, 6, 8, 9, 11, 13], "specifi": [4, 8, 9], "space": [4, 13], "born": [4, 13], "It": [4, 7, 9], "also": [4, 5], "transform": [4, 6, 7, 12, 13], "attribut": [4, 5, 6, 7, 9], "param": 4, "print": [4, 5, 7, 11], "summari": [4, 7], "calculate_along_rang": 4, "range_coord": 4, "coordin": [4, 5, 6, 7, 13], "ground": [4, 5, 7, 9, 12, 13], "m": [4, 5, 6, 7, 11], "calculate_along_track": 4, "along_track_coord": 4, "calculate_ifov": 4, "instantan": [4, 12], "field": [4, 6, 12, 13], "view": [4, 5, 6, 12], "ifov": 4, "calculate_nyquist_veloc": 4, "nyquist": 4, "wavelength": 4, "calculate_velocity_error": 4, "error": [4, 6, 12, 13], "due": [4, 6, 13], "calculate_wavelength": 4, "hz": 4, "speed": [4, 5], "light": 4, "calculate_weighting_funct": 4, "create_along_range_grid": 4, "creat": [4, 5, 7, 10, 11], "grid": [4, 5, 6, 7], "which": [4, 5, 6, 9, 13], "evalu": 4, "pulse_length": 4, "If": [4, 5, 7, 9], "equidist": 4, "cannot": 4, "create_along_track_grid": 4, "2": [4, 5, 9, 10, 11], "outermost": 4, "bin": [4, 6, 12], "rel": 4, "line": [4, 10, 11], "size": [4, 6], "alwai": [4, 5], "lie": 4, "within": [4, 6, 13], "static": [4, 5, 6, 7], "normalized_range_weighting_function_default": 4, "range_bin": 4, "normalized_range_weighting_function_earthcar": 4, "prepar": [4, 6, 9, 13], "high": [4, 6], "interpol": [4, 5, 6, 7], "return": [4, 5, 6, 7], "range_weight": 4, "normal": 4, "properti": [4, 7], "name": [4, 5, 6, 7, 8, 9, 11], "str": [4, 5, 8], "int": 4, "antenna_diamet": 4, "along_track_resolut": 4, "range_resolut": 4, "detection_limit": 4, "union": 4, "list": [4, 5, 6, 10], "ndarrai": 4, "nyquist_veloc": 4, "nan": [4, 6], "pulse_repetition_frequ": 4, "script": [5, 9], "read": 5, "data": [5, 6, 7, 10, 12], "convert_tim": 5, "ds": [5, 6, 7, 8], "time_vari": 5, "base_tim": 5, "factor": [5, 12], "time": [5, 6, 7, 9, 12, 13], "second": 5, "sinc": 5, "datetime64": [5, 7], "xarrai": [5, 6, 7, 8], "dataset": [5, 6, 7, 8, 9], "variabl": [5, 6, 7, 10], "string": 5, "e": [5, 7, 9, 11], "g": [5, 9], "1970": 5, "01": 5, "option": [5, 9, 13], "nanosecond": 5, "default": [5, 6], "read_cloudnet": 5, "attenuation_correction_input": 5, "date": [5, 7, 9], "site_nam": 5, "path": [5, 9], "add_dat": 5, "true": [5, 7, 9], "follow": [5, 6, 9, 11, 13], "file": [5, 6, 7, 8, 10, 13], "expect": [5, 13], "02": [5, 9], "14": [5, 9], "mindelo": [5, 9], "20220214_mindelo_ecmwf": 5, "nc": [5, 9], "20220214_mindelo_categor": 5, "product": [5, 7, 9, 12, 13], "either": [5, 9], "categor": [5, 7, 9], "ecmwf": [5, 7, 9], "np": [5, 6, 7], "site": [5, 9, 13], "should": [5, 6, 7, 9], "year": 5, "month": 5, "dai": [5, 7, 9], "subdirectori": 5, "bool": [5, 7], "ad": [5, 6, 7, 13], "toml": [5, 9], "configur": [5, 7, 10, 13], "check_config": 5, "check": [5, 6, 7, 9], "consist": [5, 6], "read_config": 5, "filenam": [5, 7, 8, 9], "dict": 5, "dictionari": 5, "all": [5, 6, 7, 9, 11, 13], "differ": [5, 6, 7], "format": [5, 10], "These": [5, 13], "wrap": 5, "pick": 5, "correct": [5, 6, 7, 9, 12], "depend": [5, 7, 11, 13], "final": [5, 7], "output": [5, 6, 7, 8, 9, 10], "an": [5, 9, 13], "reflect": [5, 6, 7, 9, 12, 13], "ze": [5, 6, 7, 13], "mm6": [5, 6, 7], "3": [5, 6, 7, 10, 11], "vm": [5, 6, 7, 13], "input": [5, 6, 7, 9, 12, 13], "doppler": [5, 6, 7, 12, 13], "neg": [5, 12, 13], "downward": 5, "motion": [5, 6, 12, 13], "posit": 5, "upward": 5, "chang": 5, "match": [5, 7], "spaceborn": [5, 6, 7], "convent": 5, "input_radar_format": [5, 7], "select": 5, "provid": [5, 9, 13], "perform": 5, "qualiti": [5, 12, 13], "import": [5, 9, 11], "convert_and_sort_tim": 5, "sort": 5, "get_all_fil": 5, "pattern": 5, "directori": [5, 8, 9, 11], "insid": [5, 7, 9], "make_date_path": 5, "structur": [5, 9, 10], "exist": 5, "otherwis": [5, 6], "regular": [5, 7], "without": [5, 6, 13], "extens": [5, 13], "read_arm": 5, "arm": [5, 13], "estim": [5, 6, 12, 13], "dbz": [5, 6, 7], "read_bco": 5, "netcdf": [5, 7, 8, 9], "rpg": [5, 13], "w": [5, 13], "band": 5, "precess": 5, "matlab": [5, 13], "uunivers": 5, "uoc": 5, "thei": 5, "correspond": 5, "level": [5, 6, 7, 9, 12], "version": [5, 9, 11], "process": [5, 9, 13], "note": [5, 6, 7], "onli": [5, 6, 7], "one": 5, "per": 5, "height": [5, 6, 7, 12], "alreadi": 5, "abov": [5, 6, 7, 12], "mean": [5, 6, 7, 9, 12], "sea": [5, 7, 12], "read_geom": 5, "fill": [5, 6, 13], "999": 5, "recogn": [5, 9], "read_mirac_p5": 5, "onboard": 5, "polar": [5, 9, 13], "5": [5, 6, 9, 10], "aircraft": [5, 9, 12], "read_pamtra": 5, "pamtra": 5, "point": [5, 12, 13], "locat": [5, 9], "attenu": [5, 7, 9, 12], "bottom": [5, 13], "up": [5, 11], "addition": 5, "ze_top_down": 5, "top": [5, 6, 13], "down": [5, 6], "ze_bottom_up": 5, "read_rasta": 5, "airborn": [5, 7, 9], "rasta": [5, 13], "onto": [5, 6, 7], "ga": [5, 7], "appli": [5, 6, 7, 13], "gaseous_twowayatt": 5, "horizont": [5, 6, 7, 12], "flag": [5, 6, 12, 13], "first": [5, 7, 11, 13], "remov": 5, "nadir": 5, "last": 5, "gate": 5, "beyond": 5, "maximum": [5, 9], "possibl": [5, 13], "echo": [5, 7, 9, 13], "ghost": 5, "domain": 5, "6": [5, 9], "underground": 5, "signal": [5, 6, 12], "nois": [5, 6, 12, 13], "8": 5, "z": 5, "can": [5, 9, 11, 13], "flag_z_interpol": 5, "ac_spe": 5, "vertic": [5, 12], "read_uoc_v0": 5, "read_uoc_v1": 5, "spectra": 5, "improv": 5, "read_uoc_v2": 5, "remove_duplicate_tim": 5, "duplic": 5, "xr": [5, 6, 7], "status_messag": 5, "messag": 5, "while": 5, "cpr": [5, 9, 13], "rangewf": 5, "read_range_weighting_funct": 5, "revers": 5, "sign": 5, "wf": 5, "read_spaceview": 5, "run": [6, 7, 10, 11], "ms_threshold": [6, 9], "12": [6, 7], "ms_threshold_integr": [6, 9], "41": 6, "radar_spec": 6, "add_attribut": 6, "add": [6, 7, 9, 13], "add_nois": 6, "x_std": 6, "equat": [6, 7], "uncertainti": 6, "random": [6, 13], "dataarrai": [6, 7], "shape": 6, "equal": [6, 7], "x_nois": 6, "apply_detection_limit": 6, "var_z": 6, "var_oth": 6, "convolut": [6, 7], "other": 6, "mask": 6, "calculate_along_track_sat_bin_edg": 6, "edg": 6, "wai": 6, "equival": 6, "calculate_height_sat_bin_edg": 6, "calculate_ms_flag": 6, "multipl": [6, 9, 12, 13], "scatter": [6, 9, 12, 13], "occur": 6, "step": [6, 9, 11, 13], "certain": 6, "threshold": [6, 9, 13], "atmospher": 6, "toa": [6, 9], "surfac": [6, 9], "reach": 6, "critic": 6, "calculate_nubf": 6, "non": 6, "uniform": 6, "beam": 6, "standard": [6, 13], "deviat": 6, "volum": [6, 13], "current": 6, "express": 6, "indic": [6, 13], "mai": 6, "futur": 6, "reduc": 6, "calculate_nubf_flag": 6, "higher": 6, "than": 6, "calculate_signal_fract": 6, "fraction": [6, 12], "calculate_vm_bia": 6, "bia": [6, 13], "between": [6, 7, 9], "calculate_vm_bias_flag": 6, "absolut": [6, 9], "calculate_vm_nois": 6, "lookup": 6, "calculate_vm_std_nubf": 6, "outstand": 6, "bias": 6, "caus": 6, "gradient": 6, "direct": 6, "taken": 6, "15": 6, "divid": 6, "km": [6, 12], "set": [6, 7, 10, 11, 13], "befor": [6, 9, 13], "calculate_ze_nois": 6, "empti": 6, "accord": 6, "check_input_dataset": 6, "convolve_along_track": 6, "suborbit": [6, 7, 9, 13], "further": [6, 13], "convolve_height": 6, "fold_vm": 6, "fold": [6, 12, 13], "integrate_along_track": 6, "repres": 6, "footprint": 6, "given": [6, 13], "refer": [6, 9, 10], "center": 6, "kwd": 6, "plot_histogram": 6, "histogram": 6, "plot_scatt": 6, "prepare_input_dataset": 6, "comput": 6, "includ": [6, 7, 9, 13], "replac": 6, "zero": 6, "both": [6, 7], "entir": 6, "along_track": [6, 7, 12], "must": 6, "have": [6, 12], "vm_uncertainty_equ": 6, "vm_std_nubf": 6, "total": 6, "broaden": [6, 13], "orbitalradar": 7, "subclass": 7, "geometri": 7, "wind": [7, 9, 12], "flight": [7, 9], "vel": 7, "assum": 7, "lat": [7, 9], "lon": [7, 9], "config_fil": [7, 9], "suborbital_radar": 7, "short": 7, "add_airborne_vari": 7, "add_attenu": 7, "da_gas_atten": 7, "same": [7, 9], "add_ground_echo": 7, "artifici": 7, "chosen": 7, "after": [7, 9, 12], "here": [7, 13], "add_groundbased_vari": 7, "add_vmze_attr": 7, "attenuation_correct": [7, 9], "ds_cloudnet": 7, "gas_atten": 7, "137": 7, "era5": 7, "each": 7, "vari": 7, "therefor": [7, 13], "Then": [7, 11], "There": [7, 13], "major": 7, "cloudnet_ecmwf": 7, "cloudnet_categor": 7, "wrt": 7, "radar_gas_atten": 7, "94": [7, 13], "ghz": [7, 13], "check_is_sea_level": 7, "respect": 7, "convert_frequ": 7, "35": 7, "2019": [7, 9], "4949": 7, "mm3": 7, "measur": [7, 13], "now": 7, "correct_dielectric_const": 7, "dielectr": [7, 9], "constant": [7, 9], "k_g": 7, "k_": 7, "z_e": 7, "log_": 7, "left": 7, "frac": 7, "right": 7, "create_along_track": 7, "create_regular_along_track": 7, "create_regular_height": 7, "interpolate_to_regular_grid": 7, "prepare_d": 7, "start_dat": 7, "end_dat": 7, "start": [7, 10, 11, 12, 13], "end": [7, 9], "pd": 7, "datetimeindex": 7, "range_to_height": 7, "station": [7, 9], "write_output": [7, 9], "frame": 7, "inclus": 7, "run_dat": [7, 9], "singl": [7, 13], "write": [7, 8], "to_netcdf": 7, "store": [7, 9], "write_spaceview": 8, "successfulli": [9, 11], "instal": [9, 10, 13], "softwar": 9, "acquir": 9, "you": [9, 11, 13], "anoth": 9, "python": [9, 11, 13], "exampl": [9, 10], "under": 9, "ipynb": [9, 13], "One": 9, "cape": 9, "verd": 9, "april": [9, 13], "joyc": [9, 13], "j\u00fclich": [9, 13], "germani": [9, 13], "2021": [9, 13], "mirac": [9, 13], "A": [9, 13], "board": 9, "aflux": 9, "campaign": 9, "mech": 9, "1038": 9, "s41597": 9, "022": 9, "01900": 9, "sciebo": 9, "link": [9, 13], "pleas": [9, 11, 13], "unzip": 9, "orbital_radar_data": 9, "zip": 9, "archiv": 9, "your": [9, 11], "choic": 9, "lateron": 9, "we": 9, "necessari": 9, "templat": 9, "github": [9, 13], "copi": 9, "orbital_radar_config": 9, "root": 9, "packag": [9, 11, 12, 13], "renam": 9, "modifi": 9, "kei": 9, "keep": 9, "unchang": 9, "range_weighting_funct": 9, "cpr_pointtargetrespons": 9, "txt": 9, "min": 9, "folder": 9, "remain": 9, "To": [9, 11, 13], "streamlin": 9, "recommend": 9, "orbital_radar_config_path": 9, "env": [9, 11], "desir": 9, "altern": 9, "manual": 9, "export": 9, "them": 9, "allow": 9, "switch": 9, "easili": 9, "execut": 9, "flexibl": 9, "visual": 9, "tool": [9, 13], "demonstr": 9, "how": [9, 13], "initi": 9, "grb": 9, "written": 9, "gener": [9, 13], "automat": 9, "ora_0": 9, "2_earthcare_l1_groundbased_min_inoe94_20220214t000000_20220214t235959": 9, "inform": [9, 13], "ora": 9, "number": [9, 12], "l1": [9, 12, 13], "type": 9, "abbrev": 9, "inoe94": 9, "20220214t000000": 9, "20220214t235959": 9, "more": 9, "comprehens": 9, "come": 9, "upon": 9, "out": 9, "help": [9, 11], "syntax": 9, "n": [9, 11], "f": [9, 11], "via": 9, "might": 9, "In": 9, "case": [9, 13], "describ": 9, "detail": 9, "lowercas": 9, "k2": 9, "cloudnet_product": 9, "range_min": 9, "minimum": 9, "homogen": 9, "range_max": 9, "range_r": 9, "keep_tim": 9, "ground_echo_ze_max": 9, "ground_echo_pulse_length": 9, "artificu": 9, "mean_wind": [9, 12], "mean_flight_veloc": 9, "bco": 9, "mp5": 9, "affili": 9, "address": 9, "mail": 9, "email": 9, "longitud": 9, "latitud": 9, "alt": 9, "platform": 9, "overview": 10, "get": [10, 11, 13], "download": 10, "test": [10, 11, 13], "environ": [10, 11], "command": [10, 11], "interfac": [10, 11], "descript": [10, 12], "api": 10, "acknowledg": 10, "index": 10, "search": 10, "page": [10, 13], "new": [11, 13], "conda": 11, "activ": 11, "navig": 11, "pip": 11, "cd": 11, "python3": 11, "For": [11, 12], "purpos": 11, "edit": 11, "mode": 11, "dev": 11, "mac": 11, "verifi": 11, "ha": 11, "been": 11, "few": 11, "termin": 11, "__version__": 11, "onc": 11, "ve": 11, "complet": 11, "its": 11, "success": 11, "proce": 11, "section": [11, 13], "begin": 11, "need": [11, 13], "make": 11, "jupyt": 11, "lab": 11, "ipykernel": 11, "c": [11, 13], "forg": 11, "regist": 11, "kernel": 11, "observ": [12, 13], "perspect": 12, "sat_ifov": 12, "sat_range_resolut": 12, "sat_along_track_resolut": 12, "ze_sat": 12, "convolv": 12, "vm_sat": 12, "vm_sat_vel": 12, "ze_sat_nois": 12, "vm_sat_nois": 12, "vm_sat_fold": 12, "nubf_flag": 12, "ms_flag": 12, "distanc": 12, "meter": 12, "along_track_sat": 12, "range_sat": 12, "forward": 12, "present": [12, 13], "ccd": 12, "z_jsg": 12, "reflectivity_no_attenuation_correct": 12, "sampl": 12, "jsg": 12, "flagm": 12, "multiple_scatt": 12, "ing_statu": 12, "pixel": [12, 13], "cpr_height": 12, "v_d": 12, "u": 12, "doppler_velocity_best_estim": 12, "unfold": 12, "mi": 12, "doppler_velocity_uncorrect": 12, "control": 12, "preliminari": 12, "py": 13, "2024": 13, "air": 13, "synthet": 13, "mission": 13, "nasa": 13, "too": 13, "By": 13, "resampl": 13, "mimic": 13, "hardwar": 13, "free": 13, "addit": 13, "system": 13, "characterist": 13, "optic": 13, "handl": 13, "sever": 13, "larg": 13, "network": 13, "actri": 13, "portal": 13, "web": 13, "so": 13, "statist": 13, "robust": 13, "algorithm": 13, "cal": 13, "val": 13, "broad": 13, "commun": 13, "earth": 13, "metadata": 13, "geom": 13, "categoris": 13, "remot": 13, "sens": 13, "ac3": 13, "repositori": 13, "com": 13, "igmk": 13, "plane": 13, "awi": 13, "bremerhaven": 13, "falcon": 13, "lacmo": 13, "pari": 13, "franc": 13, "illustr": 13, "flowchart": 13, "workflow": 13, "explan": 13, "about": 13, "parametris": 13, "preper": 13, "show": 13, "6th": 13, "fourth": 13, "row": 13, "intermedi": 13, "well": 13, "bullet": 13, "explain": 13, "ax": 13, "axi": 13, "y": 13, "toward": 13, "hight": 13, "nufb": 13, "spectrum": 13, "std": 13, "nubf": 13, "ms": 13, "mimick": 13, "nom": 13, "cnom": 13, "document": 13, "see": 13, "schemat": 13, "sec": 13, "truth": 13, "choos": 13, "own": 13, "instruct": 13, "chapter": 13, "demo": 13, "notebook": 13, "togeth": 13}, "objects": {"orbital_radar": [[2, 0, 0, "-", "helpers"], [4, 0, 0, "-", "radarspec"], [6, 0, 0, "-", "simulator"], [7, 0, 0, "-", "suborbital"]], "orbital_radar.helpers": [[2, 1, 1, "", "db2li"], [2, 1, 1, "", "li2db"]], "orbital_radar.radarspec": [[4, 2, 1, "", "RadarBeam"], [4, 2, 1, "", "RadarSpec"]], "orbital_radar.radarspec.RadarBeam": [[4, 3, 1, "", "calculate_along_range"], [4, 3, 1, "", "calculate_along_track"], [4, 3, 1, "", "calculate_ifov"], [4, 3, 1, "", "calculate_nyquist_velocity"], [4, 3, 1, "", "calculate_velocity_error"], [4, 3, 1, "", "calculate_wavelength"], [4, 3, 1, "", "calculate_weighting_functions"], [4, 3, 1, "", "create_along_range_grid"], [4, 3, 1, "", "create_along_track_grid"], [4, 3, 1, "", "normalized_range_weighting_function_default"], [4, 3, 1, "", "normalized_range_weighting_function_earthcare"], [4, 4, 1, "", "params"]], "orbital_radar.readers": [[5, 0, 0, "-", "cloudnet"], [5, 0, 0, "-", "config"], [5, 0, 0, "-", "radar"], [5, 0, 0, "-", "rangewf"], [5, 0, 0, "-", "spaceview"]], "orbital_radar.readers.cloudnet": [[5, 1, 1, "", "convert_time"], [5, 1, 1, "", "read_cloudnet"]], "orbital_radar.readers.config": [[5, 1, 1, "", "check_config"], [5, 1, 1, "", "read_config"]], "orbital_radar.readers.radar": [[5, 2, 1, "", "Radar"]], "orbital_radar.readers.radar.Radar": [[5, 3, 1, "", "convert_and_sort_time"], [5, 3, 1, "", "get_all_files"], [5, 3, 1, "", "make_date_path"], [5, 3, 1, "", "read_arm"], [5, 3, 1, "", "read_bco"], [5, 3, 1, "", "read_cloudnet"], [5, 3, 1, "", "read_geoms"], [5, 3, 1, "", "read_mirac_p5"], [5, 3, 1, "", "read_pamtra"], [5, 3, 1, "", "read_rasta"], [5, 3, 1, "", "read_uoc_v0"], [5, 3, 1, "", "read_uoc_v1"], [5, 3, 1, "", "read_uoc_v2"], [5, 3, 1, "", "remove_duplicate_times"], [5, 3, 1, "", "status_message"]], "orbital_radar.readers.rangewf": [[5, 1, 1, "", "read_range_weighting_function"]], "orbital_radar.readers.spaceview": [[5, 1, 1, "", "read_spaceview"]], "orbital_radar.simulator": [[6, 2, 1, "", "Simulator"]], "orbital_radar.simulator.Simulator": [[6, 3, 1, "", "add_attributes"], [6, 3, 1, "", "add_noise"], [6, 3, 1, "", "apply_detection_limit"], [6, 3, 1, "", "calculate_along_track_sat_bin_edges"], [6, 3, 1, "", "calculate_height_sat_bin_edges"], [6, 3, 1, "", "calculate_ms_flag"], [6, 3, 1, "", "calculate_nubf"], [6, 3, 1, "", "calculate_nubf_flag"], [6, 3, 1, "", "calculate_signal_fraction"], [6, 3, 1, "", "calculate_vm_bias"], [6, 3, 1, "", "calculate_vm_bias_flag"], [6, 3, 1, "", "calculate_vm_noise"], [6, 3, 1, "", "calculate_vm_std_nubf"], [6, 3, 1, "", "calculate_ze_noise"], [6, 3, 1, "", "check_input_dataset"], [6, 3, 1, "", "convolve_along_track"], [6, 3, 1, "", "convolve_height"], [6, 3, 1, "", "fold_vm"], [6, 3, 1, "", "integrate_along_track"], [6, 3, 1, "", "plot"], [6, 3, 1, "", "plot_histogram"], [6, 3, 1, "", "plot_scatter"], [6, 3, 1, "", "prepare_input_dataset"], [6, 3, 1, "", "transform"], [6, 3, 1, "", "vm_uncertainty_equation"]], "orbital_radar.suborbital": [[7, 2, 1, "", "Suborbital"]], "orbital_radar.suborbital.Suborbital": [[7, 3, 1, "", "add_airborne_variables"], [7, 3, 1, "", "add_attenuation"], [7, 3, 1, "", "add_ground_echo"], [7, 3, 1, "", "add_groundbased_variables"], [7, 3, 1, "", "add_vmze_attrs"], [7, 3, 1, "", "attenuation_correction"], [7, 3, 1, "", "check_is_sea_level"], [7, 3, 1, "", "convert_frequency"], [7, 3, 1, "", "correct_dielectric_constant"], [7, 3, 1, "", "create_along_track"], [7, 3, 1, "", "create_regular_along_track"], [7, 3, 1, "", "create_regular_height"], [7, 3, 1, "", "interpolate_to_regular_grid"], [7, 3, 1, "", "prepare_dates"], [7, 3, 1, "", "range_to_height"], [7, 3, 1, "", "run"], [7, 3, 1, "", "run_date"], [7, 4, 1, "", "summary"], [7, 3, 1, "", "to_netcdf"]], "orbital_radar.writers": [[8, 0, 0, "-", "spaceview"]], "orbital_radar.writers.spaceview": [[8, 1, 1, "", "write_spaceview"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:property"}, "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"]}, "titleterms": {"acknowledg": 0, "api": 1, "refer": [1, 4], "helper": 2, "plot": 3, "along": 3, "track": 3, "radarspec": 4, "reader": 5, "cloudnet": 5, "config": 5, "radar": [5, 9, 10], "rang": 5, "weight": 5, "function": 5, "spaceview": [5, 8], "simul": [6, 9], "groundbas": 7, "writer": 8, "get": 9, "start": 9, "orbit": [9, 10], "download": 9, "test": 9, "data": [9, 13], "creat": 9, "configur": 9, "file": [9, 12], "set": 9, "environ": 9, "variabl": [9, 12], "run": 9, "command": 9, "line": 9, "interfac": 9, "descript": 9, "indic": 10, "tabl": 10, "instal": 11, "list": 12, "output": [12, 13], "overview": [12, 13], "width": 12, "25": 12, "75": 12, "header": 12, "row": 12, "1": [12, 13], "ze": 12, "correspond": 12, "c": 12, "pro": 12, "fmr": 12, "pdd": 12, "vm": 12, "cd": 12, "support": 13, "format": 13, "2": 13, "structur": 13, "code": 13, "3": 13, "exampl": 13, "4": 13, "5": 13, "us": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 56}})
\ No newline at end of file
+Search.setIndex({"docnames": ["acknowledgments", "api-reference", "api/helpers", "api/plotting", "api/radarspec", "api/readers", "api/simulator", "api/suborbital", "api/writers", "getting_started", "index", "installation", "output_description", "overview"], "filenames": ["acknowledgments.rst", "api-reference.rst", "api/helpers.rst", "api/plotting.rst", "api/radarspec.rst", "api/readers.rst", "api/simulator.rst", "api/suborbital.rst", "api/writers.rst", "getting_started.rst", "index.rst", "installation.rst", "output_description.rst", "overview.rst"], "titles": ["Acknowledgments", "API Reference", "Helpers", "Plotting", "Radarspec", "Readers", "Simulator", "Groundbased", "Writers", "Getting Started with Orbital-Radar", "Orbital-radar", "Installation", "Variable List - Output file", "Overview"], "terms": {"The": [0, 4, 5, 6, 7, 9, 12, 13], "code": [0, 5, 10], "wa": [0, 7], "develop": [0, 11, 13], "part": 0, "two": [0, 4, 5], "esa": [0, 13], "fund": 0, "project": 0, "frm4radar": 0, "cloud": [0, 5, 13], "profil": [0, 6, 13], "valid": [0, 5], "contract": 0, "No": [0, 5], "4000122916": 0, "17": 0, "i": [0, 5, 7], "ef": 0, "acpv": 0, "best": [0, 5, 12, 13], "practic": 0, "protocol": 0, "aerosol": 0, "precipit": [0, 5], "4000140645": 0, "23": 0, "ns": 0, "thank": 0, "support": [0, 10], "from": [0, 2, 4, 5, 6, 7, 9, 11, 12, 13], "univers": [0, 13], "cologn": [0, 5, 13], "stonybrook": 0, "mcgill": 0, "colleagu": 0, "involv": 0, "luka": 0, "pfitzenmai": [0, 13], "nil": 0, "riss": 0, "pavlo": 0, "kollia": [0, 4, 7], "bernat": 0, "puigdom\u00e8nech": 0, "treserra": 0, "imk": 0, "schirmach": [0, 4], "simul": [1, 2, 5, 7, 8, 10, 12, 13], "radarspec": [1, 10], "groundbas": [1, 5, 9, 10], "helper": [1, 10], "plot": [1, 6, 10], "along": [1, 4, 6, 7, 9, 12, 13], "track": [1, 4, 6, 7, 9, 12, 13], "reader": [1, 10], "cloudnet": [1, 7, 9, 13], "config": [1, 9], "radar": [1, 2, 4, 6, 7, 8, 11, 12, 13], "rang": [1, 4, 6, 7, 9, 12], "weight": [1, 4, 6, 9], "function": [1, 2, 4, 6, 7, 8, 9], "spaceview": 1, "writer": [1, 10], "thi": [2, 4, 5, 6, 7, 8, 9, 13], "modul": [2, 4, 7, 10], "contain": [2, 4, 5, 6, 7, 8, 9, 12, 13], "orbit": [2, 6, 8, 11, 12, 13], "orbital_radar": [2, 4, 5, 6, 7, 8, 9, 11], "db2li": 2, "x": [2, 6], "sourc": [2, 4, 5, 6, 7, 8, 9, 11, 13], "convers": [2, 7, 13], "db": [2, 6], "linear": 2, "paramet": [2, 4, 5, 6, 7, 8, 9], "float": [2, 4, 5, 6], "ani": [2, 5, 6], "valu": [2, 5, 6, 7], "arrai": [2, 4, 5, 6, 7], "convert": [2, 5, 7, 9], "unit": [2, 5, 7], "li2db": 2, "satellit": [4, 6, 7, 9, 12, 13], "class": [4, 5, 6, 7], "calcul": [4, 6, 7, 9, 13], "averag": [4, 6], "main": [4, 5], "method": [4, 5, 6, 7, 13], "definit": 4, "base": [4, 5, 6, 7, 9, 12, 13], "lamer": 4, "et": [4, 7, 9, 13], "al": [4, 7, 9, 13], "2020": 4, "2023": 4, "pre": [4, 6, 7], "defin": [4, 6, 7, 9], "ar": [4, 5, 6, 7, 9, 13], "avail": [4, 5, 9, 11], "earthcar": [4, 5, 9, 12, 13], "cloudsat": [4, 13], "frequenc": [4, 7, 9], "2014": 4, "tabl": [4, 6, 9], "1": [4, 5, 6, 9, 10], "veloc": [4, 5, 6, 7, 9, 12, 13], "eq": 4, "4": [4, 5, 6, 10], "antenna": [4, 5, 12], "diamet": 4, "altitud": [4, 7, 9], "puls": [4, 5, 7, 9], "length": [4, 5, 7, 9], "resolut": [4, 6, 9, 12], "ifov_factor": 4, "2022": [4, 5, 9], "ifov_scal": 4, "tanelli": 4, "2008": 4, "long": 4, "noth": 4, "report": 4, "s": [4, 5, 6, 9, 13], "detect": [4, 6], "limit": [4, 6], "pule": 4, "repetit": 4, "prf": 4, "noise_z": 4, "ze_bin": 4, "hogan": 4, "2005": 4, "ze_std": 4, "ze_std_background": 4, "vm_bins_broad": 4, "figur": [4, 13], "7": [4, 5, 9], "vm_std_broad": [4, 6], "vm_std_broad_background": 4, "arctic": 4, "integr": [4, 6, 9, 12], "accureci": 4, "0": [4, 5, 6, 9, 11, 12, 13], "968": 4, "us": [4, 5, 6, 7, 9, 10, 11], "http": [4, 7, 9, 13], "doi": [4, 7, 9], "org": [4, 7, 9], "10": [4, 7, 9], "1175": 4, "jtech1768": 4, "jtech": 4, "d": [4, 9], "11": [4, 11], "00202": 4, "3389": 4, "frsen": 4, "860284": 4, "5194": [4, 7], "amt": [4, 7], "13": 4, "2363": 4, "eguspher": 4, "636": 4, "1109": 4, "tgr": 4, "2002030": 4, "radarbeam": 4, "file_earthcar": [4, 6, 9], "none": [4, 6], "sat_nam": [4, 6, 9], "nyquist_from_prf": [4, 6], "fals": [4, 6, 9], "sat_param": 4, "manag": 4, "specif": [4, 5, 7, 11, 12, 13], "user": [4, 5, 6, 8, 9, 11, 13], "specifi": [4, 8, 9], "space": [4, 13], "born": [4, 13], "It": [4, 7, 9], "also": [4, 5], "transform": [4, 6, 7, 12, 13], "attribut": [4, 5, 6, 7, 9], "param": 4, "print": [4, 5, 7, 11], "summari": [4, 7], "calculate_along_rang": 4, "range_coord": 4, "coordin": [4, 5, 6, 7, 13], "ground": [4, 5, 7, 9, 12, 13], "m": [4, 5, 6, 7, 11], "calculate_along_track": 4, "along_track_coord": 4, "calculate_ifov": 4, "instantan": [4, 12], "field": [4, 6, 12, 13], "view": [4, 5, 6, 12], "ifov": 4, "calculate_nyquist_veloc": 4, "nyquist": 4, "wavelength": 4, "calculate_velocity_error": 4, "error": [4, 6, 12, 13], "due": [4, 6, 13], "calculate_wavelength": 4, "calculate_weighting_funct": 4, "create_along_range_grid": 4, "creat": [4, 5, 7, 10, 11], "grid": [4, 5, 6, 7], "which": [4, 5, 6, 9, 13], "evalu": 4, "pulse_length": 4, "If": [4, 5, 7, 9], "equidist": 4, "cannot": 4, "create_along_track_grid": 4, "2": [4, 5, 9, 10, 11], "outermost": 4, "bin": [4, 6, 12], "rel": 4, "line": [4, 10, 11], "size": [4, 6], "alwai": [4, 5], "lie": 4, "within": [4, 6, 13], "static": [4, 5, 6, 7], "normalized_range_weighting_function_default": 4, "range_bin": 4, "normalized_range_weighting_function_earthcar": 4, "prepar": [4, 6, 9, 13], "high": [4, 6], "interpol": [4, 5, 6, 7], "return": [4, 5, 6, 7], "range_weight": 4, "normal": 4, "properti": [4, 7], "name": [4, 5, 6, 7, 8, 9, 11], "str": [4, 5, 8], "int": 4, "antenna_diamet": 4, "along_track_resolut": 4, "range_resolut": 4, "detection_limit": 4, "union": 4, "list": [4, 5, 6, 10], "ndarrai": 4, "nyquist_veloc": 4, "nan": [4, 6], "pulse_repetition_frequ": 4, "script": [5, 9], "read": 5, "data": [5, 6, 7, 10, 12], "convert_tim": 5, "ds": [5, 6, 7, 8], "time_vari": 5, "base_tim": 5, "factor": [5, 12], "time": [5, 6, 7, 9, 12, 13], "second": 5, "sinc": 5, "datetime64": [5, 7], "xarrai": [5, 6, 7, 8], "dataset": [5, 6, 7, 8, 9], "variabl": [5, 6, 7, 10], "string": 5, "e": [5, 7, 9, 11], "g": [5, 9], "1970": 5, "01": 5, "option": [5, 9, 13], "nanosecond": 5, "default": [5, 6], "read_cloudnet": 5, "attenuation_correction_input": 5, "date": [5, 7, 9], "site_nam": 5, "path": [5, 9], "add_dat": 5, "true": [5, 7, 9], "follow": [5, 6, 9, 11, 13], "file": [5, 6, 7, 8, 10, 13], "expect": [5, 13], "02": [5, 9], "14": [5, 9], "mindelo": [5, 9], "20220214_mindelo_ecmwf": 5, "nc": [5, 9], "20220214_mindelo_categor": 5, "product": [5, 7, 9, 12, 13], "either": [5, 9], "categor": [5, 7, 9], "ecmwf": [5, 7, 9], "np": [5, 6, 7], "site": [5, 9, 13], "should": [5, 6, 7, 9], "year": 5, "month": 5, "dai": [5, 7, 9], "subdirectori": 5, "bool": [5, 7], "ad": [5, 6, 7, 13], "toml": [5, 9], "configur": [5, 7, 10, 13], "check_config": 5, "check": [5, 6, 7, 9], "consist": [5, 6], "read_config": 5, "filenam": [5, 7, 8, 9], "dict": 5, "dictionari": 5, "all": [5, 6, 7, 9, 11, 13], "differ": [5, 6, 7], "format": [5, 10], "These": [5, 13], "wrap": 5, "pick": 5, "correct": [5, 6, 7, 9, 12], "depend": [5, 7, 11, 13], "final": [5, 7], "output": [5, 6, 7, 8, 9, 10], "an": [5, 9, 13], "reflect": [5, 6, 7, 9, 12, 13], "ze": [5, 6, 7, 13], "mm6": [5, 6, 7], "3": [5, 6, 7, 10, 11], "vm": [5, 6, 7, 13], "input": [5, 6, 7, 9, 12, 13], "doppler": [5, 6, 7, 12, 13], "neg": [5, 12, 13], "downward": 5, "motion": [5, 6, 12, 13], "posit": 5, "upward": 5, "chang": 5, "match": [5, 7], "spaceborn": [5, 6, 7], "convent": 5, "input_radar_format": [5, 7], "select": 5, "provid": [5, 9, 13], "perform": 5, "qualiti": [5, 12, 13], "import": [5, 9, 11], "convert_and_sort_tim": 5, "sort": 5, "get_all_fil": 5, "pattern": 5, "directori": [5, 8, 9, 11], "insid": [5, 7, 9], "make_date_path": 5, "structur": [5, 9, 10], "exist": 5, "otherwis": [5, 6], "regular": [5, 7], "without": [5, 6, 13], "extens": [5, 13], "read_arm": 5, "arm": [5, 13], "estim": [5, 6, 12, 13], "dbz": [5, 6, 7], "read_bco": 5, "netcdf": [5, 7, 8, 9], "rpg": [5, 13], "w": [5, 13], "band": 5, "precess": 5, "matlab": [5, 13], "uunivers": 5, "uoc": 5, "thei": 5, "correspond": 5, "level": [5, 6, 7, 9, 12], "version": [5, 9, 11], "process": [5, 9, 13], "note": [5, 6, 7], "onli": [5, 6, 7], "one": 5, "per": 5, "height": [5, 6, 7, 12], "alreadi": 5, "abov": [5, 6, 7, 12], "mean": [5, 6, 7, 9, 12], "sea": [5, 7, 12], "read_geom": 5, "fill": [5, 6, 13], "999": 5, "recogn": [5, 9], "read_mirac_p5": 5, "onboard": 5, "polar": [5, 9, 13], "5": [5, 6, 9, 10], "aircraft": [5, 9, 12], "read_pamtra": 5, "pamtra": 5, "point": [5, 12, 13], "locat": [5, 9], "attenu": [5, 7, 9, 12], "bottom": [5, 13], "up": [5, 11], "addition": 5, "ze_top_down": 5, "top": [5, 6, 13], "down": [5, 6], "ze_bottom_up": 5, "read_rasta": 5, "airborn": [5, 7, 9], "rasta": [5, 13], "onto": [5, 6, 7], "ga": [5, 7], "appli": [5, 6, 7, 13], "gaseous_twowayatt": 5, "horizont": [5, 6, 7, 12], "speed": 5, "flag": [5, 6, 12, 13], "first": [5, 7, 11, 13], "remov": 5, "nadir": 5, "last": 5, "gate": 5, "beyond": 5, "maximum": [5, 9], "possibl": [5, 13], "echo": [5, 7, 9, 13], "ghost": 5, "domain": 5, "6": [5, 9], "underground": 5, "signal": [5, 6, 12], "nois": [5, 6, 12, 13], "8": 5, "z": 5, "can": [5, 9, 11, 13], "flag_z_interpol": 5, "ac_spe": 5, "vertic": [5, 12], "read_uoc_v0": 5, "read_uoc_v1": 5, "spectra": 5, "improv": 5, "read_uoc_v2": 5, "remove_duplicate_tim": 5, "duplic": 5, "xr": [5, 6, 7], "status_messag": 5, "messag": 5, "while": 5, "cpr": [5, 9, 13], "rangewf": 5, "read_range_weighting_funct": 5, "revers": 5, "sign": 5, "wf": 5, "read_spaceview": 5, "run": [6, 7, 10, 11], "ms_threshold": [6, 9], "12": [6, 7], "ms_threshold_integr": [6, 9], "41": 6, "radar_spec": 6, "add_attribut": 6, "add": [6, 7, 9, 13], "add_nois": 6, "x_std": 6, "equat": [6, 7], "uncertainti": 6, "random": [6, 13], "dataarrai": [6, 7], "shape": 6, "equal": [6, 7], "x_nois": 6, "apply_detection_limit": 6, "var_z": 6, "var_oth": 6, "convolut": [6, 7], "other": 6, "mask": 6, "calculate_along_track_sat_bin_edg": 6, "edg": 6, "wai": 6, "equival": 6, "calculate_height_sat_bin_edg": 6, "calculate_ms_flag": 6, "multipl": [6, 9, 12, 13], "scatter": [6, 9, 12, 13], "occur": 6, "step": [6, 9, 11, 13], "certain": 6, "threshold": [6, 9, 13], "atmospher": 6, "toa": [6, 9], "surfac": [6, 9], "reach": 6, "critic": 6, "calculate_nubf": 6, "non": 6, "uniform": 6, "beam": 6, "standard": [6, 13], "deviat": 6, "volum": [6, 13], "current": 6, "express": 6, "indic": [6, 13], "mai": 6, "futur": 6, "reduc": 6, "calculate_nubf_flag": 6, "higher": 6, "than": 6, "calculate_signal_fract": 6, "fraction": [6, 12], "calculate_vm_bia": 6, "bia": [6, 13], "between": [6, 7, 9], "calculate_vm_bias_flag": 6, "absolut": [6, 9], "calculate_vm_nois": 6, "lookup": 6, "calculate_vm_std_nubf": 6, "outstand": 6, "bias": 6, "caus": 6, "gradient": 6, "direct": 6, "taken": 6, "15": 6, "divid": 6, "km": [6, 12], "set": [6, 7, 10, 11, 13], "befor": [6, 9, 13], "calculate_ze_nois": 6, "empti": 6, "accord": 6, "check_input_dataset": 6, "convolve_along_track": 6, "suborbit": [6, 7, 9, 13], "further": [6, 13], "convolve_height": 6, "fold_vm": 6, "fold": [6, 12, 13], "integrate_along_track": 6, "repres": 6, "footprint": 6, "given": [6, 13], "refer": [6, 9, 10], "center": 6, "kwd": 6, "plot_histogram": 6, "histogram": 6, "plot_scatt": 6, "prepare_input_dataset": 6, "comput": 6, "includ": [6, 7, 9, 13], "replac": 6, "zero": 6, "both": [6, 7], "entir": 6, "along_track": [6, 7, 12], "must": 6, "have": [6, 12], "vm_uncertainty_equ": 6, "vm_std_nubf": 6, "total": 6, "broaden": [6, 13], "orbitalradar": 7, "subclass": 7, "geometri": 7, "wind": [7, 9, 12], "flight": [7, 9], "vel": 7, "assum": 7, "lat": [7, 9], "lon": [7, 9], "config_fil": [7, 9], "suborbital_radar": 7, "short": 7, "add_airborne_vari": 7, "add_attenu": 7, "da_gas_atten": 7, "same": [7, 9], "add_ground_echo": 7, "artifici": 7, "chosen": 7, "after": [7, 9, 12], "here": [7, 13], "add_groundbased_vari": 7, "add_vmze_attr": 7, "attenuation_correct": [7, 9], "ds_cloudnet": 7, "gas_atten": 7, "137": 7, "era5": 7, "each": 7, "vari": 7, "therefor": [7, 13], "Then": [7, 11], "There": [7, 13], "major": 7, "cloudnet_ecmwf": 7, "cloudnet_categor": 7, "wrt": 7, "radar_gas_atten": 7, "94": [7, 13], "ghz": [7, 13], "check_is_sea_level": 7, "respect": 7, "convert_frequ": 7, "35": 7, "2019": [7, 9], "4949": 7, "mm3": 7, "measur": [7, 13], "now": 7, "correct_dielectric_const": 7, "dielectr": [7, 9], "constant": [7, 9], "k_g": 7, "k_": 7, "z_e": 7, "log_": 7, "left": 7, "frac": 7, "right": 7, "create_along_track": 7, "create_regular_along_track": 7, "create_regular_height": 7, "interpolate_to_regular_grid": 7, "prepare_d": 7, "start_dat": 7, "end_dat": 7, "start": [7, 10, 11, 12, 13], "end": [7, 9], "pd": 7, "datetimeindex": 7, "range_to_height": 7, "station": [7, 9], "write_output": [7, 9], "frame": 7, "inclus": 7, "run_dat": [7, 9], "singl": [7, 13], "write": [7, 8], "to_netcdf": 7, "store": [7, 9], "write_spaceview": 8, "successfulli": [9, 11], "instal": [9, 10, 13], "softwar": 9, "acquir": 9, "you": [9, 11, 13], "anoth": 9, "python": [9, 11, 13], "exampl": [9, 10], "under": 9, "ipynb": [9, 13], "One": 9, "cape": 9, "verd": 9, "april": [9, 13], "joyc": [9, 13], "j\u00fclich": [9, 13], "germani": [9, 13], "2021": [9, 13], "mirac": [9, 13], "A": [9, 13], "board": 9, "aflux": 9, "campaign": 9, "mech": 9, "1038": 9, "s41597": 9, "022": 9, "01900": 9, "sciebo": 9, "link": [9, 13], "pleas": [9, 11, 13], "unzip": 9, "orbital_radar_data": 9, "zip": 9, "archiv": 9, "your": [9, 11], "choic": 9, "lateron": 9, "we": 9, "necessari": 9, "templat": 9, "github": [9, 13], "copi": 9, "orbital_radar_config": 9, "root": 9, "packag": [9, 11, 12, 13], "renam": 9, "modifi": 9, "kei": 9, "keep": 9, "unchang": 9, "range_weighting_funct": 9, "cpr_pointtargetrespons": 9, "txt": 9, "min": 9, "folder": 9, "remain": 9, "To": [9, 11, 13], "streamlin": 9, "recommend": 9, "orbital_radar_config_path": 9, "env": [9, 11], "desir": 9, "altern": 9, "manual": 9, "export": 9, "them": 9, "allow": 9, "switch": 9, "easili": 9, "execut": 9, "flexibl": 9, "visual": 9, "tool": [9, 13], "demonstr": 9, "how": [9, 13], "initi": 9, "grb": 9, "written": 9, "gener": [9, 13], "automat": 9, "ora_0": 9, "2_earthcare_l1_groundbased_min_inoe94_20220214t000000_20220214t235959": 9, "inform": [9, 13], "ora": 9, "number": [9, 12], "l1": [9, 12, 13], "type": 9, "abbrev": 9, "inoe94": 9, "20220214t000000": 9, "20220214t235959": 9, "more": 9, "comprehens": 9, "come": 9, "upon": 9, "out": 9, "help": [9, 11], "syntax": 9, "n": [9, 11], "f": [9, 11], "via": 9, "might": 9, "In": 9, "case": [9, 13], "describ": 9, "detail": 9, "lowercas": 9, "k2": 9, "cloudnet_product": 9, "range_min": 9, "minimum": 9, "homogen": 9, "range_max": 9, "range_r": 9, "keep_tim": 9, "ground_echo_ze_max": 9, "ground_echo_pulse_length": 9, "artificu": 9, "mean_wind": [9, 12], "mean_flight_veloc": 9, "bco": 9, "mp5": 9, "affili": 9, "address": 9, "mail": 9, "email": 9, "longitud": 9, "latitud": 9, "alt": 9, "platform": 9, "overview": 10, "get": [10, 11, 13], "download": 10, "test": [10, 11, 13], "environ": [10, 11], "command": [10, 11], "interfac": [10, 11], "descript": [10, 12], "api": 10, "acknowledg": 10, "index": 10, "search": 10, "page": [10, 13], "new": [11, 13], "conda": 11, "activ": 11, "navig": 11, "pip": 11, "cd": 11, "python3": 11, "For": [11, 12], "purpos": 11, "edit": 11, "mode": 11, "dev": 11, "mac": 11, "verifi": 11, "ha": 11, "been": 11, "few": 11, "termin": 11, "__version__": 11, "onc": 11, "ve": 11, "complet": 11, "its": 11, "success": 11, "proce": 11, "section": [11, 13], "begin": 11, "need": [11, 13], "make": 11, "jupyt": 11, "lab": 11, "ipykernel": 11, "c": [11, 13], "forg": 11, "regist": 11, "kernel": 11, "observ": [12, 13], "perspect": 12, "sat_ifov": 12, "sat_range_resolut": 12, "sat_along_track_resolut": 12, "ze_sat": 12, "convolv": 12, "vm_sat": 12, "vm_sat_vel": 12, "ze_sat_nois": 12, "vm_sat_nois": 12, "vm_sat_fold": 12, "nubf_flag": 12, "ms_flag": 12, "distanc": 12, "meter": 12, "along_track_sat": 12, "range_sat": 12, "forward": 12, "present": [12, 13], "ccd": 12, "z_jsg": 12, "reflectivity_no_attenuation_correct": 12, "sampl": 12, "jsg": 12, "flagm": 12, "multiple_scatt": 12, "ing_statu": 12, "pixel": [12, 13], "cpr_height": 12, "v_d": 12, "u": 12, "doppler_velocity_best_estim": 12, "unfold": 12, "mi": 12, "doppler_velocity_uncorrect": 12, "control": 12, "preliminari": 12, "py": 13, "2024": 13, "air": 13, "synthet": 13, "mission": 13, "nasa": 13, "too": 13, "By": 13, "resampl": 13, "mimic": 13, "hardwar": 13, "free": 13, "addit": 13, "system": 13, "characterist": 13, "optic": 13, "handl": 13, "sever": 13, "larg": 13, "network": 13, "actri": 13, "portal": 13, "web": 13, "so": 13, "statist": 13, "robust": 13, "algorithm": 13, "cal": 13, "val": 13, "broad": 13, "commun": 13, "earth": 13, "metadata": 13, "geom": 13, "categoris": 13, "remot": 13, "sens": 13, "ac3": 13, "repositori": 13, "com": 13, "igmk": 13, "plane": 13, "awi": 13, "bremerhaven": 13, "falcon": 13, "lacmo": 13, "pari": 13, "franc": 13, "illustr": 13, "flowchart": 13, "workflow": 13, "explan": 13, "about": 13, "parametris": 13, "preper": 13, "show": 13, "6th": 13, "fourth": 13, "row": 13, "intermedi": 13, "well": 13, "bullet": 13, "explain": 13, "ax": 13, "axi": 13, "y": 13, "toward": 13, "hight": 13, "nufb": 13, "spectrum": 13, "std": 13, "nubf": 13, "ms": 13, "mimick": 13, "nom": 13, "cnom": 13, "document": 13, "see": 13, "schemat": 13, "sec": 13, "truth": 13, "choos": 13, "own": 13, "instruct": 13, "chapter": 13, "demo": 13, "notebook": 13, "togeth": 13}, "objects": {"orbital_radar": [[2, 0, 0, "-", "helpers"], [4, 0, 0, "-", "radarspec"], [6, 0, 0, "-", "simulator"], [7, 0, 0, "-", "suborbital"]], "orbital_radar.helpers": [[2, 1, 1, "", "db2li"], [2, 1, 1, "", "li2db"]], "orbital_radar.radarspec": [[4, 2, 1, "", "RadarBeam"], [4, 2, 1, "", "RadarSpec"]], "orbital_radar.radarspec.RadarBeam": [[4, 3, 1, "", "calculate_along_range"], [4, 3, 1, "", "calculate_along_track"], [4, 3, 1, "", "calculate_ifov"], [4, 3, 1, "", "calculate_nyquist_velocity"], [4, 3, 1, "", "calculate_velocity_error"], [4, 3, 1, "", "calculate_wavelength"], [4, 3, 1, "", "calculate_weighting_functions"], [4, 3, 1, "", "create_along_range_grid"], [4, 3, 1, "", "create_along_track_grid"], [4, 3, 1, "", "normalized_range_weighting_function_default"], [4, 3, 1, "", "normalized_range_weighting_function_earthcare"], [4, 4, 1, "", "params"]], "orbital_radar.readers": [[5, 0, 0, "-", "cloudnet"], [5, 0, 0, "-", "config"], [5, 0, 0, "-", "radar"], [5, 0, 0, "-", "rangewf"], [5, 0, 0, "-", "spaceview"]], "orbital_radar.readers.cloudnet": [[5, 1, 1, "", "convert_time"], [5, 1, 1, "", "read_cloudnet"]], "orbital_radar.readers.config": [[5, 1, 1, "", "check_config"], [5, 1, 1, "", "read_config"]], "orbital_radar.readers.radar": [[5, 2, 1, "", "Radar"]], "orbital_radar.readers.radar.Radar": [[5, 3, 1, "", "convert_and_sort_time"], [5, 3, 1, "", "get_all_files"], [5, 3, 1, "", "make_date_path"], [5, 3, 1, "", "read_arm"], [5, 3, 1, "", "read_bco"], [5, 3, 1, "", "read_cloudnet"], [5, 3, 1, "", "read_geoms"], [5, 3, 1, "", "read_mirac_p5"], [5, 3, 1, "", "read_pamtra"], [5, 3, 1, "", "read_rasta"], [5, 3, 1, "", "read_uoc_v0"], [5, 3, 1, "", "read_uoc_v1"], [5, 3, 1, "", "read_uoc_v2"], [5, 3, 1, "", "remove_duplicate_times"], [5, 3, 1, "", "status_message"]], "orbital_radar.readers.rangewf": [[5, 1, 1, "", "read_range_weighting_function"]], "orbital_radar.readers.spaceview": [[5, 1, 1, "", "read_spaceview"]], "orbital_radar.simulator": [[6, 2, 1, "", "Simulator"]], "orbital_radar.simulator.Simulator": [[6, 3, 1, "", "add_attributes"], [6, 3, 1, "", "add_noise"], [6, 3, 1, "", "apply_detection_limit"], [6, 3, 1, "", "calculate_along_track_sat_bin_edges"], [6, 3, 1, "", "calculate_height_sat_bin_edges"], [6, 3, 1, "", "calculate_ms_flag"], [6, 3, 1, "", "calculate_nubf"], [6, 3, 1, "", "calculate_nubf_flag"], [6, 3, 1, "", "calculate_signal_fraction"], [6, 3, 1, "", "calculate_vm_bias"], [6, 3, 1, "", "calculate_vm_bias_flag"], [6, 3, 1, "", "calculate_vm_noise"], [6, 3, 1, "", "calculate_vm_std_nubf"], [6, 3, 1, "", "calculate_ze_noise"], [6, 3, 1, "", "check_input_dataset"], [6, 3, 1, "", "convolve_along_track"], [6, 3, 1, "", "convolve_height"], [6, 3, 1, "", "fold_vm"], [6, 3, 1, "", "integrate_along_track"], [6, 3, 1, "", "plot"], [6, 3, 1, "", "plot_histogram"], [6, 3, 1, "", "plot_scatter"], [6, 3, 1, "", "prepare_input_dataset"], [6, 3, 1, "", "transform"], [6, 3, 1, "", "vm_uncertainty_equation"]], "orbital_radar.suborbital": [[7, 2, 1, "", "Suborbital"]], "orbital_radar.suborbital.Suborbital": [[7, 3, 1, "", "add_airborne_variables"], [7, 3, 1, "", "add_attenuation"], [7, 3, 1, "", "add_ground_echo"], [7, 3, 1, "", "add_groundbased_variables"], [7, 3, 1, "", "add_vmze_attrs"], [7, 3, 1, "", "attenuation_correction"], [7, 3, 1, "", "check_is_sea_level"], [7, 3, 1, "", "convert_frequency"], [7, 3, 1, "", "correct_dielectric_constant"], [7, 3, 1, "", "create_along_track"], [7, 3, 1, "", "create_regular_along_track"], [7, 3, 1, "", "create_regular_height"], [7, 3, 1, "", "interpolate_to_regular_grid"], [7, 3, 1, "", "prepare_dates"], [7, 3, 1, "", "range_to_height"], [7, 3, 1, "", "run"], [7, 3, 1, "", "run_date"], [7, 4, 1, "", "summary"], [7, 3, 1, "", "to_netcdf"]], "orbital_radar.writers": [[8, 0, 0, "-", "spaceview"]], "orbital_radar.writers.spaceview": [[8, 1, 1, "", "write_spaceview"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:property"}, "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"]}, "titleterms": {"acknowledg": 0, "api": 1, "refer": [1, 4], "helper": 2, "plot": 3, "along": 3, "track": 3, "radarspec": 4, "reader": 5, "cloudnet": 5, "config": 5, "radar": [5, 9, 10], "rang": 5, "weight": 5, "function": 5, "spaceview": [5, 8], "simul": [6, 9], "groundbas": 7, "writer": 8, "get": 9, "start": 9, "orbit": [9, 10], "download": 9, "test": 9, "data": [9, 13], "creat": 9, "configur": 9, "file": [9, 12], "set": 9, "environ": 9, "variabl": [9, 12], "run": 9, "command": 9, "line": 9, "interfac": 9, "descript": 9, "indic": 10, "tabl": 10, "instal": 11, "list": 12, "output": [12, 13], "overview": [12, 13], "width": 12, "25": 12, "75": 12, "header": 12, "row": 12, "1": [12, 13], "ze": 12, "correspond": 12, "c": 12, "pro": 12, "fmr": 12, "pdd": 12, "vm": 12, "cd": 12, "support": 13, "format": 13, "2": 13, "structur": 13, "code": 13, "3": 13, "exampl": 13, "4": 13, "5": 13, "us": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 56}})
\ No newline at end of file