kwave package

Subpackages

• kWaveSimulation_helper
  • Submodules
    • create_absorption_variables
      • apply_alpha_filter()
      • compute_absorbing_coeff()
      • compute_dispersive_coeff()
      • create_absorbing_medium_variables()
      • create_absorption_variables()
      • create_stokes_medium_variables()
      • get_absorbtion()
      • get_dispersion()
    • display_simulation_params
      • display_simulation_params()
      • get_min_sound_speed()
      • print_grid_size()
      • print_max_supported_freq()
    • expand_grid_matrices
      • calculate_expand_size()
      • expand_cuboid_corner_list()
      • expand_directivity_angle()
      • expand_grid_matrices()
      • expand_kgrid()
      • expand_medium()
      • expand_pressure_sources()
      • expand_sensor()
      • expand_source()
      • expand_stress_sources()
      • expand_velocity_sources()
      • print_grid_size()
    • retract_transducer_grid_size
      • retract_transducer_grid_size()
    • save_to_disk_func
      • enforce_filename_standards()
      • grab_axisymmetric_variables()
      • grab_elastic_code_variables()
      • grab_float_variables()
      • grab_integer_variables()
      • grab_medium_props()
      • grab_nonuniform_grid_props()
      • grab_pml_size()
      • grab_pressure_source_props()
      • grab_sensor_props()
      • grab_source_props()
      • grab_stress_source_props()
      • grab_time_varying_source_props()
      • grab_velocity_source_props()
      • remove_z_dimension()
      • save_file()
      • save_h5_file()
      • save_mat_file()
      • save_to_disk_func()
    • scale_source_terms_func
      • apply_pressure_source_correction()
      • apply_source_correction()
      • apply_velocity_source_corrections()
      • check_conditions()
      • scale_pressure_source()
      • scale_pressure_source_dirichlet()
      • scale_pressure_source_nonuniform_grid()
      • scale_pressure_source_uniform_grid()
      • scale_source_terms_func()
      • scale_stress_source()
      • scale_stress_sources()
      • scale_transducer_source()
      • scale_velocity_source()
      • scale_velocity_source_nonuniform()
      • scale_velocity_source_x()
      • scale_velocity_sources()
    • set_sound_speed_ref
      • get_kspace_elastic_sound_speed_ref()
      • get_ordinary_sound_speed_ref()
      • get_pstd_elastic_sound_speed_ref()
      • set_sound_speed_ref()
  • Module contents
• reconstruction
  • Submodules
    • kwave.reconstruction.beamform module
      • envelope_detection()
      • focus()
      • scan_conversion()
    • kwave.reconstruction.converter module
    • kwave.reconstruction.shifted_transform module
    • kwave.reconstruction.tools module
      • apodize()
      • db()
      • log_compression()
      • make_time_vector()
  • Module contents
    • TimeReversal
      • TimeReversal.__init__()
• utils
  • Submodules
    • kwave.utils.checks module
      • check_alpha_mode_cpp_compatible()
      • check_divisible()
      • check_factors()
      • check_field_names()
      • check_stability()
      • check_str_eq()
      • check_str_in()
      • enforce_fields()
      • enforce_fields_obj()
      • is_number()
      • is_unix()
      • warn_alpha_power_near_unity_cpp()
    • kwave.utils.colormap module
      • bone()
      • get_color_map()
      • gray()
      • hot()
    • kwave.utils.conversion module
      • cart2grid()
      • cart2pol()
      • cast_to_type()
      • create_index_at_dim()
      • db2neper()
      • find_closest()
      • freq2wavenumber()
      • grid2cart()
      • hounsfield2density()
      • hounsfield2soundspeed()
      • neper2db()
      • tol_star()
    • kwave.utils.data module
      • get_date_string()
      • get_smallest_possible_type()
      • intmax()
      • scale_SI()
      • scale_time()
    • kwave.utils.dotdictionary module
      • dotdict
    • kwave.utils.filters module
      • apply_filter()
      • extract_amp_phase()
      • filter_time_series()
      • fwhm()
      • gaussian_filter()
      • single_sided_correction()
      • smooth()
      • spect()
    • kwave.utils.interp module
      • get_bli()
      • get_delta_bli()
      • interp_cart_data()
      • interpftn()
      • interpolate2d()
      • interpolate2d_with_queries()
      • interpolate3d()
    • kwave.utils.io module
      • assign_str_attr()
      • get_h5_literals()
      • load_image()
      • write_attributes()
      • write_flags()
      • write_grid()
      • write_matrix()
    • kwave.utils.mapgen module
      • compute_linear_transform2D()
      • create_pixel_dim()
      • fit_power_law_params()
      • focused_annulus_oneil()
      • focused_bowl_oneil()
      • get_spaced_points()
      • make_arc()
      • make_ball()
      • make_bowl()
      • make_cart_arc()
      • make_cart_bowl()
      • make_cart_circle()
      • make_cart_disc()
      • make_cart_rect()
      • make_cart_sphere()
      • make_cart_spherical_segment()
      • make_circle()
      • make_disc()
      • make_line()
      • make_multi_arc()
      • make_multi_bowl()
      • make_pixel_map()
      • make_pixel_map_plane()
      • make_pixel_map_point()
      • make_sphere()
      • make_spherical_section()
      • ndgrid()
      • power_law_kramers_kronig()
      • trim_cart_points()
      • water_absorption()
      • water_density()
      • water_non_linearity()
      • water_sound_speed()
    • kwave.utils.math module
      • Rx()
      • Ry()
      • Rz()
      • compute_linear_transform()
      • compute_rotation_between_vectors()
      • cosd()
      • find_closest()
      • fourier_shift()
      • gaussian()
      • get_affine_matrix()
      • largest_prime_factor()
      • make_affine()
      • next_pow2()
      • phase_shift_interpolate()
      • primefactors()
      • round_even()
      • round_odd()
      • rwh_primes()
      • sinc()
      • sind()
    • kwave.utils.matrix module
      • broadcast_axis()
      • expand_matrix()
      • gradient_fd()
      • max_nd()
      • min_nd()
      • num_dim()
      • num_dim2()
      • resize()
      • revolve2d()
      • sort_rows()
      • trim_zeros()
    • kwave.utils.pml module
      • get_optimal_pml_size()
      • get_pml()
    • kwave.utils.signals module
      • add_noise()
      • calc_max_freq()
      • create_cw_signals()
      • get_alpha_filter()
      • get_wave_number()
      • get_win()
      • gradient_spect()
      • reorder_binary_sensor_data()
      • reorder_sensor_data()
      • tone_burst()
      • unmask_sensor_data()
    • kwave.utils.tictoc module
      • TicToc
  • Module contents

Submodules

• data
  • FlexibleVector
    • FlexibleVector.__init__()
    • FlexibleVector.append()
    • FlexibleVector.assign_dim()
    • FlexibleVector.data
    • FlexibleVector.numpy()
    • FlexibleVector.x
    • FlexibleVector.y
    • FlexibleVector.z
  • Vector
    • Vector.__new__()
    • Vector.append()
    • Vector.assign_dim()
    • Vector.x
    • Vector.y
    • Vector.z
• enums
  • AlphaMode
    • AlphaMode.NO_ABSORPTION
    • AlphaMode.NO_DISPERSION
    • AlphaMode.STOKES
    • AlphaMode.__new__()
  • DiscreteCosine
    • DiscreteCosine.TYPE_1
    • DiscreteCosine.TYPE_2
    • DiscreteCosine.TYPE_3
    • DiscreteCosine.TYPE_4
  • DiscreteSine
    • DiscreteSine.TYPE_1
    • DiscreteSine.TYPE_2
    • DiscreteSine.TYPE_3
    • DiscreteSine.TYPE_4
• executor
  • Executor
    • Executor.__init__()
    • Executor.parse_executable_output()
    • Executor.run_simulation()
• kWaveSimulation
  • kWaveSimulation
    • kWaveSimulation.COLOR_MAP
    • kWaveSimulation.ESTIMATE_SIM_TIME_STEPS
    • kWaveSimulation.HIGHEST_PRIME_FACTOR_WARNING
    • kWaveSimulation.KSPACE_CFL
    • kWaveSimulation.LOG_NAME
    • kWaveSimulation.PSTD_CFL
    • kWaveSimulation.SOURCE_P_MODE_DEF
    • kWaveSimulation.SOURCE_S_MODE_DEF
    • kWaveSimulation.SOURCE_U_MODE_DEF
    • kWaveSimulation.STREAM_TO_DISK_FILENAME
    • kWaveSimulation.__init__()
    • kWaveSimulation.absorb_eta
    • kWaveSimulation.absorb_nabla1
    • kWaveSimulation.absorb_nabla2
    • kWaveSimulation.absorb_tau
    • kWaveSimulation.assign_pseudonyms()
    • kWaveSimulation.binary_sensor_mask
    • kWaveSimulation.blank_sensor
    • kWaveSimulation.c0
    • kWaveSimulation.check_calling_func_name_and_dim()
    • kWaveSimulation.check_input_combinations()
    • kWaveSimulation.check_kgrid_time()
    • kWaveSimulation.check_medium()
    • kWaveSimulation.check_sensor()
    • kWaveSimulation.check_source()
    • kWaveSimulation.check_time_reversal()
    • kWaveSimulation.compute_directivity
    • kWaveSimulation.create_absorption_vars()
    • kWaveSimulation.create_pml_indices()
    • kWaveSimulation.create_sensor_variables()
    • kWaveSimulation.cuboid_corners
    • kWaveSimulation.delay_mask
    • kWaveSimulation.dt
    • kWaveSimulation.elastic_time_rev
    • kWaveSimulation.equation_of_state
    • kWaveSimulation.input_checking()
    • kWaveSimulation.kelvin_voigt_model
    • kWaveSimulation.nonuniform_grid
    • kWaveSimulation.p_source_pos_index
    • kWaveSimulation.print_start_status()
    • kWaveSimulation.reorder_data
    • kWaveSimulation.rho0
    • kWaveSimulation.s_source_pos_index
    • kWaveSimulation.scale_source_terms()
    • kWaveSimulation.select_precision()
    • kWaveSimulation.set_index_data_type()
    • kWaveSimulation.smooth_and_enlarge()
    • kWaveSimulation.source_p
    • kWaveSimulation.source_p0
    • kWaveSimulation.source_p0_elastic
    • kWaveSimulation.source_p_labelled
    • kWaveSimulation.source_s_labelled
    • kWaveSimulation.source_sxx
    • kWaveSimulation.source_sxy
    • kWaveSimulation.source_sxz
    • kWaveSimulation.source_syy
    • kWaveSimulation.source_syz
    • kWaveSimulation.source_szz
    • kWaveSimulation.source_u_labelled
    • kWaveSimulation.source_ux
    • kWaveSimulation.source_uy
    • kWaveSimulation.source_uz
    • kWaveSimulation.time_rev
    • kWaveSimulation.transducer_receive_elevation_focus
    • kWaveSimulation.transducer_sensor
    • kWaveSimulation.transducer_source
    • kWaveSimulation.u_source_pos_index
    • kWaveSimulation.use_sensor
    • kWaveSimulation.use_w_source_correction_p
    • kWaveSimulation.use_w_source_correction_u
• kWaveGrid
  • kWaveGrid
    • kWaveGrid.CFL_DEFAULT
    • kWaveGrid.MACHINE_PRECISION
    • kWaveGrid.N
    • kWaveGrid.Nt
    • kWaveGrid.Nx
    • kWaveGrid.Ny
    • kWaveGrid.Nz
    • kWaveGrid.__init__()
    • kWaveGrid.dim
    • kWaveGrid.dt
    • kWaveGrid.dudn
    • kWaveGrid.dudn_sg
    • kWaveGrid.dx
    • kWaveGrid.dy
    • kWaveGrid.dz
    • kWaveGrid.highest_prime_factors()
    • kWaveGrid.k
    • kWaveGrid.k_dtt()
    • kWaveGrid.k_max
    • kWaveGrid.k_max_all
    • kWaveGrid.k_vec
    • kWaveGrid.kx
    • kWaveGrid.kx_vec_dtt()
    • kWaveGrid.ky
    • kWaveGrid.ky_vec_dtt()
    • kWaveGrid.kz
    • kWaveGrid.kz_vec_dtt()
    • kWaveGrid.makeDTTDim()
    • kWaveGrid.makeDim()
    • kWaveGrid.makeTime()
    • kWaveGrid.n_vec
    • kWaveGrid.n_vec_sg
    • kWaveGrid.nonuniform
    • kWaveGrid.setNUGrid()
    • kWaveGrid.setTime()
    • kWaveGrid.size
    • kWaveGrid.spacing
    • kWaveGrid.t_array
    • kWaveGrid.total_grid_points
    • kWaveGrid.x
    • kWaveGrid.x_size
    • kWaveGrid.x_vec
    • kWaveGrid.xn
    • kWaveGrid.y
    • kWaveGrid.y_size
    • kWaveGrid.y_vec
    • kWaveGrid.yn
    • kWaveGrid.z
    • kWaveGrid.z_size
    • kWaveGrid.z_vec
    • kWaveGrid.zn
• kWaveMedium
  • kWaveMedium
    • kWaveMedium.BonA
    • kWaveMedium.__init__()
    • kWaveMedium.absorbing
    • kWaveMedium.alpha_coeff
    • kWaveMedium.alpha_coeff_compression
    • kWaveMedium.alpha_coeff_shear
    • kWaveMedium.alpha_filter
    • kWaveMedium.alpha_mode
    • kWaveMedium.alpha_power
    • kWaveMedium.alpha_sign
    • kWaveMedium.check_fields()
    • kWaveMedium.density
    • kWaveMedium.ensure_defined()
    • kWaveMedium.is_defined()
    • kWaveMedium.is_nonlinear()
    • kWaveMedium.set_absorbing()
    • kWaveMedium.sound_speed
    • kWaveMedium.sound_speed_compression
    • kWaveMedium.sound_speed_ref
    • kWaveMedium.sound_speed_ref_compression
    • kWaveMedium.sound_speed_ref_shear
    • kWaveMedium.sound_speed_shear
    • kWaveMedium.stokes
• kSensor
  • kSensor
    • kSensor.__init__()
    • kSensor.expand_grid()
    • kSensor.mask
    • kSensor.record_start_index
    • kSensor.time_reversal_boundary_data
  • kSensorDirectivity
    • kSensorDirectivity.__init__()
    • kSensorDirectivity.angle
    • kSensorDirectivity.pattern
    • kSensorDirectivity.set_default_size()
    • kSensorDirectivity.set_unique_angles()
    • kSensorDirectivity.set_wavenumbers()
    • kSensorDirectivity.size
    • kSensorDirectivity.unique_angles
    • kSensorDirectivity.wavenumbers
• kSource
  • kSource
    • kSource.__init__()
    • kSource.flag_ux
    • kSource.flag_uy
    • kSource.flag_uz
    • kSource.is_p0_empty()
    • kSource.p
    • kSource.p0
    • kSource.p_frequency_ref
    • kSource.p_mask
    • kSource.p_mode
    • kSource.s_mask
    • kSource.s_mode
    • kSource.sxx
    • kSource.sxy
    • kSource.sxz
    • kSource.syy
    • kSource.syz
    • kSource.szz
    • kSource.u_frequency_ref
    • kSource.u_mask
    • kSource.u_mode
    • kSource.ux
    • kSource.uy
    • kSource.uz
    • kSource.validate()
• kwave.kspaceFirstOrder module
  • kspaceFirstOrder()
  • reshape_to_grid()
• kspaceFirstOrder2D
  • kspaceFirstOrder2D()
  • kspaceFirstOrder2DC()
  • kspace_first_order_2d_gpu()
• kspaceFirstOrder3D
  • kspaceFirstOrder3D()
  • kspaceFirstOrder3DC()
  • kspaceFirstOrder3DG()
• kspaceFirstOrderAS
  • kspaceFirstOrderAS()
  • kspaceFirstOrderASC()
• kTransducer
  • NotATransducer
    • NotATransducer.__init__()
    • NotATransducer.active_elements_mask
    • NotATransducer.all_elements_mask
    • NotATransducer.appended_zeros
    • NotATransducer.beamforming_delays
    • NotATransducer.beamforming_delays_offset
    • NotATransducer.combine_sensor_data()
    • NotATransducer.delay_mask()
    • NotATransducer.elevation_beamforming_delays
    • NotATransducer.elevation_beamforming_mask
    • NotATransducer.expand_grid()
    • NotATransducer.get_receive_apodization()
    • NotATransducer.get_transmit_apodization()
    • NotATransducer.grid_size
    • NotATransducer.indexed_active_elements_mask
    • NotATransducer.indexed_elements_mask
    • NotATransducer.input_signal
    • NotATransducer.isfield()
    • NotATransducer.mask
    • NotATransducer.number_active_elements
    • NotATransducer.retract_grid()
    • NotATransducer.scan_line()
    • NotATransducer.steering_angle
    • NotATransducer.steering_angle_max
    • NotATransducer.transmit_apodization_mask
  • kWaveTransducerSimple
    • kWaveTransducerSimple.__init__()
    • kWaveTransducerSimple.element_pitch
    • kWaveTransducerSimple.transducer_width
  • make_pos_int()
• options
  • SimulationExecutionOptions
    • SimulationExecutionOptions.backend
    • SimulationExecutionOptions.__init__()
    • SimulationExecutionOptions.as_list()
    • SimulationExecutionOptions.backend
    • SimulationExecutionOptions.binary_dir
    • SimulationExecutionOptions.binary_name
    • SimulationExecutionOptions.binary_path
    • SimulationExecutionOptions.checkpoint_file
    • SimulationExecutionOptions.checkpoint_interval
    • SimulationExecutionOptions.checkpoint_timesteps
    • SimulationExecutionOptions.device_num
    • SimulationExecutionOptions.env_vars
    • SimulationExecutionOptions.get_options_string()
    • SimulationExecutionOptions.is_gpu_simulation
    • SimulationExecutionOptions.is_python_backend
    • SimulationExecutionOptions.num_threads
    • SimulationExecutionOptions.num_threads_explicit
    • SimulationExecutionOptions.verbose_level
  • SimulationOptions
    • SimulationOptions.__init__()
    • SimulationOptions.cart_interp
    • SimulationOptions.cartesian_interp
    • SimulationOptions.create_log
    • SimulationOptions.data_cast
    • SimulationOptions.data_path
    • SimulationOptions.data_recast
    • SimulationOptions.hdf_compression_level
    • SimulationOptions.input_filename
    • SimulationOptions.multi_axial_PML_ratio
    • SimulationOptions.option_factory()
    • SimulationOptions.output_filename
    • SimulationOptions.pml_alpha
    • SimulationOptions.pml_auto
    • SimulationOptions.pml_inside
    • SimulationOptions.pml_search_range
    • SimulationOptions.pml_size
    • SimulationOptions.pml_x_alpha
    • SimulationOptions.pml_x_size
    • SimulationOptions.pml_y_alpha
    • SimulationOptions.pml_y_size
    • SimulationOptions.pml_z_alpha
    • SimulationOptions.pml_z_size
    • SimulationOptions.radial_symmetry
    • SimulationOptions.save_to_disk
    • SimulationOptions.save_to_disk_exit
    • SimulationOptions.scale_source_terms
    • SimulationOptions.simulation_type
    • SimulationOptions.smooth_c0
    • SimulationOptions.smooth_p0
    • SimulationOptions.smooth_rho0
    • SimulationOptions.stream_to_disk
    • SimulationOptions.use_fd
    • SimulationOptions.use_finite_difference
    • SimulationOptions.use_kspace
    • SimulationOptions.use_sg
• recorder
  • Recorder
    • Recorder.I
    • Recorder.I_avg
    • Recorder.__init__()
    • Recorder.get_allowed_flags()
    • Recorder.is_set()
    • Recorder.p
    • Recorder.p_final
    • Recorder.p_max
    • Recorder.p_max_all
    • Recorder.p_min
    • Recorder.p_min_all
    • Recorder.p_rms
    • Recorder.set_flags_from_list()
    • Recorder.set_index_variables()
    • Recorder.u
    • Recorder.u_final
    • Recorder.u_max
    • Recorder.u_max_all
    • Recorder.u_min
    • Recorder.u_min_all
    • Recorder.u_non_staggered
    • Recorder.u_rms
    • Recorder.u_split_field

Module contents

binaries_present()

Check if binaries are present :returns: bool, True if binaries are present, False otherwise

Return type:

bool

download_binaries(system_os, bin_type)

Download binary from release url :param system_os: string, current system type :param bin_type: string of “OMP” or “CUDA”

Returns:

None

Parameters:

• system_os (str)

• bin_type (str)

get_windows_release_urls(architecture)

Parameters:

architecture (str)

Return type:

list

install_binaries()