Package edu.sc.seis.TauP

Class PhaseName

java.lang.Object

edu.sc.seis.TauP.PhaseName

All Implemented Interfaces:

Serializable

public class PhaseName
extends Object
implements Serializable

Convenience class that allows sac header variables to be associated with a seismic phase name.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	name	name of the phase, ie PKIKP
int	sacTNum	sac t header to be associated with the phase
ArrayList<Integer>	sacTNumTriplication	list of sac t headers to be associated with the phase, including n triplications

Constructor Summary

Constructors

Constructor	Description
PhaseName(String name, int sacTNum)
PhaseName(String name, String sacTNumList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(PhaseName obj)
String	getName()
static PhaseName	parseName(String name)	Parses phase name of the form name or name-sachdrs where name is a seismic phase name according to the TauP phase naming convention and sachdrs is one or more sac header numbers, a, x, 0 to 9, into with to set the times when using taup setsac.
int	sacTNumForTriplication(int index)	Gets sac header for the index triplication.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

name

public String name

name of the phase, ie PKIKP

sacTNum

public int sacTNum

sac t header to be associated with the phase

sacTNumTriplication

public ArrayList<Integer> sacTNumTriplication

list of sac t headers to be associated with the phase, including n triplications

Constructor Details

PhaseName

public PhaseName(String name,
 int sacTNum)
          throws PhaseParseException

Throws:

PhaseParseException

PhaseName

public PhaseName(String name,
 String sacTNumList)
          throws PhaseParseException

Throws:

PhaseParseException

Method Details

parseName

public static PhaseName parseName(String name)
                           throws PhaseParseException

Parses phase name of the form name or name-sachdrs where name is a seismic phase name according to the TauP phase naming convention and sachdrs is one or more sac header numbers, a, x, 0 to 9, into with to set the times when using taup setsac. The x value in a list means to skip the nth arrival. The sachrds is ignored for all other tools.

Parameters:

name - phase name with optional sac headers

Returns:

parsed phase name

Throws:

PhaseParseException - if unable to parse the name

equals

public boolean equals(PhaseName obj)

getName

public String getName()

sacTNumForTriplication

public int sacTNumForTriplication(int index)

Gets sac header for the index triplication. Zero is the first arrival, 1 is next arrival, etc. Index zero should be same as this.sacTNum.

Parameters:

index - triplication index

Returns:

index arrival for the phase

toString

public String toString()

Overrides:

toString in class Object