edu.sc.seis.TauP
Class TauP_Time

java.lang.Object
  |
  +--edu.sc.seis.TauP.TauP_Time
Direct Known Subclasses:
TauP_Curve, TauP_Pierce, TauP_SetSac, TauP_Table

public class TauP_Time
extends java.lang.Object

Calculate travel times for different branches using linear interpolation between known slowness samples.


Field Summary
 boolean DEBUG
          Turns on debugging output.
 boolean verbose
          Turns on verbose output.
 
Constructor Summary
TauP_Time()
           
TauP_Time(java.lang.String modelName)
          creates a TauP_Time object with the tau model specified by modelName already loaded.
TauP_Time(TauModel tMod)
           
 
Method Summary
 void appendPhaseName(PhaseName phaseName)
           
 void appendPhaseName(java.lang.String phaseName)
           
 void calcTime(double degrees)
           
 void calculate(double degrees)
           
 void clearArrivals()
           
 void clearPhaseNames()
           
 void depthCorrect(double depth)
          corrects the TauModel for the given source depth.
 void destroy()
           
 Arrival getArrival(int i)
           
 Arrival[] getArrivals()
           
 double[] getDisconDepths()
           
 int getNumArrivals()
           
 int getNumPhases()
           
 java.lang.String[] getPhaseNames()
           
 java.lang.String getPhaseNameString()
           
 double getSourceDepth()
           
 TauModel getTauModel()
           
 java.lang.String getTauModelName()
           
 void init()
          preforms intialization of the tool.
 void loadTauModel(java.lang.String modelName)
           
static void main(java.lang.String[] args)
          Allows TauP_Time to run as an application.
 double[] parseDegreeList(java.lang.String degList)
          Parses a comma separated list of distances and returns them in an array.
 void parsePhaseList(java.lang.String phaseList)
          parses a comma separated list of phase names and adds them to the phaseNames vector.
 void printHelp()
           
 void printResult(java.io.DataOutputStream dos)
           
 void printResult(java.io.Writer out)
           
 void printStdUsage()
          Prints the command line arguments common to all TauP tools.
 void printStdUsageHead()
           
 void printStdUsageTail()
           
 void printUsage()
           
 void recalcPhases()
          reclaulates the given phases using a possibly new or changed tau model.
 void setPhaseNames(PhaseName[] phaseNames)
           
 void setPhaseNames(java.lang.String[] phaseNames)
           
 void setSourceDepth(double depth)
           
 void setTauModel(TauModel tMod)
           
 void sortArrivals()
           
 void start()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEBUG

public boolean DEBUG
Turns on debugging output.

verbose

public boolean verbose
Turns on verbose output.
Constructor Detail

TauP_Time

public TauP_Time()

TauP_Time

public TauP_Time(TauModel tMod)
          throws TauModelException

TauP_Time

public TauP_Time(java.lang.String modelName)
          throws TauModelException
creates a TauP_Time object with the tau model specified by modelName already loaded.
Throws:
TauModelException - if the file can't be found or is corrupted in some way.
Method Detail

getPhaseNames

public java.lang.String[] getPhaseNames()

getPhaseNameString

public java.lang.String getPhaseNameString()

setPhaseNames

public void setPhaseNames(java.lang.String[] phaseNames)

setPhaseNames

public void setPhaseNames(PhaseName[] phaseNames)

appendPhaseName

public void appendPhaseName(java.lang.String phaseName)

appendPhaseName

public void appendPhaseName(PhaseName phaseName)

getNumPhases

public int getNumPhases()

clearPhaseNames

public void clearPhaseNames()

getSourceDepth

public double getSourceDepth()

setSourceDepth

public void setSourceDepth(double depth)

getTauModelName

public java.lang.String getTauModelName()

getTauModel

public TauModel getTauModel()

setTauModel

public void setTauModel(TauModel tMod)

loadTauModel

public void loadTauModel(java.lang.String modelName)
                  throws java.io.FileNotFoundException,
                         java.io.InvalidClassException,
                         java.io.IOException,
                         java.io.StreamCorruptedException,
                         java.io.OptionalDataException,
                         TauModelException

getDisconDepths

public double[] getDisconDepths()

clearArrivals

public void clearArrivals()

getNumArrivals

public int getNumArrivals()

getArrival

public Arrival getArrival(int i)

getArrivals

public Arrival[] getArrivals()

parsePhaseList

public void parsePhaseList(java.lang.String phaseList)
parses a comma separated list of phase names and adds them to the phaseNames vector. Each phase can have an optional argument after a dash. This would be used for specifying which sac header to put the time in, or for other unforeseen uses. This may be called multiple times to append more phases. For example: P-0,PcP-1,ScP-4,Sn,SS,S^410S would, assuming no previous phases have been added, put P in T0, PcP in T1, ScP in T5, Sn in T2, SS in T3, and S^410S in T5.

parseDegreeList

public double[] parseDegreeList(java.lang.String degList)
Parses a comma separated list of distances and returns them in an array.

sortArrivals

public void sortArrivals()

calculate

public void calculate(double degrees)
               throws TauModelException

calcTime

public void calcTime(double degrees)

depthCorrect

public void depthCorrect(double depth)
                  throws TauModelException
corrects the TauModel for the given source depth. It only performs the correction of the model is not already corrected to that depth.

recalcPhases

public void recalcPhases()
reclaulates the given phases using a possibly new or changed tau model. This should not need to be called by outside classes as it is called by depthCorrect, and calculate.

printResult

public void printResult(java.io.DataOutputStream dos)
                 throws java.io.IOException

printResult

public void printResult(java.io.Writer out)
                 throws java.io.IOException

init

public void init()
          throws java.io.IOException
preforms intialization of the tool. Properties are queried for the the default model to load, source depth to use, phases to use, etc. Note that because of the IO inherent in these operations, this method is not appropriate for Applets. Applets should load TauModels themselves and use the setTauModel(TauModel) method.

printHelp

public void printHelp()

start

public void start()
           throws java.io.IOException,
                  TauModelException,
                  TauPException

destroy

public void destroy()
             throws java.io.IOException

printStdUsageHead

public void printStdUsageHead()

printStdUsage

public void printStdUsage()
Prints the command line arguments common to all TauP tools.

printStdUsageTail

public void printStdUsageTail()

printUsage

public void printUsage()

main

public static void main(java.lang.String[] args)
                 throws java.io.FileNotFoundException,
                        java.io.IOException,
                        java.io.StreamCorruptedException,
                        java.lang.ClassNotFoundException,
                        java.io.OptionalDataException
Allows TauP_Time to run as an application. Creates an instance of TauP_Time. .