Engee documentation

EngeePhased.OmnidirectionalMicrophoneElement

Omnidirectional acoustic element.

*Library: EngeePhased

Description

The EngeePhased.OmnidirectionalMicrophoneElement object models an acoustic element with an omnidirectional pattern.

To calculate the response of an acoustic element for the specified directions, follow the steps below:

  1. Create an EngeePhased.OmnidirectionalMicrophoneElement object and set its properties.

  2. Call the object with arguments as if it were a function.

Constructor

  • microphone = phased.OmnidirectionalMicrophoneElement creates an omnidirectional acoustic element, microphone, with the properties of the system object by default.

  • microphone = phased.OmnidirectionalMicrophoneElement(Name=Value) creates an omnidirectional acoustic element, microphone, with each specified property Name (name) set to the specified Value (value). You can specify additional arguments as a name-value pair in any order (Name1,Value1,…​,NameN,ValueN).

    • *Example: microphone = EngeePhased.OmnidirectionalMicrophoneElement(FrequencyRange=[0 1000],BackBaffled=true) creates an acoustic element with a reflector whose frequency range is specified between 0 and 1000 Hz.

  • RESP = microphone(FREQ,ANG) returns the amplitude response of the acoustic element, RESP, at the frequencies specified in the FREQ arguments and the directions specified in the ANG argument.

Properties

FrequencyRange - the range of operating frequencies
[0 1e20] (by default) | ` non-negative real vector of strings 1 by 2`

The operating frequency range of the acoustic element, specified as a non-negative real vector of 1 by 2 rows in the form [LowerBound HigherBound]. The acoustic element has no response outside the specified frequency range.

The units of measurement are Hz.

Data types: Float64.

BackBaffled - back reflector of the Backbaffle acoustic element
false (by default) | true

The Backbaffle property for the acoustic element is set as false or true.

Set this property to true to remove the response from the rear hemisphere of the antenna element. In this case, the antenna response to all azimuth angles greater than ±90° from the broadside (0° in azimuth and 0° in elevation) is zero.

When the value of this property is `false', the back side of the antenna element has no deflector.

Data types: logical.

Arguments

Input

FREQ - operating frequency of the acoustic element
vector of positive values in line 1 on P

Signal frequencies specified as a vector of positive values in line 1 on P.

The units of measurement are Hz.

Data types: Float64.

ANG - azimuthal and altitude angles of response directions
real vector 1 on Q | real matrix 2 on Q

Azimuthal and altitude angles of the answer directions given as a real vector of lines 1 on Q or a real matrix 2 on Q, where Q is the number of angular directions.

The units of measurement are degrees.

The azimuth angle must lie in the range from -180° to 180° inclusive. Elevation angle shall lie in the range from -90° to 90° inclusive.

If ANG is a vector 1 on Q, each element specifies an azimuthal angle of direction. In this case, the corresponding elevation angle is assumed to be zero.

If ANG is a matrix 2 on Q, each column of the matrix specifies a direction in the form [azimuth;elevation].

The azimuth angle is the angle between the x-axis and the projection of the direction vector onto the xy plane. This angle is positive when measured from the x-axis towards the y-axis. Elevation angle is the angle between the direction vector and the xy plane. This angle is positive when measured in the z-axis direction.

Data types: Float64.

Output

RESP - antenna amplitude response
complex matrix Q on P

The voltage response of the antenna element, returned as a complex matrix Q on Q. In this matrix, Q is the number of angles specified in the ANG argument and P is the number of frequencies specified in the FREQ argument.

Data types: Float64.

Methods

Common for all system objects

step!

Start the algorithm of the system object

release!

Allow changing the value of the system object property

reset!

Reset internal states of the system object