Package beamformer.continuous

Class BeamOGramDataBlock

java.lang.Object

PamguardMVC.PamObservable

PamguardMVC.PamDataBlock<BeamOGramDataUnit>

PamguardMVC.AcousticDataBlock<BeamOGramDataUnit>

PamguardMVC.DataBlock2D<BeamOGramDataUnit>

beamformer.continuous.BeamOGramDataBlock

public class BeamOGramDataBlock
extends DataBlock2D<BeamOGramDataUnit>

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
BeamOGramDataBlock(String dataName, PamProcess parentProcess, int channelMap)

Method Summary

Modifier and Type	Method	Description
int	getChannelsForSequenceMap(int sequenceMap)	Given a sequenceMap, this method returns the associated channelMap.
int	getDataWidth(int sequenceNumber)	Get the length of contained data.
int	getFftLength()	Need to know the FFT length of the source data so that the magnitude values in the data units can be correctly scaled.
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.
int	getNumAngles(int sequenceNumber)
DataTypeInfo	getScaleInfo()	Get the scale units to display on axis, etc.
void	setFftLength(int fftLength)	Need to set the FFT length of the source data so that the magnitude values in the data units can be correctly scaled.
void	setHopSamples(int hopSamples)
void	setNumAngles(int sequenceNumber, int numAngles)
boolean	shouldNotify()

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, 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, getSampleRate, 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, 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

BeamOGramDataBlock

public BeamOGramDataBlock(String dataName,
 PamProcess parentProcess,
 int channelMap)

Method Details

getNumAngles

public int getNumAngles(int sequenceNumber)

Returns:

the numAngles

setNumAngles

public void setNumAngles(int sequenceNumber,
 int numAngles)

Parameters:

numAngles - the numAngles to set

setHopSamples

public void setHopSamples(int hopSamples)

Parameters:

hopSamples - the hopSamples to set

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<BeamOGramDataUnit>

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<BeamOGramDataUnit>

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<BeamOGramDataUnit>

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<BeamOGramDataUnit>

Returns:

the data's maximum value

getFftLength

public int getFftLength()

Need to know the FFT length of the source data so that the magnitude values in the data units can be correctly scaled.

Returns:

the fftLength

setFftLength

public void setFftLength(int fftLength)

Need to set the FFT length of the source data so that the magnitude values in the data units can be correctly scaled.

Parameters:

fftLength - the fftLength to set

getChannelsForSequenceMap

public int getChannelsForSequenceMap(int sequenceMap)

Description copied from class: PamDataBlock

Given a sequenceMap, this method returns the associated channelMap. By default, this simply returns passed parameter. For the majority of the PamDataBlocks this is correct because there won't be a sequenceMap. This method should be used when the calling function is given a channel but it does not know whether that is truly a channel, or actually a sequence number. It can pass the channel to this method; if the PamDataBlock doesn't have sequence numbers then the number really was a channel and the calling function will get the same number returned.

This method MUST BE OVERRIDDEN in any module that actually uses sequences (e.g. the Beamformer module) to properly map the sequenceMap to the channelMap.

Overrides:

getChannelsForSequenceMap in class PamDataBlock<BeamOGramDataUnit>

Parameters:

sequenceMap -

Returns:

the associated channelMap

shouldNotify

public boolean shouldNotify()

Overrides:

shouldNotify in class PamDataBlock<BeamOGramDataUnit>

getScaleInfo

public DataTypeInfo getScaleInfo()

Description copied from class: DataBlock2D

Get the scale units to display on axis, etc.

Specified by:

getScaleInfo in class DataBlock2D<BeamOGramDataUnit>

Returns:

data type information.