Interface DirectivitySphere

All Known Implementing Classes:
DiscreteDirectivitySphere, OmnidirectionalDirection, RailwayCnossosDirectivitySphere, TrainAttenuation

public interface DirectivitySphere
Interface that returns the attenuation in dB due to a specific directivity pattern.
Author:
Nicolas Fortin, Université Gustave Eiffel
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    coverFrequency(double frequency)
     
    double
    getAttenuation(double frequency, double phi, double theta)
    Returns the attenuation in dB due to a particular frequency of the directivity pattern at a given angle (phi, theta)
    double[]
    getAttenuationArray(double[] frequencies, double phi, double theta)
    Returns the attenuation in dB of the directivity pattern at a given angle (phi, theta).
  • Method Details

    • getAttenuation

      double getAttenuation(double frequency, double phi, double theta)
      Returns the attenuation in dB due to a particular frequency of the directivity pattern at a given angle (phi, theta)
      Parameters:
      frequency - Frequency in Hertz
      phi - (0 2π) with 0 is front
      theta - (-π/2 π/2) with 0 is horizontal; π is top
      Returns:
      Attenuation in dB
    • getAttenuationArray

      double[] getAttenuationArray(double[] frequencies, double phi, double theta)
      Returns the attenuation in dB of the directivity pattern at a given angle (phi, theta).
      Parameters:
      frequencies - Frequency array in Hertz (same order will be returned)
      phi - (0 2π) 0 is front
      theta - (-π/2 π/2) 0 is horizontal π is top
      Returns:
      Attenuation in dB for each frequency
    • coverFrequency

      boolean coverFrequency(double frequency)
      Parameters:
      frequency - Frequency in Hertz
      Returns:
      True if this sphere is capable of producing an attenuation for this frequency