Package edu.sc.seis.TauP.cmdline

Class TauP_Time

java.lang.Object

edu.sc.seis.TauP.cmdline.TauP_Tool

edu.sc.seis.TauP.cmdline.TauP_AbstractPhaseTool

edu.sc.seis.TauP.cmdline.TauP_AbstractRayTool

edu.sc.seis.TauP.cmdline.TauP_Time

All Implemented Interfaces:

Callable<Integer>

public class TauP_Time
extends TauP_AbstractRayTool

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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	onlyFirst
protected boolean	onlyPrintRayP
protected boolean	onlyPrintTime
protected List<SeismicPhase>	relativePhaseList
protected List<String>	relativePhaseName
protected boolean	withDerivative

Fields inherited from class edu.sc.seis.TauP.cmdline.TauP_AbstractRayTool

distanceArgs

Fields inherited from class edu.sc.seis.TauP.cmdline.TauP_AbstractPhaseTool

phaseNames

Fields inherited from class edu.sc.seis.TauP.cmdline.TauP_Tool

ABREV_SYNOPSIS, abstractOutputTypeArgs, OPTIONS_HEADING, toolProps

Constructor Summary

Constructors

Constructor	Description
TauP_Time()
TauP_Time(TauModel tMod)
TauP_Time(String modelName)	creates a TauP_Time object with the tau model specified by modelName already loaded.

Method Summary

Modifier and Type	Method	Description
List<Arrival>	calcAll(List<SeismicPhase> phaseList, List<RayCalculateable> rayCalcList)
static List<Arrival>	calcAllIndexRays(List<SeismicPhase> seismicPhases)
List<SeismicPhase>	calcRelativeSeismicPhases(TauModel tauModel, double receiverDepth, Scatterer scatterer)
List<SeismicPhase>	calcSeismicPhases(double sourceDepth, List<Double> receiverDepths, Scatterer scatterer)	recalculates the given phases using a possibly new or changed tau model.
static List<String>	combineHeadLines(List<List<String>> headLines)	Combines two header line lists into single single list by concate each pair.
com.google.gson.GsonBuilder	createGsonBuilder()
static List<List<String>>	createHeaderLines(List<Arrival> arrivalList, String modelName, Scatterer scatterer, boolean withAmplitude, SeismicSourceArgs sourceArgs, List<String> relativePhaseName, String phaseFormat, String phasePuristFormat, boolean withDerivative, List<GeoDistType> geoDistTypes)
static List<String>	createModelHeaderLine(String modelName, Scatterer scatterer, List<GeoDistType> geoDistTypes)
void	destroy()
String	getOutFileExtension()
String	getOutputFormat()
AmplitudeArgs	getSourceArgs()
void	init()	preforms intialization of the tool.
static boolean	isRayOkForPhase(RayCalculateable rayCalc, SeismicPhase phase)	Check if ray source and receiver depths are compatible with the phase, to avoid duplicate results when using earthquakes or station/channels that have depths.
boolean	isWithAmplitude()
static void	printArrivalsAsCsv(PrintWriter out, List<Arrival> arrivalList, String modelName, Scatterer scatterer, boolean withAmplitude, SeismicSourceArgs sourceArgs, List<String> relativePhaseName, String toolname, boolean withDerivative, List<GeoDistType> geoDistTypes)
static void	printArrivalsAsHtml(PrintWriter out, List<Arrival> arrivalList, String modelName, Scatterer scatterer, boolean withAmplitude, SeismicSourceArgs sourceArgs, List<String> relativePhaseName, String toolname, boolean withDerivative, List<GeoDistType> geoDistTypes)
static void	printArrivalsAsHtmlTable(PrintWriter out, List<Arrival> arrivalList, String modelName, Scatterer scatterer, boolean withAmplitude, SeismicSourceArgs sourceArgs, List<String> relativePhaseName, String toolname, boolean withDerivative, List<GeoDistType> geoDistTypes)
static void	printArrivalsAsText(PrintWriter out, List<Arrival> arrivalList, String modelName, Scatterer scatterer, boolean onlyPrintTime, boolean onlyPrintRayP, boolean withAmplitude, SeismicSourceArgs sourceArgs, List<String> relativePhaseName, boolean withDerivative, List<GeoDistType> geoDistTypes)
void	printResult(PrintWriter out, List<Arrival> arrivalList)
void	printResultCsv(PrintWriter out, List<Arrival> arrivalList)
void	printResultHtml(PrintWriter out, List<Arrival> arrivalList)
void	printResultText(PrintWriter out, List<Arrival> arrivalList)
void	start()
void	validateArguments()

Methods inherited from class edu.sc.seis.TauP.cmdline.TauP_AbstractRayTool

getDistanceArgs, getReceiverDepths, getSourceDepths

Methods inherited from class edu.sc.seis.TauP.cmdline.TauP_AbstractPhaseTool

appendPhaseName, appendPhaseName, calcSeismicPhases, clearPhaseNames, clearPhases, createTimeResult, getNumPhases, getPhaseArgs, getRadiusOfEarth, getScatterer, getScattererDepth, getSeismicPhases, getTauModelDepthCorrected, getTauModelName, parsePhaseNameList, setModelName, setPhaseNameList, setPhaseNames, setScatterer, setSingleReceiverDepth, setSingleSourceDepth, setTauModel

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

call, configDefaults, getCmdLineArgs, isDEBUG, isVerbose, setDEBUG, setOutFileBase, setOutFileExtension, setOutputFormat, setToolPropsFilename, setVerbose, toolNameFromClass

Methods inherited from class java.lang.Object

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

Field Details

onlyPrintRayP

protected boolean onlyPrintRayP

onlyPrintTime

protected boolean onlyPrintTime

onlyFirst

protected boolean onlyFirst

withDerivative

protected boolean withDerivative

relativePhaseName

protected List<String> relativePhaseName

relativePhaseList

protected List<SeismicPhase> relativePhaseList

Constructor Details

TauP_Time

public TauP_Time()

TauP_Time

public TauP_Time(TauModel tMod)

TauP_Time

public TauP_Time(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 Details

getSourceArgs

public AmplitudeArgs getSourceArgs()

isWithAmplitude

public boolean isWithAmplitude()

getOutputFormat

public String getOutputFormat()

Specified by:

getOutputFormat in class TauP_Tool

getOutFileExtension

public String getOutFileExtension()

Overrides:

getOutFileExtension in class TauP_Tool

calcAll

public List<Arrival> calcAll(List<SeismicPhase> phaseList,
 List<RayCalculateable> rayCalcList)
                      throws TauPException

Specified by:

calcAll in class TauP_AbstractRayTool

Throws:

TauPException

isRayOkForPhase

public static boolean isRayOkForPhase(RayCalculateable rayCalc,
 SeismicPhase phase)

Check if ray source and receiver depths are compatible with the phase, to avoid duplicate results when using earthquakes or station/channels that have depths.

Parameters:

rayCalc - ray to check if has source/receiver depths

phase - phase to see if compatible

Returns:

true if source and receiver depths are compatible

calcSeismicPhases

public List<SeismicPhase> calcSeismicPhases(double sourceDepth,
 List<Double> receiverDepths,
 Scatterer scatterer)
                                     throws TauModelException

recalculates the given phases using a possibly new or changed tau model. Also calculates the relativePhase list.

Overrides:

calcSeismicPhases in class TauP_AbstractPhaseTool

Throws:

TauModelException

calcRelativeSeismicPhases

public List<SeismicPhase> calcRelativeSeismicPhases(TauModel tauModel,
 double receiverDepth,
 Scatterer scatterer)
                                             throws TauModelException

Throws:

TauModelException

createGsonBuilder

public com.google.gson.GsonBuilder createGsonBuilder()

printResult

public void printResult(PrintWriter out,
 List<Arrival> arrivalList)
                 throws TauPException

Specified by:

printResult in class TauP_AbstractRayTool

Throws:

TauPException

printResultText

public void printResultText(PrintWriter out,
 List<Arrival> arrivalList)
                     throws TauModelException

Throws:

TauModelException

printResultHtml

public void printResultHtml(PrintWriter out,
 List<Arrival> arrivalList)
                     throws TauPException

Throws:

TauPException

createModelHeaderLine

public static List<String> createModelHeaderLine(String modelName,
 Scatterer scatterer,
 List<GeoDistType> geoDistTypes)

createHeaderLines

public static List<List<String>> createHeaderLines(List<Arrival> arrivalList,
 String modelName,
 Scatterer scatterer,
 boolean withAmplitude,
 SeismicSourceArgs sourceArgs,
 List<String> relativePhaseName,
 String phaseFormat,
 String phasePuristFormat,
 boolean withDerivative,
 List<GeoDistType> geoDistTypes)

combineHeadLines

public static List<String> combineHeadLines(List<List<String>> headLines)

Combines two header line lists into single single list by concate each pair.

Parameters:

headLines - header lines, size 2

Returns:

combined items

printArrivalsAsText

public static void printArrivalsAsText(PrintWriter out,
 List<Arrival> arrivalList,
 String modelName,
 Scatterer scatterer,
 boolean onlyPrintTime,
 boolean onlyPrintRayP,
 boolean withAmplitude,
 SeismicSourceArgs sourceArgs,
 List<String> relativePhaseName,
 boolean withDerivative,
 List<GeoDistType> geoDistTypes)

printArrivalsAsHtml

public static void printArrivalsAsHtml(PrintWriter out,
 List<Arrival> arrivalList,
 String modelName,
 Scatterer scatterer,
 boolean withAmplitude,
 SeismicSourceArgs sourceArgs,
 List<String> relativePhaseName,
 String toolname,
 boolean withDerivative,
 List<GeoDistType> geoDistTypes)
                                throws TauPException

Throws:

TauPException

printArrivalsAsHtmlTable

public static void printArrivalsAsHtmlTable(PrintWriter out,
 List<Arrival> arrivalList,
 String modelName,
 Scatterer scatterer,
 boolean withAmplitude,
 SeismicSourceArgs sourceArgs,
 List<String> relativePhaseName,
 String toolname,
 boolean withDerivative,
 List<GeoDistType> geoDistTypes)
                                     throws TauPException

Throws:

TauPException

printResultCsv

public void printResultCsv(PrintWriter out,
 List<Arrival> arrivalList)
                    throws TauPException

Throws:

TauPException

printArrivalsAsCsv

public static void printArrivalsAsCsv(PrintWriter out,
 List<Arrival> arrivalList,
 String modelName,
 Scatterer scatterer,
 boolean withAmplitude,
 SeismicSourceArgs sourceArgs,
 List<String> relativePhaseName,
 String toolname,
 boolean withDerivative,
 List<GeoDistType> geoDistTypes)
                               throws TauPException

Throws:

TauPException

init

public void init()
          throws TauPException

preforms intialization of the tool. Properties are queried for the default model to load, source depth to use, phases to use, etc.

Overrides:

init in class TauP_AbstractPhaseTool

Throws:

TauPException

calcAllIndexRays

public static List<Arrival> calcAllIndexRays(List<SeismicPhase> seismicPhases)
                                      throws SlownessModelException,
NoSuchLayerException

Throws:

SlownessModelException

NoSuchLayerException

start

public void start()
           throws IOException,
TauPException

Specified by:

start in class TauP_Tool

Throws:

IOException

TauPException

destroy

public void destroy()
             throws TauPException

Specified by:

destroy in class TauP_Tool

Throws:

TauPException

validateArguments

public void validateArguments()
                       throws TauPException

Overrides:

validateArguments in class TauP_AbstractRayTool

Throws:

TauPException