Package edu.sc.seis.TauP

Class TauP_Curve

java.lang.Object

edu.sc.seis.TauP.TauP_Tool

edu.sc.seis.TauP.TauP_Time

edu.sc.seis.TauP.TauP_Curve

Direct Known Subclasses:

TauP_Amp

public class TauP_Curve
extends TauP_Time

Calculates travel time curves at known slowness samples.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	distHorizontal
protected boolean	gmtScript	should the output file be a compete script?
protected float	mapWidth
protected java.lang.String	mapWidthUnit
protected boolean	reduceTime	should the output times use a reducing velocity?
protected double	reduceVel	the reducing velocity to use if reduceTime == true, in units of radians/second .
protected java.lang.String	redVelString

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

Constructor Summary

Constructors

Constructor	Description
TauP_Curve()
TauP_Curve(TauModel tMod)
TauP_Curve(java.lang.String modelName)

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	allowedOutputFormats()
double[]	calcPlotValue(double distRadian, double time, java.util.List<SeismicPhase> relPhase)
protected double[]	calcTimeValue(double distRadian, double time, java.util.List<SeismicPhase> relPhase)
java.util.List<Arrival>	calculate(java.util.List<java.lang.Double> degreesList)
protected void	checkBoundary(double boundaryDistRadian, int distIndex, SeismicPhase phase, java.util.List<SeismicPhase> relPhase, java.io.PrintWriter out)
void	destroy()
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()
java.lang.String	getOutFileExtension()
double	getReduceVelDeg()
double	getReduceVelKm()
java.lang.String	getStdUsage()	Prints the command line arguments common to all TauP tools.
java.lang.String	getUsage()
static boolean	isBetween(double a, double b, double value)
boolean	isGmtScript()
boolean	isReduceTime()
static void	main(java.lang.String[] args)	Allows TauP_Curve to run as an application.
java.lang.String[]	parseCmdLineArgs(java.lang.String[] args)
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	setDefaultOutputFormat()
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)
void	setReduceTime(boolean reduceTime)
void	setReduceVelDeg(double reduceVel)	set the reducing velocity, in degrees/second.
void	setReduceVelKm(double reduceVel)	set the reducing velocity, in kilometers/second.
void	start()
void	writeValue(double distRadian, double time, java.util.List<SeismicPhase> relPhase, java.io.PrintWriter out, boolean distHorizontal)

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, depthCorrect, extractPhaseNames, getArrival, getArrivals, getDisconDepths, getDistanceUsage, getLimitUsage, getNumArrivals, getNumPhases, getPhaseNames, getPhaseNames, getPhaseNameString, getPhaseUsage, getReceiverDepth, getScattererDepth, getScattererDistDeg, getSeismicPhases, getSourceDepth, getStdUsageHead, getTauModel, getTauModelDepthCorrected, getTauModelName, init, linearInterp, loadTauModel, parseDegreeList, parsePhaseList, parseSourceModelCmdLineArgs, printHelp, printResultJSON, printResultText, readPhaseFile, readTauModel, recalcPhases, resultAsJSON, resultAsJSONObject, setEventLatLon, setPhaseNames, setPhaseNames, setReceiverDepth, setScatterer, setScattererDepth, setScattererDistDeg, setSourceDepth, setStationLatLon, setTauModel, sortArrivals, splitPhaseNameList, validateArguments, writeJSON, writeJSON

Methods inherited from class edu.sc.seis.TauP.TauP_Tool

closeWriter, configDefaults, dashEquals, endGmtAndCleanUp, getModDepthUsage, getOutFile, getOutFileBase, getOutputFormat, getStdUsageHead, getStdUsageTail, getWriter, parseCommonCmdLineArgs, printNoComprendoArgs, printUsage, setOutFileBase, setOutFileExtension, setOutputFormat, setWriter, toolNameFromClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

gmtScript

protected boolean gmtScript

should the output file be a compete script?

reduceTime

protected boolean reduceTime

should the output times use a reducing velocity?

reduceVel

protected double reduceVel

the reducing velocity to use if reduceTime == true, in units of radians/second .

redVelString

protected java.lang.String redVelString

mapWidth

protected float mapWidth

mapWidthUnit

protected java.lang.String mapWidthUnit

distHorizontal

protected boolean distHorizontal

Constructor Detail

TauP_Curve

public TauP_Curve()

TauP_Curve

public TauP_Curve(TauModel tMod)
           throws TauModelException

Throws:

TauModelException

TauP_Curve

public TauP_Curve(java.lang.String modelName)
           throws TauModelException

Throws:

TauModelException

Method Detail

allowedOutputFormats

public java.lang.String[] allowedOutputFormats()

Overrides:

allowedOutputFormats in class TauP_Time

setDefaultOutputFormat

public void setDefaultOutputFormat()

Overrides:

setDefaultOutputFormat in class TauP_Time

getOutFileExtension

public java.lang.String getOutFileExtension()

Overrides:

getOutFileExtension in class TauP_Tool

isGmtScript

public boolean isGmtScript()

setGmtScript

public void setGmtScript(boolean gmtScript)

isReduceTime

public boolean isReduceTime()

setReduceTime

public void setReduceTime(boolean reduceTime)

getReduceVelDeg

public double getReduceVelDeg()

Returns:

reducing velocity in degrees/second. The internal usage is radians/second.

setReduceVelDeg

public void setReduceVelDeg(double reduceVel)

set the reducing velocity, in degrees/second. The internal representation is radians/second.

getReduceVelKm

public double getReduceVelKm()

Returns:

reducing velocity in kilometers/second. The internal usage is radians/second.

setReduceVelKm

public void setReduceVelKm(double reduceVel)

set the reducing velocity, in kilometers/second. The internal representation is radians/second.

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)

calculate

public java.util.List<Arrival> calculate(java.util.List<java.lang.Double> degreesList)
                                  throws TauModelException

Overrides:

calculate in class TauP_Time

Throws:

TauModelException

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 class TauP_Tool

Throws:

java.io.IOException

getStdUsage

public java.lang.String getStdUsage()

Description copied from class: TauP_Time

Prints the command line arguments common to all TauP tools.

Overrides:

getStdUsage in class TauP_Time

getUsage

public java.lang.String getUsage()

Overrides:

getUsage in class TauP_Time

start

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

Overrides:

start in class TauP_Time

Throws:

java.io.IOException

TauModelException

destroy

public void destroy()
             throws TauPException

Overrides:

destroy in class TauP_Time

Throws:

TauPException

printResult

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

Overrides:

printResult in class TauP_Time

Throws:

java.io.IOException

checkBoundary

protected void checkBoundary(double boundaryDistRadian,
                             int distIndex,
                             SeismicPhase phase,
                             java.util.List<SeismicPhase> relPhase,
                             java.io.PrintWriter out)
                      throws java.io.IOException

Throws:

java.io.IOException

calcTimeValue

protected double[] calcTimeValue(double distRadian,
                                 double time,
                                 java.util.List<SeismicPhase> relPhase)
                          throws java.io.IOException

Throws:

java.io.IOException

calcPlotValue

public double[] calcPlotValue(double distRadian,
                              double time,
                              java.util.List<SeismicPhase> relPhase)
                       throws java.io.IOException

Throws:

java.io.IOException

writeValue

public void writeValue(double distRadian,
                       double time,
                       java.util.List<SeismicPhase> relPhase,
                       java.io.PrintWriter out,
                       boolean distHorizontal)
                throws java.io.IOException

Throws:

java.io.IOException

isBetween

public static final boolean isBetween(double a,
                                      double b,
                                      double value)

parseCmdLineArgs

public java.lang.String[] parseCmdLineArgs(java.lang.String[] args)
                                    throws java.io.IOException

Overrides:

parseCmdLineArgs in class TauP_Time

Throws:

java.io.IOException

main

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

Allows TauP_Curve to run as an application. Creates an instance of TauP_Curve. ToolRun.main should be used instead.

Throws:

java.io.IOException