Package edu.sc.seis.TauP
Class TauP_Path
- java.lang.Object
-
- edu.sc.seis.TauP.TauP_Tool
-
- edu.sc.seis.TauP.TauP_Time
-
- edu.sc.seis.TauP.TauP_Pierce
-
- 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
Fields Modifier and Type Field Description protected boolean
gmtScript
protected float
mapWidth
protected java.lang.String
mapWidthUnit
protected static double
maxPathInc
protected float
maxPathTime
protected java.lang.String
psFile
protected boolean
withTime
-
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, DEFAULT_PHASES, degreesList, depth, distKilometersList, eventLat, eventLon, GUI, modelName, onlyFirst, onlyPrintRayP, onlyPrintTime, phaseNames, receiverDepth, relativePhaseName, scattererDepth, scattererDistDeg, shootRayp, stationLat, stationLon, takeoffAngle, tMod, tModDepth
-
Fields inherited from class edu.sc.seis.TauP.TauP_Tool
cmdLineArgs, CSV, DEBUG, GMT, JSON, outFileBase, outForms, outputFormat, SVG, TEXT, toolProps, verbose, writer
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String[]
allowedOutputFormats()
java.util.List<Arrival>
calculate(java.util.List<java.lang.Double> degreesList)
float
getMapWidth()
Gets the gmt map width to be used with the output script and for creating the circles for each discontinuity.java.lang.String
getMapWidthUnit()
static double
getMaxPathInc()
float
getMaxPathTime()
java.lang.String
getOutFileExtension()
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
printDistRadius(java.io.Writer out, double calcDist, double radius)
protected void
printDistRadiusAsXY(java.io.Writer out, double calcDist, double radius)
protected void
printLatLon(java.io.Writer out, double calcDist, double endDist)
void
printLimitUsage()
void
printResult(java.io.PrintWriter out)
void
printResultJSON(java.io.PrintWriter out)
void
printResultSVG(java.io.PrintWriter out)
void
printResultText(java.io.PrintWriter out)
Print Path as text for use in GMT script.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
printScriptBeginningSVG(java.io.PrintWriter out)
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.void
setMapWidthUnit(java.lang.String mapWidthUnit)
static void
setMaxPathInc(double max)
void
setMaxPathTime(float maxPathTime)
void
start()
-
Methods inherited from class edu.sc.seis.TauP.TauP_Pierce
appendAddDepths, depthCorrect, isAddDepth, parseAddDepthsList, setAddDepths, setOnlyAddPoints, setOnlyRevPoints, setOnlyTurnPoints, setOnlyUnderPoints, splitPierceDepths
-
Methods inherited from class edu.sc.seis.TauP.TauP_Time
appendPhaseName, appendPhaseName, calcEventStation, calcRayParameter, calcRayParameter, calcRayParameterSDeg, calcTakeoff, calcTakeoff, calcTime, calcTime, calculate, calculateRelativeArrival, clearArrivals, clearPhaseNames, clearPhases, depthCorrect, depthCorrect, depthCorrect, destroy, extractPhaseNames, getArrival, getArrivals, getDisconDepths, getNumArrivals, getNumPhases, getPhaseNames, getPhaseNames, getPhaseNameString, getReceiverDepth, getScattererDepth, getScattererDistDeg, getSeismicPhases, getSourceDepth, getTauModel, getTauModelDepthCorrected, getTauModelName, init, linearInterp, loadTauModel, parseDegreeList, parsePhaseList, parseSourceModelCmdLineArgs, printDistanceUsage, printHelp, printPhaseUsage, printStdUsage, printStdUsageHead, readPhaseFile, readTauModel, recalcPhases, resultAsJSON, resultAsJSON, setEventLatLon, setPhaseNames, setPhaseNames, setReceiverDepth, setScatterer, setScattererDepth, setScattererDistDeg, setSourceDepth, setStationLatLon, setTauModel, sortArrivals, splitPhaseNameList, validateArguments
-
Methods inherited from class edu.sc.seis.TauP.TauP_Tool
closeWriter, configDefaults, dashEquals, endGmtAndCleanUp, getOutFile, getOutFileBase, getOutputFormat, getWriter, parseCommonCmdLineArgs, printModDepthUsage, printNoComprendoArgs, printStdUsageHead, printStdUsageTail, setOutFileBase, setOutFileExtension, setOutputFormat, setWriter, toolNameFromClass
-
-
-
-
Field Detail
-
mapWidthUnit
protected java.lang.String mapWidthUnit
-
mapWidth
protected float mapWidth
-
gmtScript
protected boolean gmtScript
-
withTime
protected boolean withTime
-
psFile
protected java.lang.String psFile
-
maxPathTime
protected float maxPathTime
-
maxPathInc
protected static double maxPathInc
-
-
Constructor Detail
-
TauP_Path
public 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
-
allowedOutputFormats
public java.lang.String[] allowedOutputFormats()
- Overrides:
allowedOutputFormats
in classTauP_Time
-
getOutFileExtension
public java.lang.String getOutFileExtension()
- Overrides:
getOutFileExtension
in classTauP_Tool
-
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.
-
getMapWidthUnit
public java.lang.String getMapWidthUnit()
-
setMapWidthUnit
public void setMapWidthUnit(java.lang.String mapWidthUnit)
-
getMaxPathTime
public float getMaxPathTime()
-
setMaxPathTime
public void setMaxPathTime(float maxPathTime)
-
isGmtScript
public boolean isGmtScript()
-
setGmtScript
public void setGmtScript(boolean gmtScript)
-
getMaxPathInc
public static double getMaxPathInc()
-
setMaxPathInc
public static void setMaxPathInc(double max)
-
calculate
public java.util.List<Arrival> calculate(java.util.List<java.lang.Double> degreesList) throws TauModelException
- Overrides:
calculate
in classTauP_Pierce
- Throws:
TauModelException
-
printResult
public void printResult(java.io.PrintWriter out) throws java.io.IOException
- Overrides:
printResult
in classTauP_Time
- Throws:
java.io.IOException
-
printResultText
public void printResultText(java.io.PrintWriter out) throws java.io.IOException
Print Path as text for use in GMT script.- Overrides:
printResultText
in classTauP_Pierce
- Parameters:
out
-- Throws:
java.io.IOException
-
printResultSVG
public void printResultSVG(java.io.PrintWriter out) throws java.io.IOException
- Throws:
java.io.IOException
-
printResultJSON
public void printResultJSON(java.io.PrintWriter out)
- Overrides:
printResultJSON
in classTauP_Pierce
-
printDistRadiusAsXY
protected void printDistRadiusAsXY(java.io.Writer out, double calcDist, double radius) throws java.io.IOException
- Throws:
java.io.IOException
-
printDistRadius
protected void printDistRadius(java.io.Writer out, double calcDist, double radius) throws java.io.IOException
- Throws:
java.io.IOException
-
printLatLon
protected void printLatLon(java.io.Writer out, double calcDist, double endDist) 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_Tool
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 classTauP_Tool
- Throws:
java.io.IOException
-
printScriptBeginningSVG
public void printScriptBeginningSVG(java.io.PrintWriter out) throws java.io.IOException
- Throws:
java.io.IOException
-
printScriptBeginning
public void printScriptBeginning(java.io.PrintWriter out, java.lang.String psFile) throws java.io.IOException
- Throws:
java.io.IOException
-
printLimitUsage
public void printLimitUsage()
- Overrides:
printLimitUsage
in classTauP_Pierce
-
printUsage
public void printUsage()
Description copied from class:TauP_Pierce
prints the known command line flags.- Overrides:
printUsage
in classTauP_Pierce
-
parseCmdLineArgs
public java.lang.String[] parseCmdLineArgs(java.lang.String[] args) throws java.io.IOException
- Overrides:
parseCmdLineArgs
in classTauP_Pierce
- Throws:
java.io.IOException
-
start
public void start() throws java.io.IOException, TauModelException, TauPException
- Overrides:
start
in classTauP_Time
- Throws:
java.io.IOException
TauModelException
TauPException
-
main
public static void main(java.lang.String[] args) throws java.io.IOException
Allows TauP_Path to run as an application. Creates an instance of TauP_Path and calls TauP_Path.init() and TauP_Path.start(). ToolRun.main should be used instead.- Throws:
java.io.IOException
-
-