simulatedAcquisition
Class SimProcess

java.lang.Object
  Acquisition.DaqSystem
      simulatedAcquisition.SimProcess

All Implemented Interfaces:

PamSettings

public class SimProcess
extends DaqSystem
implements PamSettings

Simulation of simulated sound.

Sound simulated on a time at approximately 10x real time

Slow it down with a sound playback module if needs be.

Controls creation and movement of simulated objects

Author:

Doug Gillespie

Nested Class Summary

(package private) class	SimProcess.GenerationThread Generates data as fast as it can.
private class	SimProcess.SimMouseAdapter

Field Summary

private PamArray	currentArray
private AcquisitionControl	daqControl
private int	dataUnitSamples
private boolean	dontStop
private SimProcess.GenerationThread	genThread
protected java.util.List<RawDataUnit>	newDataUnits
private PropagationModel	propagationModel
protected java.util.ArrayList<PropagationModel>	propagationModels
private java.util.Random	random
private SimDialogPanel	simdialogPanel
private SimGraphics	simGraphics
private SimProcess.SimMouseAdapter	simMouseAdapter
private SimObjectsDataBlock	simObjectsDataBlock
(package private) SimParameters	simParameters
protected SimSignals	simSignals
private long	startTimeMillis
private boolean	stillRunning
private java.lang.Thread	theThread
private long	totalSamples
private boolean	wasSelected

Fields inherited from class Acquisition.DaqSystem

PARAMETER_FIXED, PARAMETER_UNKNOWN, STREAM_CLOSED, STREAM_ENDED, STREAM_OPEN, STREAM_PAUSED, STREAM_RUNNING

Constructor Summary

SimProcess(AcquisitionControl daqControl)

Method Summary

boolean	canPlayBack(float sampleRate)
void	daqHasEnded() Called after DAQ has stopped - for whatever reason.
boolean	dialogGetParams() Called by AcquisitionDialog.GetParams so that parameters can be extracted from the dialog component.
void	dialogSetParams() Called by AcquisitionDialog.SetParams so that the dialog componenet can update it's fields
private void	generateData()
private void	generateNoise(double[] data, double noise)
private void	generateSignals(SimObjectDataUnit sdu, double[] data, int phone, long startSample)
AcquisitionControl	getDaqControl()
javax.swing.JComponent	getDaqSpecificDialogComponent(AcquisitionDialog acquisitionDialog) The AcquisitionDialog has been designed to that each data source type can plug in it's own panel of device specific controls.
int	getDataUnitSamples()
java.lang.String	getDeviceName() Gets a name for the acquisition device (may just be a number but need to generalise).
int	getMaxChannels()
int	getMaxSampleRate()
double	getPeak2PeakVoltage(int swChannel)
PropagationModel	getPropagationModel()
PropagationModel	getPropagationModel(java.lang.String propName)
float	getSampleRate()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.String	getSystemName()
java.lang.String	getSystemType()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
boolean	isRealTime()
void	notifyArrayChanged()
boolean	prepareSystem(AcquisitionControl daqControl) Prepare the DaqSystem.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
private void	setArray()
void	setPropagationModel(PropagationModel propagationModel)
void	setSelected(boolean select) Tell a DAQ system it's been selected or deselected.
protected void	setupObjects()
protected void	setupSim()
private void	sortMapMice()
boolean	startSystem(AcquisitionControl daqControl) Start the DaqSystem.
void	stopSystem(AcquisitionControl daqControl) Stop the DaqSystem.
private void	updateObjectPosition(long timeMilliseconds, SimObjectDataUnit simObjectDataUnit)
private void	updateObjectPositions(long timeMilliseconds)

Methods inherited from class Acquisition.DaqSystem

areSampleSettingsOk, getDaqSpecificChannelListPanel, getInputChannelMap, getPlaybackSystem, getStatusBarComponent, getStreamStatus, setStreamStatus, showSampleSettingsDialog, supportsChannelLists

Methods inherited from class java.lang.Object

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

Field Detail

daqControl

private AcquisitionControl daqControl

simObjectsDataBlock

private SimObjectsDataBlock simObjectsDataBlock

currentArray

private PamArray currentArray

random

private java.util.Random random

totalSamples

private long totalSamples

startTimeMillis

private long startTimeMillis

simParameters

SimParameters simParameters

simdialogPanel

private SimDialogPanel simdialogPanel

simGraphics

private SimGraphics simGraphics

dontStop

private volatile boolean dontStop

stillRunning

private volatile boolean stillRunning

genThread

private SimProcess.GenerationThread genThread

theThread

private java.lang.Thread theThread

newDataUnits

protected java.util.List<RawDataUnit> newDataUnits

simMouseAdapter

private SimProcess.SimMouseAdapter simMouseAdapter

simSignals

protected SimSignals simSignals

propagationModels

protected java.util.ArrayList<PropagationModel> propagationModels

propagationModel

private PropagationModel propagationModel

wasSelected

private boolean wasSelected

dataUnitSamples

private int dataUnitSamples

Constructor Detail

SimProcess

public SimProcess(AcquisitionControl daqControl)

Method Detail

sortMapMice

private void sortMapMice()

setSelected

public void setSelected(boolean select)

Description copied from class: DaqSystem

Tell a DAQ system it's been selected or deselected.

Overrides:

setSelected in class DaqSystem

setupObjects

protected void setupObjects()

setupSim

protected void setupSim()

getPropagationModel

public PropagationModel getPropagationModel()

getPropagationModel

public PropagationModel getPropagationModel(java.lang.String propName)

setPropagationModel

public void setPropagationModel(PropagationModel propagationModel)

updateObjectPositions

private void updateObjectPositions(long timeMilliseconds)

updateObjectPosition

private void updateObjectPosition(long timeMilliseconds,
                                  SimObjectDataUnit simObjectDataUnit)

notifyArrayChanged

public void notifyArrayChanged()

getSampleRate

public float getSampleRate()

setArray

private void setArray()

generateData

private void generateData()

generateSignals

private void generateSignals(SimObjectDataUnit sdu,
                             double[] data,
                             int phone,
                             long startSample)

generateNoise

private void generateNoise(double[] data,
                           double noise)

canPlayBack

public boolean canPlayBack(float sampleRate)

Specified by:

canPlayBack in class DaqSystem

Returns:

true if the system can also play back sound - likely to be true for sound cards and ASIO, and some NI cards, false for wav files. Simulator ?

daqHasEnded

public void daqHasEnded()

Description copied from class: DaqSystem

Called after DAQ has stopped - for whatever reason. Nost DAQ systems will not need to do anything here, but they could potentially clean up memory The motivation for putting this here now is for the folder analysis system so that it can start analysing the next file.

Specified by:

daqHasEnded in class DaqSystem

dialogGetParams

public boolean dialogGetParams()

Description copied from class: DaqSystem

Called by AcquisitionDialog.GetParams so that parameters can be extracted from the dialog component. The DaqSystem should also implement PamSettings and handle storage of parameters between runs.

Specified by:

dialogGetParams in class DaqSystem

Returns:

true if the parameters and selections are OK. If false is returned the Acquisition dialog will not respond to its Ok button.

dialogSetParams

public void dialogSetParams()

Description copied from class: DaqSystem

Called by AcquisitionDialog.SetParams so that the dialog componenet can update it's fields

Specified by:

dialogSetParams in class DaqSystem

getDaqSpecificDialogComponent

public javax.swing.JComponent getDaqSpecificDialogComponent(AcquisitionDialog acquisitionDialog)

Description copied from class: DaqSystem

The AcquisitionDialog has been designed to that each data source type can plug in it's own panel of device specific controls. These could be things like a file name, gain settings, channel lists, whatever is available for the specific device

The AcquisitionDialog will handle placing this component on the dialog when a particular DaqSystem is selected. The component will be placed between a drop down list of available DaqSystem's and a section of the dialog showing the sample rate and number of channels.

Specified by:

getDaqSpecificDialogComponent in class DaqSystem

Parameters:

acquisitionDialog - the AcquisitionDialog this component will be added to

Returns:

dialog component specific to this DAQ device

getMaxChannels

public int getMaxChannels()

Specified by:

getMaxChannels in class DaqSystem

Returns:

the maximum number of channels supporrted by the selected device, or PARAMETER_UNKNOWN

getMaxSampleRate

public int getMaxSampleRate()

Specified by:

getMaxSampleRate in class DaqSystem

Returns:

the maximum sample rate supporrted by the selected device, or PARAMETER_UNKNOWN

getPeak2PeakVoltage

public double getPeak2PeakVoltage(int swChannel)

Specified by:

getPeak2PeakVoltage in class DaqSystem

Returns:

peak to peak voltage for the device or PARAMETER_UNKNOWN

getSystemName

public java.lang.String getSystemName()

Specified by:

getSystemName in class DaqSystem

Returns:

A string describing the data source, e.g. the sound card name, file name, udp port, etc.

getSystemType

public java.lang.String getSystemType()

Specified by:

getSystemType in class DaqSystem

Returns:

The 'type' of data source for display in the Data Source dialog

Calling functions should be able to handle 'null'

isRealTime

public boolean isRealTime()

Specified by:

isRealTime in class DaqSystem

Returns:

true for real time systems (e.g. sound cards, NI cards, wav files which are being played back over speakers. false for reading files which are to be processed as fast as possible with no playback.

prepareSystem

public boolean prepareSystem(AcquisitionControl daqControl)

Description copied from class: DaqSystem

Prepare the DaqSystem.

Usually this is the time for opening files, preparing data buffers, etc.

Specified by:

prepareSystem in class DaqSystem

Parameters:

daqControl - AcquisitionControl unit.

Returns:

true if OK, false otherwise.

getDataUnitSamples

public int getDataUnitSamples()

Specified by:

getDataUnitSamples in class DaqSystem

Returns:

the number of samples expected in each data unit.

startSystem

public boolean startSystem(AcquisitionControl daqControl)

Description copied from class: DaqSystem

Start the DaqSystem. This is called immediately after PrepareSystem

Most things should be ready from the call to PrepareSystem. In StartSystem you will generally need to start a thread which will read in the data and place PamDataUnits in a buffer from where they are read by the main thred and passed on to other Pam modules for processing (see SoundCardSystem for an example)

Specified by:

startSystem in class DaqSystem

Parameters:

daqControl - AcquisitionControl unit.

Returns:

true if OK, false otherwise

stopSystem

public void stopSystem(AcquisitionControl daqControl)

Description copied from class: DaqSystem

Stop the DaqSystem.

Specified by:

stopSystem in class DaqSystem

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getDaqControl

public AcquisitionControl getDaqControl()

getDeviceName

public java.lang.String getDeviceName()

Description copied from class: DaqSystem

Gets a name for the acquisition device (may just be a number but need to generalise).

Specified by:

getDeviceName in class DaqSystem

Returns: