Package propagation

Class SurfaceEcho

java.lang.Object

propagation.SurfaceEcho

All Implemented Interfaces:

PropagationModel

public class SurfaceEcho
extends Object
implements PropagationModel

Constructor Summary

Constructors

Constructor	Description
SurfaceEcho(PropagationModel basePropagation)

Method Summary

Modifier and Type	Method	Description
double[]	getDelays()	Get the time delays for each path
double[]	getGains()	Get the gains for each path
String	getName()
int	getNumPaths()	Get the number of propagation paths that will be returned
PamVector[]	getPointingVectors()	Get a list of vectors pointing from the sound source to the receiver (or it's apparent location for surface echos).
boolean	setLocations(LatLong hydrophoneLatLong, LatLong sourceLatLong, double speedOfSound)	Set the locations of hydrophone and the source
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SurfaceEcho

public SurfaceEcho(PropagationModel basePropagation)

Method Details

setLocations

public boolean setLocations(LatLong hydrophoneLatLong,
 LatLong sourceLatLong,
 double speedOfSound)

Description copied from interface: PropagationModel

Set the locations of hydrophone and the source

Specified by:

setLocations in interface PropagationModel

Parameters:

speedOfSound - though the dialog may show a positive number for depth !

Returns:

true if model ran OK

getDelays

public double[] getDelays()

Description copied from interface: PropagationModel

Get the time delays for each path

Specified by:

getDelays in interface PropagationModel

Returns:

delays in seconds

getGains

public double[] getGains()

Description copied from interface: PropagationModel

Get the gains for each path

These are the inverse of attenuation and are a scale factors NOT in dB so that surface reflections can be given a negative number

Specified by:

getGains in interface PropagationModel

Returns:

path gains.

getNumPaths

public int getNumPaths()

Description copied from interface: PropagationModel

Get the number of propagation paths that will be returned

Specified by:

getNumPaths in interface PropagationModel

Returns:

number of paths

getName

public String getName()

Specified by:

getName in interface PropagationModel

Returns:

name

toString

public String toString()

Overrides:

toString in class Object

getPointingVectors

public PamVector[] getPointingVectors()

Description copied from interface: PropagationModel

Get a list of vectors pointing from the sound source to the receiver (or it's apparent location for surface echos).

Specified by:

getPointingVectors in interface PropagationModel

Returns:

Vector pointing from source to receiver.