edu.sc.seis.TauP
Class SeismicPhase

java.lang.Object
  |
  +--edu.sc.seis.TauP.SeismicPhase
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SeismicPhase
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Stores and transforms seismic phase names to and from their corresponding sequence of branches.

See Also:
Serialized Form

Field Summary
 boolean DEBUG
          Enables debugging output.
static boolean PWAVE
           
static boolean SWAVE
           
 boolean verbose
          Enables verbose output.
 
Constructor Summary
SeismicPhase(java.lang.String name, TauModel tMod)
           
 
Method Summary
 void calcPath(TauModel tMod)
          calculates the path this phase takes through the earth model.
 void calcPierce(TauModel tMod)
          Calculates the "pierce points" for the arrivals stored in arrivals.
 void calcTime(double deg)
          calculates arrival times for this phase.
 java.lang.Object clone()
          Returns an independent clone of the SeismicPhase.
 int closestBranchToDepth(TauModel tMod, java.lang.String depthString)
          Finds the closest discontinuity to the given depth that can have refletions and phase transformations.
 void dump()
           
 Arrival[] getArrivals()
          Returns arrival time array.
 double[] getDist()
           
 java.lang.String[] getLegs()
           
 double getMaxDiffraction()
           
 double getMaxDistance()
           
 double getMaxRayParam()
           
 int getMaxRayParamIndex()
           
 double getMinDistance()
           
 double getMinRayParam()
           
 int getMinRayParamIndex()
           
 java.lang.String getName()
           
 java.lang.String getPuristName()
           
 double[] getRayParams()
           
 double[] getTau()
           
 TauModel getTauModel()
           
 double[] getTime()
           
 boolean hasArrivals()
           
 void init()
           
static void main(java.lang.String[] args)
           
 boolean phaseValidate()
          Performs consistency checks on the previously tokenized phase name stored in legs.
 void setDEBUG(boolean DEBUG)
           
 void setMaxDiffraction(double maxDiffraction)
           
 void setTauModel(TauModel tMod)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEBUG

public transient boolean DEBUG
Enables debugging output.

verbose

public transient boolean verbose
Enables verbose output.

PWAVE

public static final boolean PWAVE

SWAVE

public static final boolean SWAVE
Constructor Detail

SeismicPhase

public SeismicPhase(java.lang.String name,
                    TauModel tMod)
Parameters:
phaseName - String containing a name of the phase.
tMod - Tau model to be used to construct the phase.
Method Detail

hasArrivals

public boolean hasArrivals()

getArrivals

public Arrival[] getArrivals()
Returns arrival time array.

setTauModel

public void setTauModel(TauModel tMod)
                 throws TauModelException

getTauModel

public TauModel getTauModel()

setDEBUG

public void setDEBUG(boolean DEBUG)

getMinDistance

public double getMinDistance()

getMaxDistance

public double getMaxDistance()

getMaxRayParam

public double getMaxRayParam()

getMinRayParam

public double getMinRayParam()

getMaxRayParamIndex

public int getMaxRayParamIndex()

getMinRayParamIndex

public int getMinRayParamIndex()

getMaxDiffraction

public double getMaxDiffraction()

setMaxDiffraction

public void setMaxDiffraction(double maxDiffraction)

getName

public java.lang.String getName()

getPuristName

public java.lang.String getPuristName()

getLegs

public java.lang.String[] getLegs()

getRayParams

public double[] getRayParams()

getDist

public double[] getDist()

getTime

public double[] getTime()

getTau

public double[] getTau()

init

public void init()
          throws TauModelException

calcTime

public void calcTime(double deg)
calculates arrival times for this phase.

closestBranchToDepth

public int closestBranchToDepth(TauModel tMod,
                                java.lang.String depthString)
Finds the closest discontinuity to the given depth that can have refletions and phase transformations.

calcPierce

public void calcPierce(TauModel tMod)
                throws TauModelException
Calculates the "pierce points" for the arrivals stored in arrivals. The pierce points are stored within each arrival object.

calcPath

public void calcPath(TauModel tMod)
calculates the path this phase takes through the earth model.

phaseValidate

public boolean phaseValidate()
Performs consistency checks on the previously tokenized phase name stored in legs.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

dump

public void dump()

clone

public java.lang.Object clone()
Returns an independent clone of the SeismicPhase.

main

public static void main(java.lang.String[] args)