Package edu.sc.seis.TauP

Class LegPuller

java.lang.Object

edu.sc.seis.TauP.LegPuller

public class LegPuller
extends Object

Converts a seismic phase name like PKiKP into a list of tokens P K i K P

Field Summary

Fields

Modifier and Type	Field	Description
static final String	bodyWave
static final String	customDiscon
static final String	discon
static final double	DISCON_DEPTH_TOLERANCE
static final String	headDiffRE
static final String	interactPointsRE
static final String	interactPrefix
static final String	namedHeadDiffRE
static final String	number
static final Pattern	phaseRegEx
static final String	scatterWave
static final String	surfaceWave
static final String	travelLeg
static final String	travelSuffix
static final String	upDiffRE

Constructor Summary

Constructors

Constructor	Description
LegPuller()

Method Summary

Modifier and Type	Method	Description
static int	closestDisconBranchToDepth(TauModel tMod, String depthString)	Finds the closest discontinuity to the given depth that can have reflections and phase transformations.
static int	closestDisconBranchToDepth(TauModel tMod, String depthString, double tolerance)
static String	createPuristName(TauModel tMod, List<String> legs)
static String	extractBoundaryId(String name, int offset, boolean includeHeadDiff)
static int	extractPhaseBoundaryInteraction(String name, int offset, int phaseCharLength, List<String> legs)
static boolean	isBoundary(String leg)	Tests if the leg is a model boundary, like m, c, i or a number as a depth like 410
static Double	legAsDepthBoundary(TauModel tMod, String leg)	Converts leg name to depth, if is a number (depth) or m, c, i.
protected static ArrayList<String>	legPuller(String name)	Tokenizes a phase name into legs, ie PcS becomes 'P'+'c'+'S' while p^410P would become 'p'+'^410'+'P'.
static String	phaseValidate(ArrayList<String> legs)	Performs consistency checks on the previously tokenized phase name stored in legs.
static boolean	regExCheck(String name)	check against regex for coarse validation.

Methods inherited from class java.lang.Object

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

Field Details

number

public static final String number

See Also:

• Constant Field Values

customDiscon

public static final String customDiscon

See Also:

• Constant Field Values

discon

public static final String discon

See Also:

• Constant Field Values

travelSuffix

public static final String travelSuffix

See Also:

• Constant Field Values

headDiffRE

public static final String headDiffRE

See Also:

• Constant Field Values

namedHeadDiffRE

public static final String namedHeadDiffRE

See Also:

• Constant Field Values

upDiffRE

public static final String upDiffRE

See Also:

• Constant Field Values

travelLeg

public static final String travelLeg

See Also:

• Constant Field Values

interactPrefix

public static final String interactPrefix

See Also:

• Constant Field Values

interactPointsRE

public static final String interactPointsRE

See Also:

• Constant Field Values

surfaceWave

public static final String surfaceWave

See Also:

• Constant Field Values

bodyWave

public static final String bodyWave

See Also:

• Constant Field Values

scatterWave

public static final String scatterWave

See Also:

• Constant Field Values

phaseRegEx

public static final Pattern phaseRegEx

DISCON_DEPTH_TOLERANCE

public static final double DISCON_DEPTH_TOLERANCE

See Also:

• Constant Field Values

Constructor Details

LegPuller

public LegPuller()

Method Details

regExCheck

public static boolean regExCheck(String name)

check against regex for coarse validation. currently disabled as regex has issues and is really big

Parameters:

name -

Returns:

legPuller

protected static ArrayList<String> legPuller(String name)
                                      throws PhaseParseException

Tokenizes a phase name into legs, ie PcS becomes 'P'+'c'+'S' while p^410P would become 'p'+'^410'+'P'. Once a phase name has been broken into tokens we can begin to construct the sequence of branches to which it corresponds. Only minor error checking is done at this point, for instance pIP generates an exception but ^410 doesn't. It also appends "END" as the last leg.

Throws:

PhaseParseException - if the phase name cannot be tokenized.

extractPhaseBoundaryInteraction

public static int extractPhaseBoundaryInteraction(String name,
 int offset,
 int phaseCharLength,
 List<String> legs)
                                           throws PhaseParseException

Throws:

PhaseParseException

extractBoundaryId

public static String extractBoundaryId(String name,
 int offset,
 boolean includeHeadDiff)
                                throws PhaseParseException

Throws:

PhaseParseException

isBoundary

public static boolean isBoundary(String leg)

Tests if the leg is a model boundary, like m, c, i or a number as a depth like 410

Parameters:

leg - leg name

Returns:

true if a boundary

legAsDepthBoundary

public static Double legAsDepthBoundary(TauModel tMod,
 String leg)

Converts leg name to depth, if is a number (depth) or m, c, i. Null otherwise.

closestDisconBranchToDepth

public static int closestDisconBranchToDepth(TauModel tMod,
 String depthString)

Finds the closest discontinuity to the given depth that can have reflections and phase transformations. May return 1 past total number of branchs if depth is center of earth or -1 if no layer is within 10 km of depth as a number.

Returns:

the branch number with the closest top depth.

closestDisconBranchToDepth

public static int closestDisconBranchToDepth(TauModel tMod,
 String depthString,
 double tolerance)

createPuristName

public static String createPuristName(TauModel tMod,
 List<String> legs)

phaseValidate

public static String phaseValidate(ArrayList<String> legs)

Performs consistency checks on the previously tokenized phase name stored in legs. Returns null if all is ok, a message if there is a problem.