MicAIAABenchmark#

class acoular.aiaa.aiaa.MicAIAABenchmark

Bases: MicGeom

Provides the geometric arrangement of microphones in the array.

In contrast to standard Acoular microphone geometries, the AIAA benchmark format includes the array geometry as metadata in the file containing the measurement data.

file

Name of the .h5-file from which to read the data.

export_mpos(filename)

Export the microphone positions to an XML file.

This method generates an XML file containing the positions of all valid microphones in the array. Each microphone is represented by a <pos> element with Name, x, y, and z attributes. The generated XML is formatted to match the structure required for importing into the MicGeom class.

Parameters:
filenamestr

The path to the file to which the microphone positions will be written. The file extension must be .xml.

Raises:
OSError

If the file cannot be written due to permissions issues or invalid file paths.

Notes

  • The file will be saved in UTF-8 encoding.

  • The Name attribute for each microphone is set as "Point {i+1}", where i is the index of the microphone.

  • This method only exports the positions of the valid microphones (those not listed in invalid_channels).

  • All coordinates (x, y, z) are exported in meters by default (see here).

pos_total

Array containing the x, y, z positions of all microphones, including invalid ones, shape (3, num_mics ). This is set automatically when file changes or explicitly by assigning an array of floats. All coordinates are in meters by default (see here).

pos

Array containing the x, y, z positions of valid microphones (i.e., excluding those in invalid_channels), shape (3, num_mics ). (read-only) All coordinates are in meters by default (see here).

invalid_channels

List of indices indicating microphones to be excluded from calculations and results. Default is [].

num_mics

Number of valid microphones in the array. (read-only)

center

The geometric center of the array, calculated as the arithmetic mean of the positions of all valid microphones. (read-only)

aperture

The maximum distance between any two valid microphones in the array. (read-only)

digest

A unique identifier for the geometry, based on its properties. (read-only)