Package beamformer.algorithms

Class BeamAlgoParamsPane

java.lang.Object

PamController.SettingsPane<BeamAlgorithmParams>

beamformer.algorithms.BeamAlgoParamsPane

Direct Known Subclasses:

BasicFreqDomParamsPane2, MVDRParamsPane2

public class BeamAlgoParamsPane
extends SettingsPane<BeamAlgorithmParams>

Author:

mo55

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BeamAlgoParamsPane.BeamgramStatus
class	BeamAlgoParamsPane.BeamInfo	Inner class, containing beam information for each beam in the spreadsheet

Constructor Summary

Constructors

Constructor	Description
BeamAlgoParamsPane(Object window, BeamFormerBaseControl beamFormerControl2)

Method Summary

Modifier and Type	Method	Description
BeamAlgoParamsPane.BeamgramStatus	checkBeamogramStatus()	Test whether the beamogram data is valid.
javafx.scene.Node	createBeamListPane()	Create the pane holding the list of beams
javafx.scene.Node	createBeamPatternPane()
void	createDefaults()	Create a list of default beams, evenly spread between 0 and 180 degrees.
javafx.scene.Node	getContentNode()	Get node for GUI change of settings.
AcousticDataBlock	getDataSource()
String	getName()	Get the name of the pane.
BeamAlgorithmParams	getParams(BeamAlgorithmParams p)	Take settings from the pane and save them into the parameters object
void	paneInitialized()	Called when settings pane is first initialised.
void	prepareConstants()	Get the current hydrophone locations, and set the field vector elementLocs
void	setAngleRange()	Sets the valid angle range, based on the array shape
void	setArrayTypeLables()
void	setBeamogramData()	Fills in the data on the beamogram tab, or clears it
void	setDataSource(AcousticDataBlock fftSource)
void	setParams(BeamAlgorithmParams newParams)	Take settings from the parameters object and load them into the pane
void	setTabVisibility()	Adds/Removes the beam and beamogram tabs, based on the current parameters

Methods inherited from class PamController.SettingsPane

getAWTWindow, getFXWindow, getHelpPoint, getOwnerWindow, notifyChange, repackContents, setDefaults, setOwnerWindow

Methods inherited from class java.lang.Object

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

Constructor Details

BeamAlgoParamsPane

public BeamAlgoParamsPane(Object window,
 BeamFormerBaseControl beamFormerControl2)

Parameters:

basicFreqDomBeamProvider -

Method Details

createBeamListPane

public javafx.scene.Node createBeamListPane()

Create the pane holding the list of beams

Returns:

createDefaults

public void createDefaults()

Create a list of default beams, evenly spread between 0 and 180 degrees. For these, the elevation is 0 deg

createBeamPatternPane

public javafx.scene.Node createBeamPatternPane()

Returns:

prepareConstants

public void prepareConstants()

Get the current hydrophone locations, and set the field vector elementLocs

getParams

public BeamAlgorithmParams getParams(BeamAlgorithmParams p)

Take settings from the pane and save them into the parameters object

Specified by:

getParams in class SettingsPane<BeamAlgorithmParams>

Parameters:

p - settings passed into this object by PamDialogFX2AWT - ignored

Returns:

settings class

checkBeamogramStatus

public BeamAlgoParamsPane.BeamgramStatus checkBeamogramStatus()

Test whether the beamogram data is valid. This should only be called if the beamogram check box is checked

Returns:

setParams

public void setParams(BeamAlgorithmParams newParams)

Take settings from the parameters object and load them into the pane

Specified by:

setParams in class SettingsPane<BeamAlgorithmParams>

Parameters:

newParams - - current settings class.

setBeamogramData

public void setBeamogramData()

Fills in the data on the beamogram tab, or clears it

setTabVisibility

public void setTabVisibility()

Adds/Removes the beam and beamogram tabs, based on the current parameters

setAngleRange

public void setAngleRange()

Sets the valid angle range, based on the array shape

setArrayTypeLables

public void setArrayTypeLables()

getDataSource

public AcousticDataBlock getDataSource()

Returns:

the fftSource

setDataSource

public void setDataSource(AcousticDataBlock fftSource)

Parameters:

fftSource - the fftSource to set

getName

public String getName()

Description copied from class: SettingsPane

Get the name of the pane.

Specified by:

getName in class SettingsPane<BeamAlgorithmParams>

Returns:

name of the pane

getContentNode

public javafx.scene.Node getContentNode()

Description copied from class: SettingsPane

Get node for GUI change of settings.

Specified by:

getContentNode in class SettingsPane<BeamAlgorithmParams>

paneInitialized

public void paneInitialized()

Description copied from class: SettingsPane

Called when settings pane is first initialised. This can be used if for example, a the size of a pane is needed for a param. (Sizes are only initialised when Nodes are shown);

Specified by:

paneInitialized in class SettingsPane<BeamAlgorithmParams>