clickDetector

Class ClickControl

java.lang.Object

PamController.PamControlledUnit

clickDetector.ClickControl

All Implemented Interfaces:

PamSettings

public class ClickControl
extends PamControlledUnit
implements PamSettings

Main Controller for click detection.

ClickControl contains both the detector and the display panel. It also contains information on Detection and Display menus which will get added to the main PamGuard menu.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor and Description
ClickControl(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOtherRelatedMenuItems(java.awt.Frame parentFrame, javax.swing.JMenu menu, java.lang.String name)
void	batchConvertClickDatabase(java.awt.Frame parentFrame)
boolean	canClose() Called before Pamguard shuts down.
boolean	canPlayViewerSound()
boolean	classificationDialog(java.awt.Frame pf) Opens the offline click dialog.
javax.swing.JMenu	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
javax.swing.JMenu	createDisplayMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with the view
void	deleteEvent(OfflineEventDataUnit event) Delete an offline event.
void	displayActivated(ClickDisplay clickDisplay)
void	displayTriggerHistogram(TriggerHistogram[] triggerHistogram)
AlarmCounterProvider	getAlarmCounterProvider() Get the counting system for the click alarm.
ClickClassifierManager	getClassifierManager()
ClickDataBlock	getClickDataBlock() Get the datablock containing click data
ClickDetector	getClickDetector()
ClickIdentifier	getClickIdentifier()
ClickParameters	getClickParameters()
ClicksOffline	getClicksOffline()
java.lang.String	getDataBlockPrefix() Solve problems with all click data blocks being called the same thing if multiple click detectors are in the system.
ClickDisplayManager	getDisplayManager()
EchoDetectionSystem	getEchoDetectionSystem()
OfflineEventDataUnit	getLatestOfflineEvent()
java.lang.String	getModuleSummary() Get a module summary text string for shorthand output to summary QC systems.
OfflineToolbar	getOfflineToolbar()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.Object	getShortUnitType()
javax.swing.JMenuBar	getTabSpecificMenuBar(java.awt.Frame parentFrame, javax.swing.JMenuBar standardMenu, PamGui pamGui) Create a tab specific menu to go with this PamControlledUnit.
TargetMotionLocaliser<OfflineEventDataUnit>	getTargetMotionLocaliser()
int	getTrueChannelNumber(int iCh)
void	gotoEvent(OfflineEventDataUnit event) Scrolls the display to a specific event.
boolean	isViewerMode() Speedier way of knowing if it's viewer mode than going back to the controller every time
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
void	notifyNewStorage(java.lang.String storageName)
void	offlineDataChanged() Called from clicksOffline when data have changed (eg from re doing click id).
void	pamStart()
void	pamStop()
void	playClicks()
void	playViewerSound() Start playing sound in reponse to a call from the viewer top toolbar.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	secondTimer(long sampleNumber)
void	setClassifierManager(ClickClassifierManager classifierManager)
void	setClickIdentifier(ClickIdentifier clickIdentifier)
void	setClickParameters(ClickParameters clickParameters)
void	setEchoDetectionSystem(EchoDetectionSystem echoDetectionSystem)
void	setLatestOfflineEvent(OfflineEventDataUnit latestOfflineEvent)
void	setupControlledUnit() called for all PamControlledUnits after all units have been created.
void	showOfflineEvents(java.awt.Frame frame) Show a list of offline events.

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getSidePanel, getTabClipCopier, getTabPanel, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, 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, getUnitType

Constructor Detail

ClickControl

public ClickControl(java.lang.String name)

Method Detail

getClickDataBlock

public ClickDataBlock getClickDataBlock()

Get the datablock containing click data

Returns:

Click data block

isViewerMode

public boolean isViewerMode()

Speedier way of knowing if it's viewer mode than going back to the controller every time

Returns:

secondTimer

public void secondTimer(long sampleNumber)

getTrueChannelNumber

public int getTrueChannelNumber(int iCh)

displayTriggerHistogram

public void displayTriggerHistogram(TriggerHistogram[] triggerHistogram)

notifyNewStorage

public void notifyNewStorage(java.lang.String storageName)

createDetectionMenu

public javax.swing.JMenu createDetectionMenu(java.awt.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.

createDisplayMenu

public javax.swing.JMenu createDisplayMenu(java.awt.Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with the view

Overrides:

createDisplayMenu in class PamControlledUnit

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.

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

classificationDialog

public boolean classificationDialog(java.awt.Frame pf)

Opens the offline click dialog.

Parameters:

pf - frame

Returns:

Returns true if settings have changed

batchConvertClickDatabase

public void batchConvertClickDatabase(java.awt.Frame parentFrame)

getClickDetector

public ClickDetector getClickDetector()

pamStart

public void pamStart()

pamStop

public void pamStop()

canClose

public boolean canClose()

Description copied from class: PamControlledUnit

Called before Pamguard shuts down. Rather than returning false, this function can be used as a final oportunity to save settings, write to the database, etc.

Overrides:

canClose in class PamControlledUnit

Returns:

true if OK for Pamguard to shut down, false otherwise.

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

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

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

addOtherRelatedMenuItems

public void addOtherRelatedMenuItems(java.awt.Frame parentFrame,
                            javax.swing.JMenu menu,
                            java.lang.String name)

Overrides:

addOtherRelatedMenuItems in class PamControlledUnit

setupControlledUnit

public void setupControlledUnit()

Description copied from class: PamControlledUnit

called for all PamControlledUnits after all units have been created. This is a good time for the controlled units and processes to find and check their source data and the configuration generally since most onjects (i.e. output data blocks) should be in place

Overrides:

setupControlledUnit in class PamControlledUnit

getClickIdentifier

public ClickIdentifier getClickIdentifier()

setClickIdentifier

public void setClickIdentifier(ClickIdentifier clickIdentifier)

setClassifierManager

public void setClassifierManager(ClickClassifierManager classifierManager)

Parameters:

classifierManager - the classifierManager to set

getClassifierManager

public ClickClassifierManager getClassifierManager()

Returns:

the classifierManager

getClickParameters

public ClickParameters getClickParameters()

setClickParameters

public void setClickParameters(ClickParameters clickParameters)

offlineDataChanged

public void offlineDataChanged()

Called from clicksOffline when data have changed (eg from re doing click id). Needs to notify the display and maybe some other classes.

getOfflineToolbar

public OfflineToolbar getOfflineToolbar()

getClicksOffline

public ClicksOffline getClicksOffline()

Returns:

the clicksOffline

getLatestOfflineEvent

public OfflineEventDataUnit getLatestOfflineEvent()

Returns:

the latestOfflineEvent

setLatestOfflineEvent

public void setLatestOfflineEvent(OfflineEventDataUnit latestOfflineEvent)

Parameters:

latestOfflineEvent - the latestOfflineEvent to set

showOfflineEvents

public void showOfflineEvents(java.awt.Frame frame)

Show a list of offline events. Later on will add more functionality to it.

Parameters:

frame -

gotoEvent

public void gotoEvent(OfflineEventDataUnit event)

Scrolls the display to a specific event.

Parameters:

event - event to scroll to

deleteEvent

public void deleteEvent(OfflineEventDataUnit event)

Delete an offline event. Un-assign all clicks and delete from datablock, ready for deletion from database.

Parameters:

event - event to delete.

canPlayViewerSound

public boolean canPlayViewerSound()

Overrides:

canPlayViewerSound in class PamControlledUnit

Returns:

true if this module can play sound in reponse to a play command from the top toolbar.

playViewerSound

public void playViewerSound()

Description copied from class: PamControlledUnit

Start playing sound in reponse to a call from the viewer top toolbar.

Overrides:

playViewerSound in class PamControlledUnit

playClicks

public void playClicks()

getEchoDetectionSystem

public EchoDetectionSystem getEchoDetectionSystem()

Returns:

the echoDetectionSystem

setEchoDetectionSystem

public void setEchoDetectionSystem(EchoDetectionSystem echoDetectionSystem)

Parameters:

echoDetectionSystem - the echoDetectionSystem to set

displayActivated

public void displayActivated(ClickDisplay clickDisplay)

getDisplayManager

public ClickDisplayManager getDisplayManager()

getDataBlockPrefix

public java.lang.String getDataBlockPrefix()

Solve problems with all click data blocks being called the same thing if multiple click detectors are in the system.

Returns:

a name, defaulting to "" if it's the first created click detector.

getModuleSummary

public java.lang.String getModuleSummary()

Description copied from class: PamControlledUnit

Get a module summary text string for shorthand output to summary QC systems.

Overrides:

getModuleSummary in class PamControlledUnit

Returns:

module summary string - goings on since the last call to this function

getShortUnitType

public java.lang.Object getShortUnitType()

Overrides:

getShortUnitType in class PamControlledUnit

Returns:

a shortened version of the unit type for use in module summary strings.

getAlarmCounterProvider

public AlarmCounterProvider getAlarmCounterProvider()

Get the counting system for the click alarm.

Parameters:

alarmControl -

Returns:

getTargetMotionLocaliser

public TargetMotionLocaliser<OfflineEventDataUnit> getTargetMotionLocaliser()