Package clickDetector.offlineFuncs

Class ClickWaveTask

java.lang.Object

offlineProcessing.OfflineTask<ClickDetection>

clickDetector.offlineFuncs.ClickWaveTask

public class ClickWaveTask
extends OfflineTask<ClickDetection>

Updates click waveform from raw audio data. This can be used to update the raw click waveform if, for example an unsuitable pre-filter was used.

For example, useful for situations where there are large annotated data sets were re-analysing clicks will destroy annotation UID reference in database.

This is highly experimental and not for general release. For this to work the must have been analysed from raw sound files. Those exact same files must be loaded as offline files in viewer mode. This will then, hopefully, extract the correct raw chunks of raw data.

Author:

Jamie Macaulay

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ClickWaveTask.RawLoadEndObserver	Observe the success of the data load

Constructor Summary

Constructors

Constructor	Description
ClickWaveTask(ClickControl clickControl)	Constructor for the click wave task.

Method Summary

Modifier and Type	Method	Description
boolean	canRun()	can the task be run ? This will generally be true, but may be false if the task is dependent on some other module which may not be present.
void	completeTask()	Called at the end of the thread which executes this task.
String	getName()
boolean	hasSettings()	task has settings which can be modified.
void	loadedDataComplete()	Called when processing of loaded data, or each map point worth of data, is complete.
void	newDataLoad(long startTime, long endTime, OfflineDataMapPoint mapPoint)	Called when new data are loaded for offline processing (or once at the start of processing loaded data).
void	prepareTask()	Called at the start of the thread which executes this task.
boolean	processDataUnit(ClickDetection click)	Process a single data unit.

Methods inherited from class offlineProcessing.OfflineTask

addAffectedDataBlock, addRequiredDataBlock, addRequiredDataBlock, addRequiredDataBlock, callSettings, callSettings, deleteOldData, deleteOldOutput, getAffectedBlocksList, getAffectedDataBlock, getDataBlock, getLongName, getNumAffectedDataBlocks, getNumRequiredDataBlocks, getOfflineTaskGroup, getParentControlledUnit, getRequiredDataBlock, getSettingsProviders, getTaskControlledUnit, getUnitName, getUnitType, isDoRun, setDoRun, setOfflineTaskGroup, setParentDataBlock, whyNot

Methods inherited from class java.lang.Object

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

Constructor Details

ClickWaveTask

public ClickWaveTask(ClickControl clickControl)

Constructor for the click wave task.

Parameters:

clickControl - - click control.

Method Details

getName

public String getName()

Specified by:

getName in class OfflineTask<ClickDetection>

Returns:

a name for the task, to be displayed in the dialog.

newDataLoad

public void newDataLoad(long startTime,
 long endTime,
 OfflineDataMapPoint mapPoint)

Description copied from class: OfflineTask

Called when new data are loaded for offline processing (or once at the start of processing loaded data).

Specified by:

newDataLoad in class OfflineTask<ClickDetection>

Parameters:

startTime - start time of loaded data

endTime - end time of loaded data

prepareTask

public void prepareTask()

Description copied from class: OfflineTask

Called at the start of the thread which executes this task.

Overrides:

prepareTask in class OfflineTask<ClickDetection>

processDataUnit

public boolean processDataUnit(ClickDetection click)

Description copied from class: OfflineTask

Process a single data unit.

Specified by:

processDataUnit in class OfflineTask<ClickDetection>

Returns:

true if the data unit has changed in some way so that it will need re-writing to it's binary file or database.

loadedDataComplete

public void loadedDataComplete()

Description copied from class: OfflineTask

Called when processing of loaded data, or each map point worth of data, is complete.

Specified by:

loadedDataComplete in class OfflineTask<ClickDetection>

hasSettings

public boolean hasSettings()

Description copied from class: OfflineTask

task has settings which can be modified. If this is true, then callSettings(Component component) should do something such as open a dialog or show a menu, or something.

Overrides:

hasSettings in class OfflineTask<ClickDetection>

Returns:

true or false

completeTask

public void completeTask()

Description copied from class: OfflineTask

Called at the end of the thread which executes this task.

Overrides:

completeTask in class OfflineTask<ClickDetection>

canRun

public boolean canRun()

Description copied from class: OfflineTask

can the task be run ? This will generally be true, but may be false if the task is dependent on some other module which may not be present.

Overrides:

canRun in class OfflineTask<ClickDetection>

Returns:

true if it's possible to run the task.