propagation

Class SurfaceEcho

java.lang.Object

propagation.SurfaceEcho

All Implemented Interfaces:

PropagationModel

public class SurfaceEcho
extends java.lang.Object
implements PropagationModel

Constructor Summary

Constructors

Constructor and Description
SurfaceEcho(PropagationModel basePropagation)

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getDelays() Get the time delays for each path
double[]	getGains() Get the gains for each path
java.lang.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, double hydrophoneHeight, LatLong sourceLatLong, double sourceHeight, double speedOfSound) Set the locations of hydrophone and the source
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SurfaceEcho

public SurfaceEcho(PropagationModel basePropagation)

Method Detail

setLocations

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

Description copied from interface: PropagationModel

Set the locations of hydrophone and the source

Specified by:

setLocations in interface PropagationModel

sourceHeight - - i.e. normally this will be negative within the code even 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 java.lang.String getName()

Specified by:

getName in interface PropagationModel

Returns:

name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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.