Package beamformer.algorithms.basicFreqDomain

Class BasicFreqDomBeam

java.lang.Object

beamformer.algorithms.BeamInformation

beamformer.algorithms.basicFreqDomain.BasicFreqDomBeam

public class BasicFreqDomBeam
extends BeamInformation

Author:

mo55

Constructor Summary

Constructors

Constructor	Description
BasicFreqDomBeam(BasicFreqDomBeamFormer beamformer, int channelMap, int sequenceNum, PamVector beamVec, PamVector[] elementLocs, int[] channelList, double[] weights, double[] freqBins, double speedOfSound)	Main Constructor.

Method Summary

Modifier and Type	Method	Description
void	clearChannelOrderList()	clear the list of channel orders
int	getChannelMap()
int	getSequenceMap()
ComplexArray	process(FFTDataUnit[] fftDataUnits)	Process a set of FFTDataUnit objects using the preset frequency bin range
ComplexArray	process(FFTDataUnit[] fftDataUnits, int startBin, int endBin)	Process a set of FFTDataUnit objects using a given frequency bin range.
void	setWeights(double[] weights)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicFreqDomBeam

public BasicFreqDomBeam(BasicFreqDomBeamFormer beamformer,
 int channelMap,
 int sequenceNum,
 PamVector beamVec,
 PamVector[] elementLocs,
 int[] channelList,
 double[] weights,
 double[] freqBins,
 double speedOfSound)

Main Constructor.

Parameters:

beamformer - The BasicFreqDomBeamFormer creating this beam

channelMap - a bitmap indicating which channels are part of this group

sequenceNum - the sequence number of this beam

beamVec - A PamVector describing this beam direction

elementLocs - an array of PamVectors giving the hydrophone element X,Y,Z locations, one PamVector for each element in this group

channelList - a list of channels in this beam. Note that the order of the list MUST MATCH the order of the locations in elementLocs

weights - an array of double values, one for each element in this group.

freqBins - an array of frequencies to calculate the steering vector over

speedOfSound - the speed of sound in the water

Method Details

process

public ComplexArray process(FFTDataUnit[] fftDataUnits)

Process a set of FFTDataUnit objects using the preset frequency bin range

Parameters:

fftDataUnits - the group of FFTDataUnits to analyse

Returns:

complex array of summed beamformed data. Note that the size of the array is the number of frequency bins in the full frequency range, as specified by the user in the parameters GUI

process

public ComplexArray process(FFTDataUnit[] fftDataUnits,
 int startBin,
 int endBin)

Process a set of FFTDataUnit objects using a given frequency bin range.

Parameters:

fftDataUnits - the group of FFTDataUnits to analyse

startBin - first bin to process

endBin - last bin to process (not inclusive, so endBin can equal fftLength/2)

Returns:

complex array of summed beamformed data. Note that the size of the array is the number of frequency bins in the full frequency range, as specified by the user in the parameters GUI, even if only a portion of that range was actually processed

getChannelMap

public int getChannelMap()

Returns:

the channelMap

getSequenceMap

public int getSequenceMap()

Returns:

the sequenceMap

setWeights

public void setWeights(double[] weights)

Parameters:

weights - the weights to set

clearChannelOrderList

public void clearChannelOrderList()

clear the list of channel orders