contains the TxArray class

example usage:

world.tx_array = handybeam.tx_array_library.rectilinear(parent = world)
class handybeam.tx_array.TxArray(parent=None)[source]

Describes the transmitter array

Primarily holds the tx_array_element_descriptor


(numpy.array) compact buffer describing the array. See tx_element_array_descriptor_a


(string). user-readable string/descriptor



Parameters:parent – handybeam.world.World set to current world instance.

links to self.__str__()

Returns:basic information about this array

information about this array.

Returns:basic information about this array

Helper function for RememberInstanceCreationInfo

Returns:raises an error if the object’s data is not found

return count of transmiter elements in this array.

does return self.tx_array_element_descriptor.shape[0]



generate_tx_array_element(x: float = 0.0, y: float = 0.0, z: float = 0.0, xnormal: float = 0.0, ynormal: float = 0.0, znormal: float = 1.0, directivity_phase_poly1_c1: float = 0.0, directivity_amplitude_poly2_c0: float = 318.5, directivity_amplitude_poly2_c1: float = -682.4, directivity_amplitude_poly2_c2: float = 461.33, amplitude_ratio_setting: float = 1.0, phase_setting: float = 0.0)[source]

builds a single line of tx_element_array_descriptor_a buffer out of provided named parameters.

Please note that the directivity defaults are set to match the murata transducer.

In order to generate an ominidirectional transducer with a reference amplitude of “1” - set directivity_phase_poly1_c1 to 0.0, directivity_amplitude_poly2_c0 to 1.0, directivity_amplitude_poly2_c1 to 0.0, and directivity_amplitude_poly2_c2 to 0.0

  • x (float) – DESCRIPTION HERE
  • y (float) – DESCRIPTION HERE
  • z (float) – DESCRIPTION HERE
  • xnormal (float) – DESCRIPTION HERE
  • ynormal (float) – DESCRIPTION HERE
  • znormal (float) – DESCRIPTION HERE
  • directivity_phase_poly1_c1 (float) – DESCRIPTION HERE
  • directivity_amplitude_poly2_c0 (float) – DESCRIPTION HERE
  • directivity_amplitude_poly2_c1 (float) – DESCRIPTION HERE
  • directivity_amplitude_poly2_c2 (float) – DESCRIPTION HERE
  • amplitude_ratio_setting (float) – DESCRIPTION HERE
  • phase_setting (float) – DESCRIPTION HERE

helper method of RememberInstanceCreationInfo

Returns:prints the debug data
visualise(figsize=(4, 3), dpi=150)[source]

Run the visualizer.

Run the handybeam.visualise.visualise_flat_tx_array().

Note: runs the visualizer on the array that is attached to the parent of this array. So might be misleading sometimes.

Back to Welcome

Licence (documentation): Creative Commons CC BY-NC-SA 4.0

Licence (source code): Apache 2.0

EU logo

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 737087.

This project has received funding from Ultrahaptics.

Ultrahaptics logo