Package detectionPlotFX.plots

Class RawFFTPlot.SimpleFFTDataBlock

java.lang.Object

PamguardMVC.PamObservable

PamguardMVC.PamDataBlock<DataUnit2D>

PamguardMVC.AcousticDataBlock<DataUnit2D>

PamguardMVC.DataBlock2D<DataUnit2D>

detectionPlotFX.plots.RawFFTPlot.SimpleFFTDataBlock

Enclosing class:

RawFFTPlot<D extends PamDataUnit>

public class RawFFTPlot.SimpleFFTDataBlock
extends DataBlock2D<DataUnit2D>

Data block for holding FFT Values

Author:

Jamie Macaulay

Field Summary

Fields inherited from class PamguardMVC.PamDataBlock

ITERATOR_END, MATCH_AFTER, MATCH_BEFORE, MATCH_EXACT, MIX_DONOTHING, MIX_INTODATABASE, MIX_OUTOFDATABASE, naturalLifetime, NOTIFY_NEW_DATA, NOTIFY_UPDATE_DATA, pamDataUnits, parentProcess, POSITION_AFTER, POSITION_BEFORE, REFERENCE_ABSOLUTE, REFERENCE_CURRENT, REQUEST_DATA_LOADED, REQUEST_DATA_PARTIAL_LOAD, REQUEST_EXCEPTION, REQUEST_INTERRUPTED, REQUEST_NO_DATA, REQUEST_SAME_REQUEST, unitsAdded, unitsRemoved, unitsUpdated

Fields inherited from class PamguardMVC.PamObservable

masterClockSample, objectChanged, overlayDraw, pamProfiler

Constructor Summary

Constructors

Constructor	Description
SimpleFFTDataBlock(String dataName, PamProcess parentProcess, int channelMap, int fftHop, int fftLength)

Method Summary

Modifier and Type	Method	Description
int	getDataWidth(int sequenceNumber)	Get the length of contained data.
int	getFFTHop()	Get Fft HOP
int	getFftLength()
int	getHopSamples()	Get the advance between slices in samples.
double	getMaxDataValue()	Get the maximum value which can occur in the data.
double	getMinDataValue()	Get the minimum value which can occur in the data.
float	getSampleRate()
DataTypeInfo	getScaleInfo()	Get the scale units to display on axis, etc.
void	setFftHop(int fftHop)
void	setFftLength(int fftLength)
void	setSampleRate(float sampleRate)

Methods inherited from class PamguardMVC.DataBlock2D

getDataBlockXML

Methods inherited from class PamguardMVC.AcousticDataBlock

findParentSource, getChannelListManager, getParentSourceData, notifyModelChanged, prepareAmplitudeCalculations, prepareChannelLists

Methods inherited from class PamguardMVC.PamDataBlock

addDataAnnotationType, addLocalisationContents, addObserver, addObserver, addOfflineDataMap, addOldPamData, addPamData, addPamData, autoEffortProvider, autoSetDataBlockMixMode, cancelDataOrder, cancelDataOrder, checkOfflineDataUIDs, clearAll, clearAll, clearChannelIterators, clearDeletedList, clearOnViewerLoad, copyDataList, createProcessAnnotations, createProcessAnnotations, dispose, dumpBlockContents, dumpBufferStatus, findAnnotation, findAnnotation, findByDatabaseIndex, findDataUnit, findDataUnit, findFirstUnitAfter, findLastUnitBefore, findUnitByUIDandUTC, findUnitsinInterval, getAbsoluteDataUnit, getAnnotationHandler, getARealChannel, getBackgroundManager, getBespokeDataMapGraphic, getBinaryDataSource, getCanLog, getChannelIterator, getChannelIteratorCount, getChannelMap, getChannelsForSequenceMap, getClosestUnitMillis, getClosestUnitMillis, getClosestUnitMillisUsingSeq, getCrossReferenceInformation, getCumulativeGain, getCurrentViewDataEnd, getCurrentViewDataStart, getDataAutomationInfo, getDatablockSpeciesManager, getDataCopy, getDataCopy, getDataCopy, getDataCopy, getDataCopyFromEnd, getDataCopyFromStart, getDataGain, getDatagrammedMap, getDatagramProvider, getDataName, getDataSelectCreator, getDataSelector, getDataSelector, getDataSelector, getDataUnit, getDataUnitMenuItems, getDataUnitPopupMenu, getDurationRange, getEffortProvider, getFirstRawSourceDataBlock, getFirstUnit, getFirstUnit, getFirstUnitAfter, getFirstViewerUID, getFrequencyRange, getHydrophoneMap, getJSONDataSource, getLastUnit, getLastUnit, getLastUnitMillis, getLastViewerUID, getListIterator, getListIterator, getListIteratorFromEnd, getListIteratorFromStart, getLocalisationAlgorithm, getLocalisationContents, getLogging, getLoggingName, getLongDataName, getMixedDirection, getMyDataUnits, getNanoTimeCalculator, getNaturalLifetime, getNaturalLifetimeMillis, getNextDataStart, getNextUnit, getNextUnit, getNumOfflineDataMaps, getNumRequiredBeforeLoadTime, getOfflineData, getOfflineDataMap, getOfflineDataMap, getPamConfiguration, getPamSymbolManager, getParentProcess, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnitFromSeq, getPreceedingUnitFromSeq, getPrevDataEnd, getPrimaryDataMap, getProcessAnnotations, getQuickId, getQuickId2, getRawSourceDataBlock, getRawSourceDataBlock2, getRecordingTrigger, getRecycledUnit, getRecyclingStoreLength, getRemovedItems, getReverseChannelIterator, getSaveRequirements, getSequenceCount, getSequenceIterator, getSequenceMap, getSequenceMapObject, getShouldBinary, getShouldLog, getShouldLog, getSourceDataBlock, getSourceProcess, getSuperDetectionClass, getSynchLock, getTaskDataCopy, getTethysDataProvider, getTOADCalculator, getUidHandler, getUIDRepairLogging, getUniqueParentList, getUnitClass, getUnitIndex, getUnitsCount, getUnitsCountFromTime, hasDataRange, isCanClipGenerate, isClearAtStart, isLinkGpsData, isOffline, isRecycling, loadViewerData, loadViewerData, masterClockUpdate, needViewerDataLoad, noteNewSettings, notifyOfflineObservers, orderOfflineData, orderOfflineData, orderOfflineData, pamStart, pamStop, remove, remove, remove, removedDataUnit, removeOfflineDataMap, removeOldUnitsS, removeOldUnitsT, reset, saveViewerData, setAnnotationHandler, setBackgroundManager, setBinaryDataSource, setCanClipGenerate, setChannelMap, setClearAtStart, setCurrentViewDataEnd, setCurrentViewDataStart, setDatagramProvider, setDataName, setDataSelectCreator, setEffortProvider, setJSONDataSource, setLinkGpsData, setLocalisationContents, SetLogging, setMixedDirection, setNanoTimeCalculator, setNaturalLifetime, setNaturalLifetimeMillis, setPamSymbolManager, setParentProcess, setRecordingTrigger, setRecycling, setRecyclingStoreLength, setSampleRate, setSequenceMap, setShouldBinary, setShouldLog, setSynchLock, setUidHandler, shouldNotify, sortData, sortOutputMaps, stopTimer, toString, updatePamData

Methods inherited from class PamguardMVC.PamObservable

addInstantObserver, canDraw, canDraw, clearchanged, countObservers, createKeyItem, deleteObserver, deleteObservers, drawDataUnit, findThreadedObserver, getCPUPercent, getCPUPercent, getHoverText, getInstantObservers, getLongestObserver, getMaxThreadJitter, getOverlayDraw, getPamObserver, getPamObservers, getRequiredHistory, isInstantObserver, notifyInstantObservers, notifyNornalObservers, notifyObservers, notifyObservers, setChanged, setOverlayDraw, updateObservers, waitForThreadedObservers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SimpleFFTDataBlock

public SimpleFFTDataBlock(String dataName,
 PamProcess parentProcess,
 int channelMap,
 int fftHop,
 int fftLength)

Method Details

getSampleRate

public float getSampleRate()

Overrides:

getSampleRate in class PamDataBlock<DataUnit2D>

Returns:

The sample rate of the data contained in the block

getHopSamples

public int getHopSamples()

Description copied from class: DataBlock2D

Get the advance between slices in samples. For FFT data this is the same thing as the FFT Hop

Specified by:

getHopSamples in class DataBlock2D<DataUnit2D>

Returns:

advance in samples between slices.

getDataWidth

public int getDataWidth(int sequenceNumber)

Description copied from class: DataBlock2D

Get the length of contained data. For FFT data this will be FFTLength()/2.

Specified by:

getDataWidth in class DataBlock2D<DataUnit2D>

Returns:

length of data in each slice.

getMinDataValue

public double getMinDataValue()

Description copied from class: DataBlock2D

Get the minimum value which can occur in the data. e.g. 0 for FFT data.

Specified by:

getMinDataValue in class DataBlock2D<DataUnit2D>

Returns:

the data's minimum value

getMaxDataValue

public double getMaxDataValue()

Description copied from class: DataBlock2D

Get the maximum value which can occur in the data. e.g. sampleRate/2 for FFT data.

Specified by:

getMaxDataValue in class DataBlock2D<DataUnit2D>

Returns:

the data's maximum value

setSampleRate

public void setSampleRate(float sampleRate)

Parameters:

sampleRate - the sampleRate to set

getFftLength

public int getFftLength()

Parameters:

fftLength - the fftLength to set

setFftLength

public void setFftLength(int fftLength)

Parameters:

fftLength - the fftLength to set

getFFTHop

public int getFFTHop()

Get Fft HOP

Returns:

setFftHop

public void setFftHop(int fftHop)

Parameters:

fftHop - the fftHop to set

getScaleInfo

public DataTypeInfo getScaleInfo()

Description copied from class: DataBlock2D

Get the scale units to display on axis, etc.

Specified by:

getScaleInfo in class DataBlock2D<DataUnit2D>

Returns:

data type information.