Package edu.sc.seis.TauP.cmdline
Class TauP_AbstractPhaseTool
- java.lang.Object
-
- edu.sc.seis.TauP.cmdline.TauP_Tool
-
- edu.sc.seis.TauP.cmdline.TauP_AbstractPhaseTool
-
- All Implemented Interfaces:
java.util.concurrent.Callable<java.lang.Integer>
- Direct Known Subclasses:
TauP_AbstractRayTool
,TauP_Curve
,TauP_Find
,TauP_PhaseDescribe
,TauP_SetMSeed3
,TauP_SetSac
,TauP_Wavefront
public abstract class TauP_AbstractPhaseTool extends TauP_Tool
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<PhaseName>
phaseNames
names of phases to be used, ie PKIKP.-
Fields inherited from class edu.sc.seis.TauP.cmdline.TauP_Tool
ABREV_SYNOPSIS, abstractOutputTypeArgs, OPTIONS_HEADING, toolProps
-
-
Constructor Summary
Constructors Constructor Description TauP_AbstractPhaseTool(AbstractOutputTypeArgs outputTypeArgs)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
appendPhaseName(PhaseName phaseName)
void
appendPhaseName(java.lang.String phaseName)
static org.json.JSONObject
baseResultAsJSONObject(java.lang.String modelName, java.util.List<java.lang.Double> depth, java.util.List<java.lang.Double> receiverDepth, java.util.List<PhaseName> phaseNameList)
java.util.List<SeismicPhase>
calcSeismicPhases(double sourceDepth)
Calculates the seismic phases using a possibly new or changed tau model for the given source depth.java.util.List<SeismicPhase>
calcSeismicPhases(double sourceDepth, java.util.List<java.lang.Double> receiverDepths, Scatterer scatterer)
void
clearPhaseNames()
void
clearPhases()
int
getNumPhases()
double
getRadiusOfEarth()
java.util.List<java.lang.Double>
getReceiverDepths()
Scatterer
getScatterer()
double
getScattererDepth()
java.util.List<SeismicPhase>
getSeismicPhases()
java.util.List<java.lang.Double>
getSourceDepths()
TauModel
getTauModelDepthCorrected(double sourceDepth)
Gets depth corrected TauModel.java.lang.String
getTauModelName()
void
init()
java.util.List<PhaseName>
parsePhaseList(java.lang.String phaseList)
parses a comma separated list of phase names and adds them to the phaseNames vector.java.util.List<PhaseName>
parsePhaseNameList()
void
setModelName(java.lang.String modelName)
void
setPhaseNameList(java.util.List<PhaseName> phaseNames)
void
setPhaseNames(java.util.List<java.lang.String> phaseNames)
void
setReceiverDepth(double receiverDepth)
void
setScatterer(Scatterer scatterer)
void
setSingleReceiverDepth(double receiverDepth)
void
setSingleSourceDepth(double depth)
void
setTauModel(TauModel tMod)
-
Methods inherited from class edu.sc.seis.TauP.cmdline.TauP_Tool
call, configDefaults, destroy, getCmdLineArgs, getOutFileExtension, getOutputFormat, isDEBUG, isVerbose, setDEBUG, setOutFileBase, setOutFileExtension, setOutputFormat, setToolPropsFilename, setVerbose, start, toolNameFromClass, validateArguments
-
-
-
-
Field Detail
-
phaseNames
protected java.util.List<PhaseName> phaseNames
names of phases to be used, ie PKIKP.
-
-
Constructor Detail
-
TauP_AbstractPhaseTool
public TauP_AbstractPhaseTool(AbstractOutputTypeArgs outputTypeArgs)
-
-
Method Detail
-
getRadiusOfEarth
public double getRadiusOfEarth()
-
parsePhaseNameList
public java.util.List<PhaseName> parsePhaseNameList() throws PhaseParseException
- Throws:
PhaseParseException
-
setPhaseNameList
public void setPhaseNameList(java.util.List<PhaseName> phaseNames)
-
baseResultAsJSONObject
public static org.json.JSONObject baseResultAsJSONObject(java.lang.String modelName, java.util.List<java.lang.Double> depth, java.util.List<java.lang.Double> receiverDepth, java.util.List<PhaseName> phaseNameList)
-
init
public void init() throws TauPException
- Specified by:
init
in classTauP_Tool
- Throws:
TauPException
-
setPhaseNames
public void setPhaseNames(java.util.List<java.lang.String> phaseNames) throws PhaseParseException
- Throws:
PhaseParseException
-
appendPhaseName
public void appendPhaseName(java.lang.String phaseName) throws PhaseParseException
- Throws:
PhaseParseException
-
appendPhaseName
public void appendPhaseName(PhaseName phaseName)
-
getNumPhases
public int getNumPhases()
-
clearPhaseNames
public void clearPhaseNames()
-
setSingleSourceDepth
public void setSingleSourceDepth(double depth)
-
setReceiverDepth
public void setReceiverDepth(double receiverDepth)
-
setSingleReceiverDepth
public void setSingleReceiverDepth(double receiverDepth)
-
getScattererDepth
public double getScattererDepth()
-
getScatterer
public Scatterer getScatterer()
-
setScatterer
public void setScatterer(Scatterer scatterer)
-
getTauModelName
public java.lang.String getTauModelName()
-
getTauModelDepthCorrected
public TauModel getTauModelDepthCorrected(double sourceDepth) throws TauModelException
Gets depth corrected TauModel.- Throws:
TauModelException
-
setModelName
public void setModelName(java.lang.String modelName)
-
setTauModel
public void setTauModel(TauModel tMod)
-
clearPhases
public void clearPhases()
-
calcSeismicPhases
public java.util.List<SeismicPhase> calcSeismicPhases(double sourceDepth) throws TauPException
Calculates the seismic phases using a possibly new or changed tau model for the given source depth.- Throws:
TauPException
-
calcSeismicPhases
public java.util.List<SeismicPhase> calcSeismicPhases(double sourceDepth, java.util.List<java.lang.Double> receiverDepths, Scatterer scatterer) throws TauModelException
- Throws:
TauModelException
-
getSourceDepths
public java.util.List<java.lang.Double> getSourceDepths() throws TauPException
- Throws:
TauPException
-
getReceiverDepths
public java.util.List<java.lang.Double> getReceiverDepths() throws TauPException
- Throws:
TauPException
-
getSeismicPhases
public java.util.List<SeismicPhase> getSeismicPhases() throws TauPException
- Throws:
TauPException
-
parsePhaseList
public java.util.List<PhaseName> 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 T6.- Returns:
-
-