kwave.reconstruction.beamform module¶
- envelope_detection(signal)[source]¶
envelopeDetection applies the Hilbert transform to extract the envelope from an input vector x. If x is a matrix, the envelope along the last axis.
- Parameters:
signal
- Return type:
signal_envelope
- focus(kgrid, input_signal, source_mask, focus_position, sound_speed)[source]¶
focus Create input signal based on source mask and focus position. focus takes a single input signal and a source mask and creates an input signal matrix (with one input signal for each source point). The appropriate time delays required to focus the signals at a given position in Cartesian space are automatically added based on the user inputs for focus_position and sound_speed.
- Parameters:
kgrid – k-Wave grid object returned by kWaveGrid
input_signal – single time series input
source_mask – matrix specifying the positions of the time varying source distribution (i.e., source.p_mask or source.u_mask)
focus_position – position of the focus in Cartesian coordinates
sound_speed – scalar sound speed
- Returns:
matrix of time series following the source points
- Return type:
input_signal_mat