StaticLocaliserControl

java.lang.Object
- PamController.PamControlledUnit
- - staticLocaliser.StaticLocaliserControl

All Implemented Interfaces:

PamSettings
```
public class StaticLocaliserControl
extends PamControlledUnit
implements PamSettings
```
Static Localiser.
The static localiser ('localiser' with an 's') is designed to allow the localisation of a single vocalisation incident on a synchronised or unsynchronised hydrophone array. As of 17/05/2012 only a click and offline click datablock can be used in localisation, however the module has been written to allow others to enable different data blocks easily. In addition different localisation algorithms can be integrated by writing a single class.
To enable a new data block for localisation.
1) Create a new sub class of 'AbstractDetectionMatch' and fill out the relevant functions. This class takes a PamDataUnit and it's parent datablock then works out all the possible time delays between the hydrophone elements within the specified array. A flag can be passed to this class in order to determine how to calculate time delays (usually by specifying which dataunits on other hydrophones to use). For example in 'ClickDetectionMatch' flags to include only clicks which are part of the same event and/or species are passed when working out time delays. However a flag could be passed which initiates a more complex type of time delay calculation, perhaps using click train matching techniques.
2)Create a new control panel, a subclass of 'AbstractLocaliserControl' and again make sure to fill out all the required functions properly. This panel should allow the user to navigate through the individual pamdataunits within the pamdatablock. It should also allow the user to select which flags to send to the time delay calculation. For example the click control panel allows the user to select different species classifications. If a species classification is selected in the control panel, the panel will return a flag which, in 'ClickDetectionMatch' tells the time delay algorithm only to select dataunits which are of the same classification
3)Implement 'StaticLocaliserProvider' for the data block in question. This will create a function which must return an AbstractLocaliserControl class, i.e. the controlPanel you just made.
4)In your subclass of PamDataUnit, eg ClickDetection, change the functions 'getDetectionMatch()' and 'getDetectionMatch(int type)' to return the subclass of AbstractDetectionMatch you've created. Note if there are no flags for your AbstractDetectionMatch sub class simply return the same for both these functions.
5)Sit back and enjoy the program crashing. Time to debug.

To create a new localisation algorithm
1) Create a subclass of 'AbstractStaticLocaliserAlgorithm' and fill out the relevant functions. Note that the runModel() algorithm returns an ArrayList of StaticLocalisationResults. This is because an algorithm may be intelligent enough to calculate two possible locations. If not just have an ArrayList of one result.
2)In the StaticLoclalise class add an instance of your new AbstractStaticLocaliserAlgorithm subclass to the 'algorithms' ArrayList in the constructor. ]
Hopefully users will add new compatible detections and localisation algorithms over time.

Author:

Jamie Macaulay

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONTROL_PANEL_PAUSED` The control panel has been paused or un-paused: This is only used in real time operation
`boolean`	`isViewer`
`static int`	`RUN_ALGORITHMS` Beginning to run the localisation algorithms.
`static int`	`SEL_DETECTION_CHANGED` The selected detection has changed.
`static int`	`SEL_DETECTION_CHANGED_BATCH` The selected detection has changed in batch processing mode.
`static int`	`SETTINGS_CHANGE`
`static int`	`START_REAL_TIME` The localiser has started in real time mode
`static int`	`STOP_REAL_TIME` The localiser has stopped in real time mode due to pamguard stopping.
`static int`	`TD_FINISHED_CALC` The time delay manager has finished calculating.
`static int`	`TD_PROGRESS_UPDATE` The time delay manager has a progress update on time dely calc.
`static int`	`TD_SEL_CHANGED` A different time delay has been selected
`static int`	`TD_START_CALC` The time delay manager has started calculated time delays

Constructor Summary

Constructors
Constructor and Description

StaticLocaliserControl(java.lang.String unitName)

Constructors
Constructor and Description
`StaticLocaliserControl(java.lang.String unitName)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canLocalise(PamDetection pamDetection)` This is primarily used for batch analysis of data in offline mode or data in real time mode.
`javax.swing.JMenu`	`createDetectionMenu()` Creates a static localiser specific JMenu.
`void`	`dataBlockChanged()` Carries out tasks required if the dataBlock is changed.
`void`	`findDataBlocks()` Get only data blocks which satisfy the StaticLocaliserProvider, i.e.
`AlarmCounterProvider`	`getAlarmCounterProvider()`
`PamDataBlock`	`getCurrentDatablock()`
`java.util.ArrayList<PamDataBlock>`	`getCurrentDataBlocks()`
`java.util.ArrayList<java.util.ArrayList<PamDataBlock>>`	`getDataBlocks()` Returns just the single datablocks
`java.util.ArrayList<java.util.ArrayList<PamDataBlock>>`	`getDataBlocksAll()` Returns both the single and unsync dataBlocks
`java.util.ArrayList<java.util.ArrayList<PamDataBlock>>`	`getDataBlocksUnsync()` Returns just the unsynchronised dataBlocks;
`java.awt.Frame`	`getFrame()`
`int[]`	`getHydrophoneList()` Gets a list of hydrophones in the current selected datablock.
`StaticLocaliserOfflineFunctions`	`getOfflineFunctions()` get offline functions for static localiser.
`StaticLocaliserParams`	`getParams()` Get the parameters class for the static localiser
`ResultsFilterManager`	`getResultsFilter()` Get the results filter manager.
`java.io.Serializable`	`getSettingsReference()`
`long`	`getSettingsVersion()`
`SLMapping`	`getSlMapping()` Get the map manager.
`StaticLocalise`	`getStaticLocaliser()` Get the static localiser, contains localisation algorithms.
`StaticLocaliserSQLLogging`	`getStaticLocaliserSQLLogging()`
`StaticLocalisationMainPanel`	`getStaticMainPanel()` Get the main panel for the static localiser.
`javax.swing.JMenuBar`	`getTabSpecificMenuBar(java.awt.Frame parentFrame, javax.swing.JMenuBar standardMenu, PamGui pamGui)` Create a tab specific menu to go with this PamControlledUnit.
`TDManager`	`getTDManager()` Get the time delay manager.
`java.lang.String`	`getUnitType()`
`int`	`getVerboseLevel()`
`void`	`notifyModelChanged(int changeType)` General notification when the PAMGAURD model changes.
`boolean`	`restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)`
`void`	`run()` Begin the process of localisation but only localise one time delay possibility.
`void`	`runAll()` Begin the process of localisation process for one or more time delay possibilities.
`void`	`runBatch()` Run an automatic localisation, i.e.
`void`	`save(SLResult slResult)` Saves a static localisation result directly to the database.
`void`	`saveAll()` Saves either all the possible results from all the algorithms, or if showOnlyLowestChiValueDelay is selected in the main options panel saves only the result with the lowest chi value but for all algorithms.
`void`	`saveBest()` Saves only the the best result.
`void`	`setCurrentDatablock(PamDataBlock dataBlock)`
`void`	`setCurrentDataBlocks(java.util.ArrayList<PamDataBlock> currentDataBlocks)`
`void`	`setParams(StaticLocaliserParams newParams)`
`StaticLocaliserSQLLogging`	`setStaticLocaliserSQLLogging(StaticLocaliserSQLLogging staticLocaliserSQLLogging)`
`void`	`setStaticTDManager(TDManager staticTDManager)` Set the time delay manager for the static localiser.
`void`	`tdManagerThreadUpdate(int threadUpdate)` Notify panels of an update from the tdmanager thread.

Methods inherited from class PamController.PamControlledUnit
addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDetectionMenu, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getToolbarComponent, getUnitName, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface PamController.PamSettings
getUnitName

- Field Detail
  - RUN_ALGORITHMS
```
public static final int RUN_ALGORITHMS
```
    Beginning to run the localisation algorithms.
    
    See Also:
    Constant Field Values
  - TD_SEL_CHANGED
```
public static final int TD_SEL_CHANGED
```
    A different time delay has been selected
    
    See Also:
    Constant Field Values
  - SEL_DETECTION_CHANGED
```
public static final int SEL_DETECTION_CHANGED
```
    The selected detection has changed.
    
    See Also:
    Constant Field Values
  - SEL_DETECTION_CHANGED_BATCH
```
public static final int SEL_DETECTION_CHANGED_BATCH
```
    The selected detection has changed in batch processing mode.
    
    See Also:
    Constant Field Values
  - SETTINGS_CHANGE
```
public static final int SETTINGS_CHANGE
```
    See Also:
    Constant Field Values
  - TD_START_CALC
```
public static final int TD_START_CALC
```
    The time delay manager has started calculated time delays
    
    See Also:
    Constant Field Values
  - TD_PROGRESS_UPDATE
```
public static final int TD_PROGRESS_UPDATE
```
    The time delay manager has a progress update on time dely calc.
    
    See Also:
    Constant Field Values
  - TD_FINISHED_CALC
```
public static final int TD_FINISHED_CALC
```
    The time delay manager has finished calculating.
    
    See Also:
    Constant Field Values
  - CONTROL_PANEL_PAUSED
```
public static final int CONTROL_PANEL_PAUSED
```
    The control panel has been paused or un-paused: This is only used in real time operation
    
    See Also:
    Constant Field Values
  - START_REAL_TIME
```
public static final int START_REAL_TIME
```
    The localiser has started in real time mode
    
    See Also:
    Constant Field Values
  - STOP_REAL_TIME
```
public static final int STOP_REAL_TIME
```
    The localiser has stopped in real time mode due to pamguard stopping.
    
    See Also:
    Constant Field Values
  - isViewer
```
public boolean isViewer
```
- Constructor Detail
  - StaticLocaliserControl
```
public StaticLocaliserControl(java.lang.String unitName)
```
- Method Detail
  - createDetectionMenu
```
public javax.swing.JMenu createDetectionMenu()
```
    Creates a static localiser specific JMenu. Only advanced options should be included in this menu and not on the main dialog panel
    
    Returns:
    menu for advanced options in the static loclaliser.
  - save
```
public void save(SLResult slResult)
```
    Saves a static localisation result directly to the database. A unique table exists for static localisation results. If the user has selected save to csv, results will also be saved to a .csv file.
    
    Parameters:
    slResult- - result to save.
  - saveBest
```
public void saveBest()
```
    Saves only the the best result. The best result is by default the result with the lowest chi value. However, the bestResult param in the StaticLocalise class can be changed by selecting another result in the results table.
  - saveAll
```
public void saveAll()
```
    Saves either all the possible results from all the algorithms, or if showOnlyLowestChiValueDelay is selected in the main options panel saves only the result with the lowest chi value but for all algorithms. e.g. if MCMC had the lowest chi value but both MCMC and Simplex algorithms were used then the MCMC and Simplex result would be saved.
  - getTabSpecificMenuBar
```
public javax.swing.JMenuBar getTabSpecificMenuBar(java.awt.Frame parentFrame,
                                         javax.swing.JMenuBar standardMenu,
                                         PamGui pamGui)
```
    Description copied from class: PamControlledUnit
    
    Create a tab specific menu to go with this PamControlledUnit.
    Default is to throw back the standard menu to be used. This function should clone the standard menu and then modify the clone (usually by replacing the Display sub menu)
    
    Overrides:
    
    getTabSpecificMenuBar in class PamControlledUnit
    
    standardMenu - the standard menu for the Pam GUI.
    
    Returns:
    a complete menu bar to be shown while a particular tab is selected
  - getFrame
```
public java.awt.Frame getFrame()
```
  - setCurrentDatablock
```
public void setCurrentDatablock(PamDataBlock dataBlock)
```
  - getCurrentDatablock
```
public PamDataBlock getCurrentDatablock()
```
  - getCurrentDataBlocks
```
public java.util.ArrayList<PamDataBlock> getCurrentDataBlocks()
```
  - setCurrentDataBlocks
```
public void setCurrentDataBlocks(java.util.ArrayList<PamDataBlock> currentDataBlocks)
```
  - getDataBlocksAll
```
public java.util.ArrayList<java.util.ArrayList<PamDataBlock>> getDataBlocksAll()
```
    Returns both the single and unsync dataBlocks
  - getDataBlocks
```
public java.util.ArrayList<java.util.ArrayList<PamDataBlock>> getDataBlocks()
```
    Returns just the single datablocks
    
    Returns:
  - getDataBlocksUnsync
```
public java.util.ArrayList<java.util.ArrayList<PamDataBlock>> getDataBlocksUnsync()
```
    Returns just the unsynchronised dataBlocks;
    
    Returns:
  - dataBlockChanged
```
public void dataBlockChanged()
```
    Carries out tasks required if the dataBlock is changed.
  - getStaticMainPanel
```
public StaticLocalisationMainPanel getStaticMainPanel()
```
    Get the main panel for the static localiser.
    
    Returns:
    main panel for the static localiser.
  - findDataBlocks
```
public void findDataBlocks()
```
    Get only data blocks which satisfy the StaticLocaliserProvider, i.e. which are currently implemented for static localiser to use.
  - run
```
public void run()
```
    Begin the process of localisation but only localise one time delay possibility.
  - runAll
```
public void runAll()
```
    Begin the process of localisation process for one or more time delay possibilities.
  - runBatch
```
public void runBatch()
```
    Run an automatic localisation, i.e. any localisation were a data unit has not been specifically selected by a user. This is generally the case for real time operation and offline batch processing.
  - 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
  - getStaticLocaliser
```
public StaticLocalise getStaticLocaliser()
```
    Get the static localiser, contains localisation algorithms.
    
    Returns:
    the staticLocaliser for this module.
  - getParams
```
public StaticLocaliserParams getParams()
```
    Get the parameters class for the static localiser
    
    Returns:
    variables for static localiser.
  - setParams
```
public void setParams(StaticLocaliserParams newParams)
```
  - getOfflineFunctions
```
public StaticLocaliserOfflineFunctions getOfflineFunctions()
```
    get offline functions for static localiser. This includes ability to batch localise data.
    
    Returns:
    offline functions for static localiser.
  - getTDManager
```
public TDManager getTDManager()
```
    Get the time delay manager. Manages time delay calculations
    
    Returns:
    the time delay manager.
  - setStaticTDManager
```
public void setStaticTDManager(TDManager staticTDManager)
```
    Set the time delay manager for the static localiser.
    
    Parameters:
    staticTDManager - - TDManager class or subclass
  - getHydrophoneList
```
public int[] getHydrophoneList()
```
    Gets a list of hydrophones in the current selected datablock. If multiple datablocks are present then uses the first datablock (.get(0)).
    
    Returns:
    a list of hydrophones in the primary datablock.
  - getSettingsReference
```
public java.io.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
  - getUnitType
```
public java.lang.String getUnitType()
```
    Specified by:
    
    getUnitType in interface PamSettings
    
    Overrides:
    
    getUnitType in class PamControlledUnit
    
    Returns:
    A Name specific to the type, e.g. Glick detector
  - 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
  - canLocalise
```
public boolean canLocalise(PamDetection pamDetection)
```
    This is primarily used for batch analysis of data in offline mode or data in real time mode. Checks whether the localiser should localise a data unit or not based on channel, whether a primary channel is being used and if the current controil panel for the selected datablock has added extra filter params (e.g. classification) for detections to be localised.
    
    Returns:
    true if the detection can be localised.
  - tdManagerThreadUpdate
```
public void tdManagerThreadUpdate(int threadUpdate)
```
    Notify panels of an update from the tdmanager thread.
    
    Parameters:
    threadUpdate - - type of update
  - getStaticLocaliserSQLLogging
```
public StaticLocaliserSQLLogging getStaticLocaliserSQLLogging()
```
  - setStaticLocaliserSQLLogging
```
public StaticLocaliserSQLLogging setStaticLocaliserSQLLogging(StaticLocaliserSQLLogging staticLocaliserSQLLogging)
```
  - getResultsFilter
```
public ResultsFilterManager getResultsFilter()
```
    Get the results filter manager.
    
    Returns:
    the result filter manager
  - getSlMapping
```
public SLMapping getSlMapping()
```
    Get the map manager. This deals with GEO referencing localisation results.
    
    Returns:
    the map manager for this static localiser.
  - getAlarmCounterProvider
```
public AlarmCounterProvider getAlarmCounterProvider()
```
  - getVerboseLevel
```
public int getVerboseLevel()
```
    Overrides:
    
    getVerboseLevel in class PamControlledUnit
    
    Returns:
    a verbose level for terminalPrint and terminalPrintln

Class StaticLocaliserControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class PamController.PamControlledUnit

Methods inherited from class java.lang.Object

Methods inherited from interface PamController.PamSettings

Field Detail

RUN_ALGORITHMS

TD_SEL_CHANGED

SEL_DETECTION_CHANGED

SEL_DETECTION_CHANGED_BATCH

SETTINGS_CHANGE

TD_START_CALC

TD_PROGRESS_UPDATE

TD_FINISHED_CALC

CONTROL_PANEL_PAUSED

START_REAL_TIME

STOP_REAL_TIME

isViewer

Constructor Detail

StaticLocaliserControl

Method Detail

createDetectionMenu

save

saveBest

saveAll

getTabSpecificMenuBar

getFrame

setCurrentDatablock

getCurrentDatablock

getCurrentDataBlocks

setCurrentDataBlocks

getDataBlocksAll

getDataBlocks

getDataBlocksUnsync

dataBlockChanged

getStaticMainPanel

findDataBlocks

run

runAll

runBatch

notifyModelChanged

getStaticLocaliser

getParams

setParams

getOfflineFunctions

getTDManager

setStaticTDManager

getHydrophoneList

getSettingsReference

getSettingsVersion

getUnitType

restoreSettings

canLocalise

tdManagerThreadUpdate

getStaticLocaliserSQLLogging

setStaticLocaliserSQLLogging

getResultsFilter

getSlMapping

getAlarmCounterProvider

getVerboseLevel