Package beamformer.algorithms.mvdr

Class MVDRalgorithm

java.lang.Object
beamformer.algorithms.mvdr.MVDRalgorithm
All Implemented Interfaces:
BeamFormerAlgorithm
public class MVDRalgorithm extends Object implements BeamFormerAlgorithm
The algorithm class for the Minimum Variance Distortionless Response beamformer.
Author:
mo55

  • Field Details

    • chanOrder

      protected int[] chanOrder
      The order of channels in the incoming FFT data units array

  • Constructor Details

    • MVDRalgorithm

      public MVDRalgorithm(MVDRProvider mvdrProvider, BeamFormerBaseProcess beamFormerProcess, MVDRParams mvdrParams, int firstSeqNum, int beamogramNum)
      Parameters:
      mvdrProvider -
      beamFormerProcess -
      mvdrParams -
      firstSeqNum -
      beamogramNum -

  • Method Details

    • prepare

      public void prepare()
      Description copied from interface: BeamFormerAlgorithm
      Prepare the algorithm. Gets called just before it starts. It's here that steering vectors, etc. should get calculated.
      Specified by:
      prepare in interface BeamFormerAlgorithm

    • process

      public void process(FFTDataUnit[] fftDataUnits)
      Process an array of FFTDataUnits. The size of the array will equal the number of channels in this beam group
      Specified by:
      process in interface BeamFormerAlgorithm
      Parameters:
      fftDataUnits - array of FFT data units.

    • getChannelOrder

      protected void getChannelOrder(FFTDataUnit[] fftDataUnits)
      loop over the number of channels and determine the order of the hydrophones in the FFTDataUnits object. Create a look up table to match the order of hydrophones in the fftDataUnits array to the order in the steeringVecs array
      Parameters:
      fftDataUnits -

    • clearChannelOrderList

      public void clearChannelOrderList()
      clear the list of channel orders

    • getNumBeams

      public int getNumBeams()
      Description copied from interface: BeamFormerAlgorithm
      Get the number of output beams
      Specified by:
      getNumBeams in interface BeamFormerAlgorithm
      Returns:
      number of output beams

    • getNumBeamogramAngles

      public int getNumBeamogramAngles()
      Description copied from interface: BeamFormerAlgorithm
      Get the number of angles used in the beamogram calculation. Note that at the moment all beamograms must use the same angles in order be able to add their data to the common PamDataBlock. The BasicFreqDomParams object defines the beamogram angles as from 0 deg to 180 deg in 2 degree steps (91 angles total). This should be matched in all other algorithms capable of creating beamograms, until changes can be made to accomodate different PamDataUnit sizes in the same PamDataBlock.
      Specified by:
      getNumBeamogramAngles in interface BeamFormerAlgorithm
      Returns:
      the number of angles used in the beamogram calculation

    • getBeamInformation

      public BeamInformation getBeamInformation(int iBeam)
      Description copied from interface: BeamFormerAlgorithm
      Get information about a specific beam. I've currently no idea whatsoever what information we're going to include here !
      Specified by:
      getBeamInformation in interface BeamFormerAlgorithm
      Parameters:
      iBeam -
      Returns:

    • thereIsABeamogram

      public boolean thereIsABeamogram()
      Description copied from interface: BeamFormerAlgorithm
      Boolean indicating whether a beamOgram should be created (true) or not (false)
      Specified by:
      thereIsABeamogram in interface BeamFormerAlgorithm
      Returns:

    • getBeamProcess

      public BeamFormerBaseProcess getBeamProcess()
      Returns:
      the beamProcess

    • setKeepFrequencyInformation

      public void setKeepFrequencyInformation(boolean keep)
      Description copied from interface: BeamFormerAlgorithm
      Tell the algorithm to keep frequency information in beamOGram output.
      Specified by:
      setKeepFrequencyInformation in interface BeamFormerAlgorithm
      Parameters:
      keep -

    • setFrequencyBinRange

      public void setFrequencyBinRange(int binFrom, int binTo)
      Description copied from interface: BeamFormerAlgorithm
      Set a frequency bin range for the BeamOGram analysis.
      Beam forming will take place between binFrom to binTo.
      (Not inclusive - so binTo can equal fftLength/2 process loop is for (int i = binFrom; i invalid input: '<' bnTo; i++)).
      Specified by:
      setFrequencyBinRange in interface BeamFormerAlgorithm
      Parameters:
      binFrom - first bin to process
      binTo - last bin to process