Package beamformer.localiser

Class BeamFormLocProcess

java.lang.Object

PamguardMVC.PamProcess

beamformer.BeamFormerBaseProcess

beamformer.localiser.BeamFormLocProcess

All Implemented Interfaces:

PamObserver, ProcessAnnotator

public class BeamFormLocProcess
extends BeamFormerBaseProcess

This process doesn't calculate continuous beams, but when data do arrive, it calculates a beam'O'Gram for data in that time-frequency box and estimates a best location based on that time interval.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor	Description
BeamFormLocProcess(BeamFormLocaliserControl beamFormerLocaliserControl)

Method Summary

Modifier and Type	Method	Description
boolean	beamFormDataUnit(PamDataUnit pamDataUnit)	Run the beam former within the given time-frequency box.
boolean	beamFormGroup(PamDataUnit pamDataUnit, beamformer.localiser.BeamFormLocProcess.BeamOGroup beamGroup)	Beam for a data unit within a particular beam group.
FFTDataBlock	findFFTDataBlock()	Find the source of FFT data for the beam former.
BeamFormLocaliserControl	getBeamFormerLocaliserControl()
long	getRequiredDataHistory(PamObservable o, Object arg)
void	newData(PamObservable o, PamDataUnit arg)
void	pamStart()	Called for each process to tell it to start (may not be necessary for processes which are listening for data anyway).
void	pamStop()	Stops the process.
void	prepareProcess()	Called for each process before any of them receive the PamStart command

Methods inherited from class beamformer.BeamFormerBaseProcess

findGroupProcess, frequencyToBin, frequencyToBin, getBeamFormerOutput, getBeamOGramOutput, getChannelGroupLUT, getChannelsForSequenceMap, getFftDataSource, getGroupProcesses, makeContinuousBeams, notifyModelChanged

Methods inherited from class PamguardMVC.PamProcess

absMillisecondsToSamples, absSamplesToMilliseconds, addData, addMultiPlexDataBlock, addOutputDataBlock, changedThreading, clearOldData, createAnnotations, destroyProcess, dumpBufferStatus, flushDataBlockBuffers, getAncestorDataBlock, getAnnotation, getChainPosition, getCompatibleDataUnits, getCpuPercent, getFrequencyRange, getLastSourceNotificationObject, getLastSourceNotificationType, getMuiltiplexDataBlock, getNumAnnotations, getNumMuiltiplexDataBlocks, getNumOutputDataBlocks, getObserverName, getObserverObject, getOfflineData, getOfflineData, getOutputDataBlock, getOutputDataBlocks, getPamControlledUnit, getParentDataBlock, getParentDataBlocks, getParentProcess, getProcessCheck, getProcessName, getRawSourceDataBlock, getRawSourceDataBlock, getSampleRate, getSourceDataBlock, getSourceProcess, hasOutputDatablock, isCanMultiThread, isExternalProcess, isMultiplex, makePamProcess, masterClockUpdate, noteNewSettings, prepareProcessOK, processNewBuoyData, receiveSourceNotification, relMillisecondsToSamples, relSamplesToMilliseconds, removeAllDataBlocks, removeAllMultiPlexDataBlocks, removeMultiPlexDataBlock, removeObservable, removeOutputDatablock, resetDataBlocks, saveViewerData, setCanMultiThread, setExternalProcess, setMultiplex, setParentDataBlock, setParentDataBlock, setProcessCheck, setProcessName, setSampleRate, setupProcess, toString, updateData

Methods inherited from class java.lang.Object

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

Constructor Details

BeamFormLocProcess

public BeamFormLocProcess(BeamFormLocaliserControl beamFormerLocaliserControl)

Method Details

prepareProcess

public void prepareProcess()

Description copied from class: PamProcess

Called for each process before any of them receive the PamStart command

Overrides:

prepareProcess in class BeamFormerBaseProcess

findFFTDataBlock

public FFTDataBlock findFFTDataBlock()

Description copied from class: BeamFormerBaseProcess

Find the source of FFT data for the beam former. this may not be the same as the main data source if the main source is raw or detection data (overridden in BeamFormLocProcess).

Overrides:

findFFTDataBlock in class BeamFormerBaseProcess

Returns:

FFT source for the beam former.

pamStart

public void pamStart()

Description copied from class: PamProcess

Called for each process to tell it to start (may not be necessary for processes which are listening for data anyway).

Specified by:

pamStart in class PamProcess

pamStop

public void pamStop()

Description copied from class: PamProcess

Stops the process.

Specified by:

pamStop in class PamProcess

getRequiredDataHistory

public long getRequiredDataHistory(PamObservable o,
 Object arg)

Specified by:

getRequiredDataHistory in interface PamObserver

Overrides:

getRequiredDataHistory in class PamProcess

Parameters:

arg - optional argument from PamObservable

Returns:

time in milliseconds required by data held in PamObservable

newData

public void newData(PamObservable o,
 PamDataUnit arg)

Overrides:

newData in class PamProcess

beamFormDataUnit

public boolean beamFormDataUnit(PamDataUnit pamDataUnit)

Run the beam former within the given time-frequency box.

Parameters:

timeRange -

freqRange -

markChannels -

beamFormGroup

public boolean beamFormGroup(PamDataUnit pamDataUnit,
 beamformer.localiser.BeamFormLocProcess.BeamOGroup beamGroup)

Beam for a data unit within a particular beam group.

Parameters:

pamDataUnit - data unit

beamGroup - beam group

Returns:

true if successful

getBeamFormerLocaliserControl

public BeamFormLocaliserControl getBeamFormerLocaliserControl()

Returns:

the beamFormerLocaliserControl