Package beamformer.algorithms.nullalgo

Class NullBeamProvider

java.lang.Object

beamformer.algorithms.nullalgo.NullBeamProvider

All Implemented Interfaces:

BeamAlgorithmProvider

public class NullBeamProvider
extends Object
implements BeamAlgorithmProvider

Provider for the null beam former.

Author:

dg50

Constructor Summary

Constructors

Constructor	Description
NullBeamProvider()

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 params)	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 beamFormerProcess, BeamAlgorithmParams parameters, int firstSeqNum, int beamogramNum)	Create an instance of the algorithm for a set of channels.

Methods inherited from class java.lang.Object

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

Constructor Details

NullBeamProvider

public NullBeamProvider()

Method Details

getStaticProperties

public StaticAlgoProperties getStaticProperties()

Description copied from interface: BeamAlgorithmProvider

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

Specified by:

getStaticProperties in interface BeamAlgorithmProvider

Returns:

makeAlgorithm

public BeamFormerAlgorithm makeAlgorithm(BeamFormerBaseProcess beamFormerProcess,
 BeamAlgorithmParams parameters,
 int firstSeqNum,
 int beamogramNum)

Description copied from interface: BeamAlgorithmProvider

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

Specified by:

makeAlgorithm in interface BeamAlgorithmProvider

Parameters:

beamFormerProcess - 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

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

Description copied from interface: BeamAlgorithmProvider

Create an instance of the algorithm parameters

Specified by:

createNewParams in interface BeamAlgorithmProvider

Parameters:

algorithmName - the algorithm name

groupNumber - the group number

channelMap - channel map for channels used in this group

Returns:

getParamsDialog

public SettingsPane<?> getParamsDialog(BeamFormerParams overallParams,
 BeamAlgorithmParams params)

Description copied from interface: BeamAlgorithmProvider

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

Specified by:

getParamsDialog in interface BeamAlgorithmProvider

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.

params - the algorithm parameters to display in the dialog

Returns:

the dialog

getCurrentParams

public BeamAlgorithmParams getCurrentParams()

Description copied from interface: BeamAlgorithmProvider

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

Specified by:

getCurrentParams in interface BeamAlgorithmProvider

Returns: