Library Reference

• Radarx Accessors
  • radarx.accessors.create_radarx_dataarray_accessor
    • create_radarx_dataarray_accessor()
• Radarx Core
  • Radarx Conversion
    • radarx.core.conversion.meters_to_kilometers
      • meters_to_kilometers()
    • radarx.core.conversion.kilometers_to_meters
      • kilometers_to_meters()
    • radarx.core.conversion.meters_to_miles
      • meters_to_miles()
    • radarx.core.conversion.miles_to_meters
      • miles_to_meters()
    • radarx.core.conversion.hz_to_mhz
      • hz_to_mhz()
    • radarx.core.conversion.mhz_to_hz
      • mhz_to_hz()
    • radarx.core.conversion.hz_to_ghz
      • hz_to_ghz()
    • radarx.core.conversion.ghz_to_hz
      • ghz_to_hz()
    • radarx.core.conversion.wavelength_to_frequency
      • wavelength_to_frequency()
    • radarx.core.conversion.frequency_to_wavelength
      • frequency_to_wavelength()
    • radarx.core.conversion.microseconds_to_seconds
      • microseconds_to_seconds()
    • radarx.core.conversion.seconds_to_microseconds
      • seconds_to_microseconds()
    • radarx.core.conversion.mps_to_kph
      • mps_to_kph()
    • radarx.core.conversion.kph_to_mps
      • kph_to_mps()
    • radarx.core.conversion.mps_to_knots
      • mps_to_knots()
    • radarx.core.conversion.knots_to_mps
      • knots_to_mps()
    • radarx.core.conversion.degrees_to_radians
      • degrees_to_radians()
    • radarx.core.conversion.radians_to_degrees
      • radians_to_degrees()
    • radarx.core.conversion.celsius_to_kelvin
      • celsius_to_kelvin()
    • radarx.core.conversion.kelvin_to_celsius
      • kelvin_to_celsius()
    • radarx.core.conversion.meters_to_feet
      • meters_to_feet()
    • radarx.core.conversion.feet_to_meters
      • feet_to_meters()
    • radarx.core.conversion.seconds_to_minutes
      • seconds_to_minutes()
    • radarx.core.conversion.minutes_to_seconds
      • minutes_to_seconds()
    • radarx.core.conversion.kelvin_to_fahrenheit
      • kelvin_to_fahrenheit()
    • radarx.core.conversion.fahrenheit_to_kelvin
      • fahrenheit_to_kelvin()
    • radarx.core.conversion.megahertz_to_si
      • megahertz_to_si()
    • radarx.core.conversion.si_to_megahertz
      • si_to_megahertz()
    • radarx.core.conversion.gigahertz_to_si
      • gigahertz_to_si()
    • radarx.core.conversion.si_to_gigahertz
      • si_to_gigahertz()
    • radarx.core.conversion.kilometers_to_si
      • kilometers_to_si()
    • radarx.core.conversion.si_to_kilometers
      • si_to_kilometers()
    • radarx.core.conversion.miles_to_si
      • miles_to_si()
    • radarx.core.conversion.si_to_miles
      • si_to_miles()
    • radarx.core.conversion.microseconds_to_si
      • microseconds_to_si()
    • radarx.core.conversion.si_to_microseconds
      • si_to_microseconds()
    • radarx.core.conversion.minutes_to_si
      • minutes_to_si()
    • radarx.core.conversion.si_to_minutes
      • si_to_minutes()
    • radarx.core.conversion.celsius_to_si
      • celsius_to_si()
    • radarx.core.conversion.si_to_celsius
      • si_to_celsius()
    • radarx.core.conversion.fahrenheit_to_si
      • fahrenheit_to_si()
    • radarx.core.conversion.si_to_fahrenheit
      • si_to_fahrenheit()
• Radar Fundmentals
  • Attenuation and Scattering Coefficients
    • radarx.fundamentals.attenuation.absorption_coefficient
      • absorption_coefficient()
    • radarx.fundamentals.attenuation.extinction_coefficient
      • extinction_coefficient()
    • radarx.fundamentals.attenuation.k_complex
      • k_complex()
    • radarx.fundamentals.attenuation.scattering_coefficient
      • scattering_coefficient()
  • Beam Geometry and Resolution
    • radarx.fundamentals.beam.azimuthal_resolution
      • azimuthal_resolution()
    • radarx.fundamentals.beam.beamwidth_to_radians
      • beamwidth_to_radians()
    • radarx.fundamentals.beam.compute_azimuth_resolution
      • compute_azimuth_resolution()
    • radarx.fundamentals.beam.compute_beamwidth
      • compute_beamwidth()
    • radarx.fundamentals.beam.compute_volume_resolution
      • compute_volume_resolution()
    • radarx.fundamentals.beam.volume_resolution
      • volume_resolution()
  • Common Utilities
    • radarx.fundamentals.common.dbz_from_z
      • dbz_from_z()
    • radarx.fundamentals.common.dbz_to_z
      • dbz_to_z()
    • radarx.fundamentals.common.ensure_positive
      • ensure_positive()
    • radarx.fundamentals.common.kts_to_mps
      • kts_to_mps()
    • radarx.fundamentals.common.kts_to_si
      • kts_to_si()
    • radarx.fundamentals.common.km_to_m
      • km_to_m()
    • radarx.fundamentals.common.km_to_si
      • km_to_si()
    • radarx.fundamentals.common.kilometers_to_meters
      • kilometers_to_meters()
    • radarx.fundamentals.common.kilometers_to_si
      • kilometers_to_si()
    • radarx.fundamentals.common.linearize_dbz
      • linearize_dbz()
    • radarx.fundamentals.common.m_to_km
      • m_to_km()
    • radarx.fundamentals.common.meters_to_kilometers
      • meters_to_kilometers()
    • radarx.fundamentals.common.mps_to_kts
      • mps_to_kts()
    • radarx.fundamentals.common.mps_to_knots
      • mps_to_knots()
    • radarx.fundamentals.common.si_to_kilometers
      • si_to_kilometers()
    • radarx.fundamentals.common.si_to_km
      • si_to_km()
    • radarx.fundamentals.common.si_to_kts
      • si_to_kts()
    • radarx.fundamentals.common.z_to_dbz
      • z_to_dbz()
  • Constants
    • radarx.fundamentals.constants.C
      • C
    • radarx.fundamentals.constants.DBZ_TO_Z_FACTOR
      • DBZ_TO_Z_FACTOR
    • radarx.fundamentals.constants.DIELECTRIC_ICE
      • DIELECTRIC_ICE
    • radarx.fundamentals.constants.DIELECTRIC_WATER
      • DIELECTRIC_WATER
    • radarx.fundamentals.constants.EARTH_RADIUS
      • EARTH_RADIUS
    • radarx.fundamentals.constants.EFFECTIVE_RADIUS_4_3
      • EFFECTIVE_RADIUS_4_3
    • radarx.fundamentals.constants.K_BOLTZMANN
      • K_BOLTZMANN
    • radarx.fundamentals.constants.RADAR_BANDS
      • RADAR_BANDS
    • radarx.fundamentals.constants.T_STANDARD
      • T_STANDARD
    • radarx.fundamentals.constants.TYPICAL_BEAMWIDTH
      • TYPICAL_BEAMWIDTH
    • radarx.fundamentals.constants.TYPICAL_PULSE_WIDTHS
      • TYPICAL_PULSE_WIDTHS
    • radarx.fundamentals.constants.Z_TO_DBZ_FACTOR
      • Z_TO_DBZ_FACTOR
  • Doppler Radar Calculations
    • radarx.fundamentals.doppler.doppler_dilemma
      • doppler_dilemma()
    • radarx.fundamentals.doppler.doppler_frequency_shift
      • doppler_frequency_shift()
    • radarx.fundamentals.doppler.dual_prf_velocity
      • dual_prf_velocity()
    • radarx.fundamentals.doppler.max_frequency
      • max_frequency()
    • radarx.fundamentals.doppler.nyquist_velocity
      • nyquist_velocity()
    • radarx.fundamentals.doppler.unambiguous_range
      • unambiguous_range()
    • radarx.fundamentals.doppler._doppler_shift_basic
      • _doppler_shift_basic()
    • radarx.fundamentals.doppler._doppler_shift_exact
      • _doppler_shift_exact()
    • radarx.fundamentals.doppler._doppler_shift_relativistic
      • _doppler_shift_relativistic()
  • Radar Geometry Calculations
    • radarx.fundamentals.geometry.beam_center_height
      • beam_center_height()
    • radarx.fundamentals.geometry.effective_radius
      • effective_radius()
    • radarx.fundamentals.geometry.half_power_radius
      • half_power_radius()
    • radarx.fundamentals.geometry.sample_volume_gaussian
      • sample_volume_gaussian()
  • Radar Power Calculations
    • radarx.fundamentals.power.compute_average_power
      • compute_average_power()
    • radarx.fundamentals.power.compute_min_detectable_signal
      • compute_min_detectable_signal()
    • radarx.fundamentals.power.compute_peak_power
      • compute_peak_power()
  • Radar Principles
    • radarx.fundamentals.principles.compute_doppler_shift
      • compute_doppler_shift()
    • radarx.fundamentals.principles.compute_nyquist_velocity
      • compute_nyquist_velocity()
    • radarx.fundamentals.principles.compute_range_resolution
      • compute_range_resolution()
    • radarx.fundamentals.principles.compute_snr
      • compute_snr()
    • radarx.fundamentals.principles.doppler_frequency_shift
      • doppler_frequency_shift()
    • radarx.fundamentals.principles.radar_range
      • radar_range()
    • radarx.fundamentals.principles.range_resolution
      • range_resolution()
    • radarx.fundamentals.principles.round_trip_time
      • round_trip_time()
    • radarx.fundamentals.principles.snr
      • snr()
  • Reflectivity-Based Retrievals
    • radarx.fundamentals.reflectivity.dbz_attenuation_correction
      • dbz_attenuation_correction()
    • radarx.fundamentals.reflectivity.z_to_r_custom
      • z_to_r_custom()
    • radarx.fundamentals.reflectivity.z_to_r_marshall_palmer
      • z_to_r_marshall_palmer()
  • Rayleigh Scattering Approximations
    • radarx.fundamentals.scattering.backscatter_cross_section
      • backscatter_cross_section()
    • radarx.fundamentals.scattering.normalized_backscatter_cross_section
      • normalized_backscatter_cross_section()
    • radarx.fundamentals.scattering.size_parameter
      • size_parameter()
    • radarx.fundamentals.scattering.absorption_coefficient
      • absorption_coefficient()
    • radarx.fundamentals.scattering.scattering_coefficient
      • scattering_coefficient()
    • radarx.fundamentals.scattering.extinction_coefficient
      • extinction_coefficient()
  • Radar System Characteristics
  • Timing Calculations
    • radarx.fundamentals.timing.compute_blind_range
      • compute_blind_range()
    • radarx.fundamentals.timing.compute_duty_cycle
      • compute_duty_cycle()
    • radarx.fundamentals.timing.compute_max_unambiguous_range
      • compute_max_unambiguous_range()
    • radarx.fundamentals.timing.compute_max_unambiguous_velocity
      • compute_max_unambiguous_velocity()
    • radarx.fundamentals.timing.compute_prf
      • compute_prf()
    • radarx.fundamentals.timing.compute_pulse_repetition_interval
      • compute_pulse_repetition_interval()
  • Radar-Derived Variables
    • radarx.fundamentals.variables.reflectivity_factor
      • reflectivity_factor()
    • radarx.fundamentals.variables.differential_reflectivity
      • differential_reflectivity()
    • radarx.fundamentals.variables.linear_depolarization_ratio
      • linear_depolarization_ratio()
    • radarx.fundamentals.variables.circular_depolarization_ratio
      • circular_depolarization_ratio()
    • radarx.fundamentals.variables.radial_velocity
      • radial_velocity()
• Radarx Grid
  • Radarx Grid
    • radarx.grid.grid.stack_data
      • stack_data()
    • radarx.grid.grid.make_3d_grid
      • make_3d_grid()
    • radarx.grid.grid.grid_radar
      • grid_radar()
• Radarx IO
  • IMD Reader
    • radarx.io.imd.read_sweep
      • read_sweep()
    • radarx.io.imd.read_volume
      • read_volume()
    • radarx.io.imd.to_cfradial2
      • to_cfradial2()
    • radarx.io.imd.to_cfradial2_volumes
      • to_cfradial2_volumes()
  • AWS Radar Data Utilities
    • Supported Buckets
    • Usage Examples
      • radarx.io.aws_data.get_s3_client
      • radarx.io.aws_data.list_available_files
      • radarx.io.aws_data.download_file
• Radarx Retrieval
  • CAPPI Retrieval
    • radarx.retrieve.cappi.create_cappi
      • create_cappi()
• Testing
• Radarx Utils
  • radarx.utils.get_geocoords
    • get_geocoords()
  • radarx.utils.cartesian_to_geographic_aeqd
    • cartesian_to_geographic_aeqd()
  • radarx.utils.find_multidim_vars
    • find_multidim_vars()
  • radarx.utils.combine_nexrad_sweeps
    • combine_nexrad_sweeps()
• Radarx Visualization
  • radarx.vis.maxcappi.plot_maxcappi
    • plot_maxcappi()
  • Radarx Plot Helpers
    • radarx.vis.plots.plot_cappi
      • plot_cappi()
    • radarx.vis.plots.plot_ppi
      • plot_ppi()
    • radarx.vis.plots.plot_rhi
      • plot_rhi()