clickDetector

Class ClickSpectrum

java.lang.Object

Layout.PamFramePlots

clickDetector.ClickDisplay

clickDetector.ClickSpectrum

All Implemented Interfaces:

PamSettings, PamObserver

public class ClickSpectrum
extends ClickDisplay
implements PamObserver, PamSettings

Constructor Summary

Constructors

Constructor and Description
ClickSpectrum(ClickControl clickControl, ClickDisplayManager clickDisplayManager, clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearTemplates()
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;
ClickSpectrumTemplateParams	getClickTemplateParams()
void	getEventClick(ClickDetection newClick)
java.lang.String	getName()
java.lang.String	getObserverName()
PamObserver	getObserverObject()
long	getRequiredDataHistory(PamObservable o, java.lang.Object arg)
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
ClickDetection	getStoredClick()
void	getTemplateClick()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
void	masterClockUpdate(long milliSeconds, long sampleNumber)
double[]	meanSpectrum(java.util.ArrayList<double[]> eventSpectrums)
void	newClick(ClickDetection newClick)
double[]	normailiseSpectrum(double[] Spectrum)
double[][]	normailiseSpectrum(double[][] eventSpectrums)
void	noteNewSettings()
void	removeObservable(PamObservable o) called when an Observable (PamDataBlock) is removed from the system
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setClickTemplateParams(ClickSpectrumTemplateParams clickTemplateParams)
void	setSampleRate(float sampleRate, boolean notify) New sample rate
void	update(PamObservable o, PamDataUnit arg) Informs the PamObserver that new data have been added to the Observable class

Methods 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

Methods inherited from class java.lang.Object

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

Constructor Detail

ClickSpectrum

public ClickSpectrum(ClickControl clickControl,
             ClickDisplayManager clickDisplayManager,
             clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo)

Method Detail

getObserverObject

public PamObserver getObserverObject()

Specified by:

getObserverObject in interface PamObserver

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

public java.lang.String getName()

Specified by:

getName in class PamFramePlots

newClick

public void newClick(ClickDetection newClick)

getEventClick

public void getEventClick(ClickDetection newClick)

convertTemplate

public 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.

Parameters:

clickTemplate -

Returns:

getTemplateClick

public void getTemplateClick()

meanSpectrum

public double[] meanSpectrum(java.util.ArrayList<double[]> eventSpectrums)

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

public java.lang.String getObserverName()

Specified by:

getObserverName in interface PamObserver

getRequiredDataHistory

public long getRequiredDataHistory(PamObservable o,
                          java.lang.Object arg)

Specified by:

getRequiredDataHistory in interface PamObserver

Parameters:

o - PamObservable class requiring the data

arg - optional argument from PamObservable

Returns:

time in milliseconds requried by data held in PamObservable

noteNewSettings

public void noteNewSettings()

Specified by:

noteNewSettings in interface PamObserver

Specified by:

noteNewSettings in class ClickDisplay

removeObservable

public void removeObservable(PamObservable o)

Description copied from interface: PamObserver

called when an Observable (PamDataBlock) is removed from the system

Specified by:

removeObservable in interface PamObserver

setSampleRate

public void setSampleRate(float sampleRate,
                 boolean notify)

Description copied from interface: PamObserver

New sample rate

Specified by:

setSampleRate in interface PamObserver

notify - Notify other PamObservers and PamObservables in the chain.

masterClockUpdate

public void masterClockUpdate(long milliSeconds,
                     long sampleNumber)

Specified by:

masterClockUpdate in interface PamObserver

update

public void update(PamObservable o,
          PamDataUnit arg)

Description copied from interface: PamObserver

Informs the PamObserver that new data have been added to the Observable class

Specified by:

update in interface PamObserver

Parameters:

o - Reference to the Observable (a PamDataBlock)

arg - Reference to the new PamDataUnit

getStoredClick

public ClickDetection getStoredClick()

clickedOnClick

public void clickedOnClick(ClickDetection click)

Overrides:

clickedOnClick in class ClickDisplay

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

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

getClickTemplateParams

public ClickSpectrumTemplateParams getClickTemplateParams()

setClickTemplateParams

public void setClickTemplateParams(ClickSpectrumTemplateParams clickTemplateParams)

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