decimator

Class DecimatorProcess

java.lang.Object

PamguardMVC.PamProcess

decimator.DecimatorProcess

All Implemented Interfaces:

PamObserver, ProcessAnnotator

public class DecimatorProcess
extends PamProcess

Decimates data - i.e. reduces it's frequency by firswt of all digitally filtering, then downsampling

Author:

Doug Gillespie

Method Summary

Methods

Modifier and Type	Method and Description
int	getOfflineData(PamDataBlock dataBlock, PamObserver endUser, long startMillis, long endMillis, RequestCancellationObject cancellationObject) Request offline data.
PamRawDataBlock	getOutputDataBlock()
long	getRequiredDataHistory(PamObservable o, java.lang.Object arg)
void	masterClockUpdate(long milliSeconds, long sampleNumber)
void	newData(PamObservable obs, PamDataUnit newData)
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
void	setSampleRate(float sampleRate, boolean notify) New sample rate
void	setupProcess() called for every process once the systemmodel has been created.

Methods inherited from class PamguardMVC.PamProcess

absMillisecondsToSamples, absSamplesToMilliseconds, addOutputDataBlock, changedThreading, clearOldData, createAnnotations, destroyProcess, fillXMLElement, flushDataBlockBuffers, getAncestorDataBlock, getAnnotation, getChainPosition, getCpuPercent, getNumAnnotations, getNumOutputDataBlocks, getObserverName, getObserverObject, getOutputDataBlock, getOutputDataBlocks, getPamControlledUnit, getParentDataBlock, getParentProcess, getProcessName, getRawSourceDataBlock, getSampleRate, getSourceDataBlock, getSourceProcess, isCanMultiThread, makePamProcess, noteNewSettings, notifyModelChanged, processNewBuoyData, relMillisecondsToSamples, relSamplesToMilliseconds, removeAllDataBlocks, removeObservable, removeOutputDatablock, resetDataBlocks, saveViewerData, setCanMultiThread, setParentDataBlock, setParentDataBlock, setProcessName, toString, update, updateData

Methods inherited from class java.lang.Object

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

Method Detail

setupProcess

public void setupProcess()

Description copied from class: PamProcess

called for every process once the systemmodel has been created. this is a good time to check out and find input data blocks and similar tasks.

Overrides:

setupProcess in class PamProcess

getRequiredDataHistory

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

Specified by:

getRequiredDataHistory in interface PamObserver

Overrides:

getRequiredDataHistory in class PamProcess

Parameters:

o - PamObservable class requiring the data

arg - optional argument from PamObservable

Returns:

time in milliseconds requried by data held in PamObservable

setSampleRate

public void setSampleRate(float sampleRate,
                 boolean notify)

Description copied from interface: PamObserver

New sample rate

Specified by:

setSampleRate in interface PamObserver

Overrides:

setSampleRate in class PamProcess

notify - Notify other PamObservers and PamObservables in the chain.

masterClockUpdate

public void masterClockUpdate(long milliSeconds,
                     long sampleNumber)

Specified by:

masterClockUpdate in interface PamObserver

Overrides:

masterClockUpdate in class PamProcess

getOutputDataBlock

public PamRawDataBlock getOutputDataBlock()

Returns:

the outputDataBlock

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

newData

public void newData(PamObservable obs,
           PamDataUnit newData)

Overrides:

newData in class PamProcess

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 PamProcess

getOfflineData

public int getOfflineData(PamDataBlock dataBlock,
                 PamObserver endUser,
                 long startMillis,
                 long endMillis,
                 RequestCancellationObject cancellationObject)

Description copied from class: PamProcess

Request offline data.

This will be called from a PamDatablock in offline viewer mode from requestOfflineData(PamObserver observer, long startMillis, long endMillis).

this is used to request data from upstream processes, e.g. o get raw data to turn into FFT data units to go to the spectrogram display (possible going via decimators and any other processes before spitting out the right data.

Overrides:

getOfflineData in class PamProcess

Parameters:

dataBlock - data block making the request.

endUser - observer which made the original data request.

startMillis - start time in milliseconds

endMillis - end time in milliseconds.

Returns:

true if request can be satisfied (or partially satisfied).