All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class edu.sc.seis.TauP.TauBranch

edu.sc.seis.TauP.TauBranch

public class TauBranch
provides storage and methods for distance, time and tau increments for a branch. A branch is a group of layers bounded by discontinuities or reversals in slowness gradient.


Variable Index

 o DEBUG
Turns on debugging output.

Constructor Index

 o TauBranch(double, double, boolean)

Method Index

 o calcTimeDist(SlownessModel, int, int, double)
calculates the time and distance increments for the given ray parameter.
 o clone()
Returns a clone of this TauBranch object.
 o createBranch(SlownessModel, double, double[])
Calculates tau for this branch, between slowness layers topLayerNum and botLayerNum, inclusive.
 o getBotDepth()
 o getDist()
 o getMaxRayParam()
 o getMinRayParam()
 o getMinTurnRayParam()
 o getTau()
 o getTime()
 o getTopDepth()
 o path(double, boolean, SlownessModel)
 o readFromStream(DataInputStream)
 o shiftBranch(int)
 o toString()
 o writeToStream(DataOutputStream)

Variables

 o DEBUG
 public transient boolean DEBUG
Turns on debugging output.

Constructors

 o TauBranch
 public TauBranch(double topDepth,
                  double botDepth,
                  boolean isPWave)

Methods

 o getTopDepth
 public double getTopDepth()
Returns:
s the minimum (top) depth of this layer.
 o getBotDepth
 public double getBotDepth()
Returns:
s the maximum (bottom) depth of this layer.
 o getMaxRayParam
 public double getMaxRayParam()
Returns:
s the maximum ray parameter that can penetrate into this branch. Time, distance, and tau increments are undefined, set to 0.0, for ray parameters larger than this.
 o getMinTurnRayParam
 public double getMinTurnRayParam()
Returns:
s the minimum ray parameter that is turned, but not reflected, in this branch.
 o getMinRayParam
 public double getMinRayParam()
Returns:
s the minimum ray parameter that is turned or reflected in this branch.
 o getDist
 public double[] getDist()
Returns:
s an array, cloned, containing distance (radians) evaluated at the i_th ray parameter for this branch.
 o getTime
 public double[] getTime()
Returns:
s an array, cloned, containing time (seconds) evaluated at the i_th ray parameter for this branch.
 o getTau
 public double[] getTau()
Returns:
s an array, cloned, containing tau (seconds) evaluated at the i_th ray parameter for this branch.
 o createBranch
 public void createBranch(SlownessModel sMod,
                          double minPSoFar,
                          double rayParams[]) throws NoSuchLayerException, SlownessModelException, TauModelException
Calculates tau for this branch, between slowness layers topLayerNum and botLayerNum, inclusive.

Throws: NoSuchLayerException
if a needed slowness layer cannot be found.
Throws: SlownessModelException
if there is a problem with the slowness model
Throws: TauModelException
if the slownessmodel and taumodel are not compatible
 o calcTimeDist
 public TimeDist calcTimeDist(SlownessModel sMod,
                              int topLayerNum,
                              int botLayerNum,
                              double p) throws NoSuchLayerException, SlownessModelException
calculates the time and distance increments for the given ray parameter. The topDepth and botDepth must be correct as they determine the bounds on the integration/summing.

Throws: NoSuchLayerException
if topLayerNum or botLayerNum are not in the slowness model.
Throws: SlownessModelException
if the ray with ray parameter p turns within a layer instead of at the bottom.
 o shiftBranch
 public void shiftBranch(int index)
 o path
 public TimeDist[] path(double rayParam,
                        boolean downgoing,
                        SlownessModel sMod) throws SlownessModelException
 o writeToStream
 public void writeToStream(DataOutputStream dos) throws IOException
 o readFromStream
 public static TauBranch readFromStream(DataInputStream dis) throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException
 o clone
 public Object clone()
Returns a clone of this TauBranch object. Note that super.clone() handles all normal variables while the arrays need to be cloned separately to generate a new array as opposed to a new reference to the old array.

See Also:
Cloneable
 o toString
 public String toString()

All Packages  Class Hierarchy  This Package  Previous  Next  Index