Package beamformer.localiser

Class BeamFormLocaliserControl

java.lang.Object

PamController.PamControlledUnit

beamformer.BeamFormerBaseControl

beamformer.localiser.BeamFormLocaliserControl

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class BeamFormLocaliserControl
extends BeamFormerBaseControl
implements PamSettings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	unitType

Constructor Summary

Constructors

Constructor	Description
BeamFormLocaliserControl(String unitName)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addDownstreamLocalisationContents(int localisationContents)	This gets called when the output datablock has more localisation content options added to it (e.g.
boolean	beamFormDataUnit(PamDataUnit pamDataUnit)	Run the beam former within the given time-frequency box.
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
BeamFormerParams	getBeamFormerParams()
BeamLocaliserObservable	getBeamLocaliserObservable()	Return an observable which will get updates as beam forming takes place can be used to update graphics, etc.
BFAnnotationType	getBfAnnotationType()
BFDetectionMonitor	getBfDetectionMonitor()
BFLocaliserParams	getBfLocaliserParams()
QueuedDataBlock	getQueuedDataBlock()
Serializable	getSettingsReference()
long	getSettingsVersion()
void	newTriggerData(PamDataUnit pamDataUnit)
void	notifyModelChanged(int changeType)	General notification when the PAMGAURD model changes.
boolean	removeUnit()	Called to remove a unit.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setBeamFormerParams(BeamFormerParams beamFormerParams)

Methods inherited from class beamformer.BeamFormerBaseControl

findAlgorithmByName, getAlgorithmList, getBeamFormerProcess, setBeamFormerProcess

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGUI, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setupControlledUnit, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitType

Methods inherited from interface PamController.SettingsNameProvider

getUnitName

Field Details

unitType

public static final String unitType

See Also:

• Constant Field Values

Constructor Details

BeamFormLocaliserControl

@Deprecated
public BeamFormLocaliserControl(String unitName)

Deprecated.

Method Details

removeUnit

public boolean removeUnit()

Description copied from class: PamControlledUnit

Called to remove a unit.

Overrides:

removeUnit in class PamControlledUnit

Returns:

try (not used)

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamControlledUnit

General notification when the PAMGAURD model changes.

Overrides:

notifyModelChanged in class PamControlledUnit

Parameters:

changeType - type of change

getBfLocaliserParams

public BFLocaliserParams getBfLocaliserParams()

Returns:

the bfLocaliserParams

createDetectionMenu

public JMenuItem createDetectionMenu(Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:

createDetectionMenu in class PamControlledUnit

Parameters:

parentFrame - The owner frame of the menu

Returns:

reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getBeamFormerParams

public BeamFormerParams getBeamFormerParams()

Overrides:

getBeamFormerParams in class BeamFormerBaseControl

Returns:

the beamFormerParams

setBeamFormerParams

public void setBeamFormerParams(BeamFormerParams beamFormerParams)

Overrides:

setBeamFormerParams in class BeamFormerBaseControl

Parameters:

beamFormerParams - the beamFormerParams to set

newTriggerData

public void newTriggerData(PamDataUnit pamDataUnit)

getQueuedDataBlock

public QueuedDataBlock getQueuedDataBlock()

Returns:

the queuedDataBlock

beamFormDataUnit

public boolean beamFormDataUnit(PamDataUnit pamDataUnit)

Run the beam former within the given time-frequency box.

Parameters:

timeRange -

freqRange -

markChannels -

getBeamLocaliserObservable

public BeamLocaliserObservable getBeamLocaliserObservable()

Return an observable which will get updates as beam forming takes place can be used to update graphics, etc.

Returns:

the beamLocaliserObservable

getBfDetectionMonitor

public BFDetectionMonitor getBfDetectionMonitor()

Returns:

the bfDetectionMonitor

getBfAnnotationType

public BFAnnotationType getBfAnnotationType()

Returns:

the bfAnnotationType

addDownstreamLocalisationContents

public void addDownstreamLocalisationContents(int localisationContents)

This gets called when the output datablock has more localisation content options added to it (e.g. from the crossed bearing localiser). We need to pass this information on to the trigger data source so that it can update it's own list, thereby making itself available to displays, etc.

Parameters:

localisationContents -