AUBELLHOP Python API Documentation

This is the aubellhop Python API documentation for Bellhop, an underwater acoustic propagation modeling toolbox.

Contents:

• Code reference
  • Main interfaces
  • File structure
• Environment class
  • Overview
  • Environment class
    • Environment
• Models class
  • Overview
  • Models class
    • Models
• Compute submodule
  • Overview
  • Compute submodel
    • compute_from_file()
    • compute()
    • compute_arrivals()
    • compute_eigenrays()
    • compute_rays()
    • compute_transmission_loss()
    • arrivals_to_impulse_response()
• Internal constants
  • Internal constants
    • FileExt
    • BHStrings
    • FlagMaps
    • ModelDefaults
    • MiscDefaults
    • EnvDefaults
• Default Values
  • ModelDefaults
  • EnvDefaults
  • MiscDefaults
• Reading from Bellhop text files
  • EnvironmentReader
    • EnvironmentReader.read()
  • read_ssp()
  • read_ssp_3d()
  • read_ati()
  • read_bty()
  • read_ati_3d()
  • read_bty_3d()
  • read_sbp()
  • read_brc()
  • read_trc()
  • read_arrivals()
  • read_rays()
  • read_shd()
  • BellhopOutputReader
    • BellhopOutputReader.read_arrivals()
    • BellhopOutputReader.read_shd()
    • BellhopOutputReader.read_rays()
• Writing Bellhop text files
  • EnvironmentWriter
    • EnvironmentWriter.write()
• Plotting Reference
  • Plotting functions (bokeh)
    • Any
    • Environment
    • BHStrings
    • figure
    • plot_env()
    • plot_ssp()
    • plot_arrivals()
    • plot_rays()
    • plot_transmission_loss()
  • Plotting utilities (bokeh)
    • theme()
    • figsize()
    • interactive()
    • enable_javascript()
    • use_static_images()
    • hold()
    • figure
    • many_figures
    • next_row()
    • next_column()
    • gcf()
    • plot()
    • scatter()
    • image()
    • vlines()
    • hlines()
    • text()
    • box()
    • color()
    • set_colors()
    • specgram()
    • psd()
    • iqplot()
    • freqz()
  • Plotting functions (matplotlib)
    • Any
    • BHStrings
    • Environment
    • pyplot_env2d()
    • pyplot_env3d()
    • pyplot_ssp()
    • pyplot_arrivals()
    • pyplot_rays()
    • pyplot_transmission_loss()
• All package functions
  • read_ssp()
  • read_ssp_3d()
  • read_ati()
  • read_bty()
  • read_sbp()
  • read_trc()
  • read_brc()
  • read_rays()
  • read_arrivals()
  • Environment
    • Environment.name
    • Environment._from_file
    • Environment.dimension
    • Environment._dimension
    • Environment.frequency
    • Environment._num_media
    • Environment.soundspeed
    • Environment.soundspeed_interp
    • Environment._mesh_npts
    • Environment._depth_sigma
    • Environment._depth_max
    • Environment._range_max
    • Environment._bathymetry
    • Environment._altimetry
    • Environment._sbp_file
    • Environment.bottom_depth
    • Environment.bottom_interp
    • Environment._bottom_depth
    • Environment.bottom_soundspeed
    • Environment._bottom_soundspeed_shear
    • Environment.bottom_density
    • Environment.bottom_attenuation
    • Environment._bottom_attenuation_shear
    • Environment.bottom_roughness
    • Environment.bottom_beta
    • Environment.bottom_transition_freq
    • Environment.bottom_boundary_condition
    • Environment.bottom_reflection_coefficient
    • Environment.bottom_grain_size
    • Environment.surface_depth
    • Environment.surface_interp
    • Environment.surface_boundary_condition
    • Environment.surface_reflection_coefficient
    • Environment.surface_soundspeed
    • Environment._surface_soundspeed_shear
    • Environment.surface_density
    • Environment.surface_attenuation
    • Environment._surface_attenuation_shear
    • Environment._surface_min
    • Environment.surface_min
    • Environment.source_type
    • Environment.source_range
    • Environment.source_cross_range
    • Environment.source_depth
    • Environment.source_ndepth
    • Environment.source_nrange
    • Environment.source_ncrossrange
    • Environment.source_directionality
    • Environment._source_num
    • Environment.receiver_depth
    • Environment.receiver_range
    • Environment.receiver_bearing
    • Environment.receiver_ndepth
    • Environment.receiver_nrange
    • Environment.receiver_nbearing
    • Environment._receiver_num
    • Environment.beam_type
    • Environment.beam_angle_min
    • Environment.beam_angle_max
    • Environment.beam_bearing_min
    • Environment.beam_bearing_max
    • Environment.beam_num
    • Environment.beam_bearing_num
    • Environment.single_beam_index
    • Environment._single_beam
    • Environment.beam_width_type
    • Environment.beam_reflection_curvature_change
    • Environment.beam_reflection_shift
    • Environment.beam_epsilon_multipler
    • Environment.beam_range_loop
    • Environment.beam_images_num
    • Environment.beam_window
    • Environment.beam_component
    • Environment.simulation_depth
    • Environment.simulation_range
    • Environment.simulation_cross_range
    • Environment.simulation_depth_scale
    • Environment.simulation_range_scale
    • Environment.simulation_cross_range_scale
    • Environment.simulation_cross_range_min
    • Environment.step_size
    • Environment.grid_type
    • Environment.task
    • Environment.interference_mode
    • Environment.volume_attenuation
    • Environment.attenuation_units
    • Environment.biological_layer_parameters
    • Environment._fg_salinity
    • Environment._fg_temperature
    • Environment._fg_pH
    • Environment._fg_depth
    • Environment.comment_pad
    • Environment.from_file()
    • Environment.from_dict()
    • Environment.to_file()
    • Environment.reset()
    • Environment.defaults()
    • Environment.to_dict()
    • Environment.copy()
    • Environment.unwrap()
    • Environment.set_fg_attenuation()
    • Environment.check()
    • Environment._finalise()
    • Environment._float_or_default()
    • Environment._check_env_header()
    • Environment._check_env_surface()
    • Environment._check_env_depth()
    • Environment._check_env_ssp()
    • Environment._check_env_source()
    • Environment._check_env_beam()
    • Environment._abc_impl
  • Models
    • Models._models
    • Models.init()
    • Models.reset()
    • Models.new()
    • Models.supported()
    • Models.get()
    • Models.select()
  • compute_from_file()
  • compute()
  • compute_rays()
  • compute_eigenrays()
  • compute_arrivals()
  • compute_transmission_loss()
  • arrivals_to_impulse_response()
  • demo()

Indices and tables

• Index

• Module Index

• Search Page