Package clickDetector
Class ClickSpectrum
java.lang.Object
Layout.PamFramePlots
clickDetector.ClickDisplay
clickDetector.ClickSpectrum
- All Implemented Interfaces:
PamSettings
,SettingsNameProvider
,PamObserver
-
Constructor Summary
ConstructorDescriptionClickSpectrum
(ClickControl clickControl, ClickDisplayManager clickDisplayManager, clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo) ClickSpectrum
(STClickControl clickControl, ClickDisplayManager clickDisplayManager, clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo) Constructor needed when creating the SoundTrap Click Detector - need to explicitly cast from STClickControl to ClickControl, or else constructor fails -
Method Summary
Modifier and TypeMethodDescriptionvoid
addData
(PamObservable o, PamDataUnit arg) Informs the PamObserver that new data have been added to the Observable classvoid
void
clickedOnClick
(ClickDetection click) double[]
convertTemplate
(ClickTemplate clickTemplate, boolean log) This function converts a ClickTemplate to an fft which corresponds to the correct samplerate used in the current click data.double
correlate
(double[] wave1, double[] wave2) Take two double arrays, not necessarily the same frequency or same number of bins and correlate;void
getEventClick
(ClickDetection newClick) getName()
Get a unique name for the displaylong
long
void
void
masterClockUpdate
(long milliSeconds, long sampleNumber) double[]
meanSpectrum
(ArrayList<double[]> eventSpectrums) void
newClick
(ClickDetection newClick) double[]
normailiseSpectrum
(double[] Spectrum) double[][]
normailiseSpectrum
(double[][] eventSpectrums) void
void
receiveSourceNotification
(int type, Object object) Receive a notification from the data source - typically a change in DAQ status.void
called when an Observable (PamDataBlock) is removed from the systemboolean
restoreSettings
(PamControlledUnitSettings pamControlledUnitSettings) void
setClickTemplateParams
(ClickSpectrumTemplateParams clickTemplateParams) void
setSampleRate
(float sampleRate, boolean notify) New sample ratevoid
updateData
(PamObservable observable, PamDataUnit pamDataUnit) Informs the PamObserver that existing data have been updatedMethods inherited from class clickDetector.ClickDisplay
created, getClickDisplayInfo, offlineDataChanged, pamStart, pamStop
Methods inherited from class Layout.PamFramePlots
checkDualDisplay, getAxisPanel, getCopyMenuItem, getEastPanel, getFrame, getLeftPlotPanel, getNorthPanel, getPlotPanel, getRightPlotPanel, getSouthPanel, getWestPanel, repaint, setAxisPanel, setEastPanel, setFrame, setLeftPlotPanel, setNorthPanel, setPlotPanel, setRightPlotPanel, setSouthPanel, setWestPanel
-
Constructor Details
-
ClickSpectrum
public ClickSpectrum(ClickControl clickControl, ClickDisplayManager clickDisplayManager, clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo) -
ClickSpectrum
public ClickSpectrum(STClickControl clickControl, ClickDisplayManager clickDisplayManager, clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo) Constructor needed when creating the SoundTrap Click Detector - need to explicitly cast from STClickControl to ClickControl, or else constructor fails- Parameters:
clickControl
-clickDisplayManager
-clickDisplayInfo
-
-
-
Method Details
-
getObserverObject
- Specified by:
getObserverObject
in interfacePamObserver
- Returns:
- the actual observer. In most cases concrete classes will just return 'this' in response. The exception is the Threaded observer, which will return the single thread observer.
-
clearTemplates
public void clearTemplates() -
getName
Description copied from class:PamFramePlots
Get a unique name for the display- Specified by:
getName
in classPamFramePlots
- Returns:
- a unique name for the display.
-
newClick
-
getEventClick
-
convertTemplate
This function converts a ClickTemplate to an fft which corresponds to the correct samplerate used in the current click data.- Parameters:
clickTemplate
-- Returns:
-
getTemplateClick
public void getTemplateClick() -
meanSpectrum
-
normailiseSpectrum
public double[] normailiseSpectrum(double[] Spectrum) -
normailiseSpectrum
public double[][] normailiseSpectrum(double[][] eventSpectrums) -
correlate
public double correlate(double[] wave1, double[] wave2) Take two double arrays, not necessarily the same frequency or same number of bins and correlate;- Returns:
-
getObserverName
- Specified by:
getObserverName
in interfacePamObserver
-
getRequiredDataHistory
- Specified by:
getRequiredDataHistory
in interfacePamObserver
- Parameters:
arg
- optional argument from PamObservable- Returns:
- time in milliseconds required by data held in PamObservable
-
noteNewSettings
public void noteNewSettings()- Specified by:
noteNewSettings
in interfacePamObserver
- Specified by:
noteNewSettings
in classClickDisplay
-
removeObservable
Description copied from interface:PamObserver
called when an Observable (PamDataBlock) is removed from the system- Specified by:
removeObservable
in interfacePamObserver
-
setSampleRate
public void setSampleRate(float sampleRate, boolean notify) Description copied from interface:PamObserver
New sample rate- Specified by:
setSampleRate
in interfacePamObserver
- Parameters:
notify
- Notify other PamObservers and PamObservables in the chain.
-
masterClockUpdate
public void masterClockUpdate(long milliSeconds, long sampleNumber) - Specified by:
masterClockUpdate
in interfacePamObserver
-
addData
Description copied from interface:PamObserver
Informs the PamObserver that new data have been added to the Observable class- Specified by:
addData
in interfacePamObserver
-
updateData
Description copied from interface:PamObserver
Informs the PamObserver that existing data have been updated- Specified by:
updateData
in interfacePamObserver
-
getStoredClick
-
clickedOnClick
- Overrides:
clickedOnClick
in classClickDisplay
-
getSettingsReference
- Specified by:
getSettingsReference
in interfacePamSettings
- Returns:
- The serialisable object that will be stored
-
getSettingsVersion
public long getSettingsVersion()- Specified by:
getSettingsVersion
in interfacePamSettings
- Returns:
- An integer version number for the settings
-
getUnitName
- Specified by:
getUnitName
in interfaceSettingsNameProvider
- Returns:
- A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.
-
getUnitType
- Specified by:
getUnitType
in interfacePamSettings
- Returns:
- A Name specific to the type, e.g. Click detector
-
getClickTemplateParams
-
setClickTemplateParams
-
restoreSettings
- Specified by:
restoreSettings
in interfacePamSettings
- 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
-
receiveSourceNotification
Description copied from interface:PamObserver
Receive a notification from the data source - typically a change in DAQ status. See the constants listed in AcquisitionProcess for potential change types.- Specified by:
receiveSourceNotification
in interfacePamObserver
- Parameters:
type
- the type of changeobject
- generic object added here so that we can include anything in the future
-