Package PamguardMVC

Class DataBlock2D<Tunit extends PamDataUnit>

java.lang.Object

PamguardMVC.PamObservable

PamguardMVC.PamDataBlock<Tunit>

PamguardMVC.AcousticDataBlock<Tunit>

PamguardMVC.DataBlock2D<Tunit>

Direct Known Subclasses:

BeamOGramDataBlock, FFTDataBlock, RawFFTPlot.SimpleFFTDataBlock, ScaleTest2D

public abstract class DataBlock2D<Tunit extends PamDataUnit>
extends AcousticDataBlock<Tunit>

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

Constructor Summary

Constructors

Constructor	Description
DataBlock2D(Class unitClass, String dataName, PamProcess parentProcess, int channelMap)

Method Summary

Modifier and Type	Method	Description
double	bin2Value(double bin, int sequenceNumber)	Convert a bin to a value.
Element	getDataBlockXML(Document doc)	Get a brief summary of datablock to include in XML descriptions.
abstract int	getDataWidth(int sequenceNumber)	Get the length of contained data.
abstract int	getHopSamples()	Get the advance between slices in samples.
abstract double	getMaxDataValue()	Get the maximum value which can occur in the data.
abstract double	getMinDataValue()	Get the minimum value which can occur in the data.
abstract DataTypeInfo	getScaleInfo()	Get the scale units to display on axis, etc.
boolean	isLogScale()	Are the data on a log scale
double	value2bin(double value, int sequenceNumber)	convert a data value to a bin

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, getOfflineDataLoading, getOfflineDataMap, getOfflineDataMap, getPamConfiguration, getPamSymbolManager, getParentProcess, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnitFromSeq, getPreceedingUnitFromSeq, getPrevDataEnd, getPrimaryDataMap, getProcessAnnotations, getQuickId, getQuickId2, getRawSourceDataBlock, getRawSourceDataBlock2, getRecordingTrigger, getRecycledUnit, getRecyclingStoreLength, getRemovedItems, getReverseChannelIterator, getSampleRate, getSaveRequirements, getSequenceCount, getSequenceIterator, getSequenceMap, getSequenceMapObject, getShouldBinary, getShouldLog, getShouldLog, getSourceDataBlock, getSourceProcess, 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

DataBlock2D

public DataBlock2D(Class unitClass,
 String dataName,
 PamProcess parentProcess,
 int channelMap)

Method Details

getHopSamples

public abstract int getHopSamples()

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

Returns:

advance in samples between slices.

getDataWidth

public abstract int getDataWidth(int sequenceNumber)

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

Returns:

length of data in each slice.

getMinDataValue

public abstract double getMinDataValue()

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

Returns:

the data's minimum value

getMaxDataValue

public abstract double getMaxDataValue()

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

Returns:

the data's maximum value

isLogScale

public boolean isLogScale()

Are the data on a log scale

Returns:

true if log, default is false.

bin2Value

public double bin2Value(double bin,
 int sequenceNumber)

Convert a bin to a value. e.g. a fft bin to a frequency

Parameters:

bin - bin number, e.g. pos in fft.

sequenceNumnber - (channel)

Returns:

data value

value2bin

public double value2bin(double value,
 int sequenceNumber)

convert a data value to a bin

Parameters:

value - data value

sequenceNumber - (channel)

Returns:

bin within data (can exceed limits if too large !)

getScaleInfo

public abstract DataTypeInfo getScaleInfo()

Get the scale units to display on axis, etc.

Returns:

data type information.

getDataBlockXML

public Element getDataBlockXML(Document doc)

Description copied from class: PamDataBlock

Get a brief summary of datablock to include in XML descriptions. Basic output is very simple. Expect other datablock to extend this by adding additional attributes.

Overrides:

getDataBlockXML in class AcousticDataBlock<Tunit extends PamDataUnit>

Parameters:

doc -

Returns:

XML element with description of data.