Package beamformer.algorithms

Interface BeamAlgorithmProvider

All Known Implementing Classes:

BasicFreqDomBeamProvider, MVDRProvider, NullBeamProvider

public interface BeamAlgorithmProvider

Provider of beam former algorithms - may need > 1 algorithm object if channels are grouped into separate array sections, e.g. for crossed pair localisation.

Author:

dg50

Method Summary

Modifier and Type	Method	Description
BeamAlgorithmParams	createNewParams(String algorithmName, int groupNumber, int channelMap)	Create an instance of the algorithm parameters
BeamAlgorithmParams	getCurrentParams()	Retrieve the current set of parameters.
SettingsPane<?>	getParamsDialog(BeamFormerParams overallParams, BeamAlgorithmParams algoParams)	Return the algorithm-specific parameters dialog, populated with the parameters passed
StaticAlgoProperties	getStaticProperties()	Get fixed properties such as the algorithm name and whether it can output a beamogram
BeamFormerAlgorithm	makeAlgorithm(BeamFormerBaseProcess beamFormerBaseProcess, BeamAlgorithmParams parameters, int firstSeqNum, int beamogramNum)	Create an instance of the algorithm for a set of channels.

Method Details

getStaticProperties

StaticAlgoProperties getStaticProperties()

Get fixed properties such as the algorithm name and whether it can output a beamogram

Returns:

makeAlgorithm

BeamFormerAlgorithm makeAlgorithm(BeamFormerBaseProcess beamFormerBaseProcess,
 BeamAlgorithmParams parameters,
 int firstSeqNum,
 int beamogramNum)

Create an instance of the algorithm for a set of channels.

Parameters:

beamFormerBaseProcess - Beam former process

parameters - the parameters to use in this algorithm (provider will need to cast this to parameter type that matches the algorithm)

firstSeqNum - the sequence number to start with when numbering beams

beamogramNum - the sequence number of the beamogram

Returns:

new Beam Former Algorithm.

createNewParams

BeamAlgorithmParams createNewParams(String algorithmName,
 int groupNumber,
 int channelMap)

Create an instance of the algorithm parameters

Parameters:

algorithmName - the algorithm name

groupNumber - the group number

channelMap - channel map for channels used in this group

Returns:

getParamsDialog

SettingsPane<?> getParamsDialog(BeamFormerParams overallParams,
 BeamAlgorithmParams algoParams)

Return the algorithm-specific parameters dialog, populated with the parameters passed

Parameters:

overallParams - the current parameters used by the BeamformerSettingsPane object - contains the current source/group information for this settings GUI, and may not necessarily be the same as the parameters stored in the BeamFormerBaseControl object.

algoParams - the algorithm parameters to display in the dialog

Returns:

the dialog

getCurrentParams

BeamAlgorithmParams getCurrentParams()

Retrieve the current set of parameters. These will be the last parameters that were displayed in the dialog

Returns: