edu.sc.seis.TauP
Class TauP_Path

java.lang.Object
  extended by edu.sc.seis.TauP.TauP_Time
      extended by edu.sc.seis.TauP.TauP_Pierce
          extended by edu.sc.seis.TauP.TauP_Path
Direct Known Subclasses:
TauP_Wavefront

public class TauP_Path
extends TauP_Pierce

Calculate travel paths for different phases using a linear interpolated ray parameter between known slowness samples.


Field Summary
protected  boolean gmtScript
           
protected  float mapWidth
           
protected  java.lang.String mapWidthUnit
           
protected static double maxPathInc
           
protected  java.lang.String psFile
           
 
Fields inherited from class edu.sc.seis.TauP.TauP_Pierce
addDepth, onlyAddPoints, onlyRevPoints, onlyTurnPoints, onlyUnderPoints
 
Fields inherited from class edu.sc.seis.TauP.TauP_Time
arrivals, azimuth, backAzimuth, DEBUG, degrees, depth, eventLat, eventLon, expert, GUI, modelName, onlyPrintRayP, onlyPrintTime, outFile, outForms, phaseNames, phases, relativeArrival, relativePhaseName, stationLat, stationLon, tMod, tModDepth, toolProps, verbose, writer
 
Constructor Summary
protected TauP_Path()
           
  TauP_Path(java.lang.String modelName)
           
  TauP_Path(java.lang.String modelName, java.lang.String outFileBase)
           
  TauP_Path(TauModel tMod)
           
  TauP_Path(TauModel tMod, java.lang.String outFileBase)
           
 
Method Summary
 void calcPath(double degrees)
           
 void calculate(double degrees)
           
 void destroy()
           
 float getMapWidth()
          Gets the gmt map width to be used with the output script and for creating the circles for each discontinuity.
static double getMaxPathInc()
           
 boolean isGmtScript()
           
static void main(java.lang.String[] args)
          Allows TauP_Path to run as an application.
 java.lang.String[] parseCmdLineArgs(java.lang.String[] args)
           
protected  void printLatLon(java.io.Writer out, double calcDist)
           
 void printResult(java.io.PrintWriter out)
           
 void printScriptBeginning(java.io.PrintWriter out)
          a noop that allows overriding classes to print things before results are calculated.
 void printScriptBeginning(java.io.PrintWriter out, java.lang.String psFile)
           
 void printUsage()
          prints the known command line flags.
 void setGmtScript(boolean gmtScript)
           
 void setMapWidth(float mapWidth)
          Sets the gmt map width to be used with the output script and for creating the circles for each discontinuity.
static void setMaxPathInc(double max)
           
 void setOutFileBase(java.lang.String outFileBase)
          Sets the output file base, appending ".gmt" for the filename.
 void start()
           
 
Methods inherited from class edu.sc.seis.TauP.TauP_Pierce
appendAddDepths, calcPierce, depthCorrect, isAddDepth, parseAddDepthsList, setAddDepths, setOnlyAddPoints, setOnlyRevPoints, setOnlyTurnPoints, setOnlyUnderPoints
 
Methods inherited from class edu.sc.seis.TauP.TauP_Time
appendPhaseName, appendPhaseName, calcTime, clearArrivals, clearPhaseNames, dashEquals, getArrival, getArrivals, getDisconDepths, getNumArrivals, getNumPhases, getPhaseNames, getPhaseNames, getPhaseNameString, getSeismicPhases, getSourceDepth, getTauModel, getTauModelName, getWriter, init, loadTauModel, parseDegreeList, parsePhaseList, printHelp, printNoComprendoArgs, printStdUsage, printStdUsageHead, printStdUsageHead, printStdUsageTail, readPhaseFile, readTauModel, recalcPhases, setPhaseNames, setPhaseNames, setSourceDepth, setTauModel, sortArrivals
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mapWidthUnit

protected java.lang.String mapWidthUnit

mapWidth

protected float mapWidth

gmtScript

protected boolean gmtScript

psFile

protected java.lang.String psFile

maxPathInc

protected static double maxPathInc
Constructor Detail

TauP_Path

protected TauP_Path()

TauP_Path

public TauP_Path(TauModel tMod)
          throws TauModelException
Throws:
TauModelException

TauP_Path

public TauP_Path(java.lang.String modelName)
          throws TauModelException
Throws:
TauModelException

TauP_Path

public TauP_Path(TauModel tMod,
                 java.lang.String outFileBase)
          throws TauModelException
Throws:
TauModelException

TauP_Path

public TauP_Path(java.lang.String modelName,
                 java.lang.String outFileBase)
          throws TauModelException
Throws:
TauModelException
Method Detail

setOutFileBase

public void setOutFileBase(java.lang.String outFileBase)
Sets the output file base, appending ".gmt" for the filename.


setMapWidth

public void setMapWidth(float mapWidth)
Sets the gmt map width to be used with the output script and for creating the circles for each discontinuity. Default is 6 inches.


getMapWidth

public float getMapWidth()
Gets the gmt map width to be used with the output script and for creating the circles for each discontinuity.


isGmtScript

public boolean isGmtScript()

setGmtScript

public void setGmtScript(boolean gmtScript)

getMaxPathInc

public static double getMaxPathInc()

setMaxPathInc

public static void setMaxPathInc(double max)

calculate

public void calculate(double degrees)
               throws TauModelException
Overrides:
calculate in class TauP_Pierce
Throws:
TauModelException

calcPath

public void calcPath(double degrees)

printResult

public void printResult(java.io.PrintWriter out)
                 throws java.io.IOException
Overrides:
printResult in class TauP_Pierce
Throws:
java.io.IOException

printLatLon

protected void printLatLon(java.io.Writer out,
                           double calcDist)
                    throws java.io.IOException
Throws:
java.io.IOException

printScriptBeginning

public void printScriptBeginning(java.io.PrintWriter out)
                          throws java.io.IOException
Description copied from class: TauP_Time
a noop that allows overriding classes to print things before results are calculated. For example to set up GMT commands before drawing paths.

Overrides:
printScriptBeginning in class TauP_Time
Throws:
java.io.IOException

printScriptBeginning

public void printScriptBeginning(java.io.PrintWriter out,
                                 java.lang.String psFile)
                          throws java.io.IOException
Throws:
java.io.IOException

printUsage

public void printUsage()
Description copied from class: TauP_Pierce
prints the known command line flags.

Overrides:
printUsage in class TauP_Pierce

parseCmdLineArgs

public java.lang.String[] parseCmdLineArgs(java.lang.String[] args)
                                    throws java.io.IOException
Overrides:
parseCmdLineArgs in class TauP_Pierce
Throws:
java.io.IOException

start

public void start()
           throws java.io.IOException,
                  TauModelException,
                  TauPException
Overrides:
start in class TauP_Time
Throws:
java.io.IOException
TauModelException
TauPException

destroy

public void destroy()
             throws java.io.IOException
Overrides:
destroy in class TauP_Time
Throws:
java.io.IOException

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_Path to run as an application. Creates an instance of TauP_Path and calls TauP_Path.init() and TauP_Path.start().

Throws:
java.io.FileNotFoundException
java.io.IOException
java.io.StreamCorruptedException
java.lang.ClassNotFoundException
java.io.OptionalDataException