java.lang.Object
- edu.sc.seis.TauP.TauModel

All Implemented Interfaces:

java.io.Serializable
```
public class TauModel
extends java.lang.Object
implements java.io.Serializable
```
provides storage all of the TauBranch's comprising a model.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected int`	`cmbBranch`	Branch with the cmb at its top.
`protected double`	`cmbDepth`	Depth of the cmb.
`static boolean`	`DEBUG`	True to enable debugging output.
`protected int`	`iocbBranch`	Branch with the iocb at its top.
`protected double`	`iocbDepth`	Depth of the iocb.
`protected int`	`mohoBranch`	Branch with the moho at its top.
`protected double`	`mohoDepth`	Depth of the moho.
`protected double[]`	`noDisconDepths`	Depths that should not have reflections or phase conversions.
`protected double`	`radiusOfEarth`	Radius of the Earth in km, usually input from the velocity model.
`protected double[]`	`rayParams`	ray parameters used to construct the tau branches.
`protected int`	`sourceBranch`	Branch with the source at its top.
`protected double`	`sourceDepth`	Depth for which tau model was constructed.
`protected boolean`	`spherical`	True if this is a spherical slowness model.
`TauBranch[][]`	`tauBranches`	2D Array containing a TauBranch object corresponding to each "branch" of the tau model, 0 is P and 1 is S.

Constructor Summary

Constructors
Constructor	Description
`TauModel(boolean spherical, double sourceDepth, int sourceBranch, double[] noDisconDepths, double mohoDepth, int mohoBranch, double cmbDepth, int cmbBranch, double iocbDepth, int iocbBranch, double radiusOfEarth, SlownessModel mod, double[] rayParams, TauBranch[][] tauBranches)`
`TauModel(SlownessModel sMod)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`appendNoDisconDepth(double noDisconDepth)`
`TauModel`	`depthCorrect(double depth)`	Computes a new tau model for a source at depth using the previously computed branches for a surface source.
`int`	`findBranch(double depth)`	Finds the branch that either has the depth as its top boundary, or strictly contains the depth.
`double`	`findDepth(double rayParam, boolean isPWave)`	returns the turning depth for a ray of given ray parameter.
`double[]`	`getBranchDepths()`	returns an array of the depths that are boundaries between branches
`int`	`getCmbBranch()`
`double`	`getCmbDepth()`
`int`	`getIocbBranch()`
`double`	`getIocbDepth()`
`java.lang.String`	`getModelName()`
`int`	`getMohoBranch()`
`double`	`getMohoDepth()`
`double[]`	`getNoDisconDepths()`	Branches, such as the branch with the source at its top, that are not allowed to have reflections and phase conversions at their tops.
`int`	`getNumBranches()`
`double`	`getOneRayParam(int i)`
`double`	`getRadiusOfEarth()`
`double[]`	`getRayParams()`
`SlownessModel`	`getSlownessModel()`
`int`	`getSourceBranch()`
`double`	`getSourceDepth()`
`TauBranch`	`getTauBranch(int branchNum, boolean isPWave)`
`VelocityModel`	`getVelocityModel()`
`boolean`	`isBranchDepth(double depth)`	Checks to see if the given depth is a boundary depth.
`boolean`	`isNoDisconBranch(int branchNum)`	Does the given branch number have a noDisconDepth at its top? We test against PWave Tau branches (ie true) since S is the same.
`boolean`	`isNoDisconDepth(double noDisconDepth)`	Is the given depth a "noDisconDepth"?
`boolean`	`isSpherical()`
`protected TauModel`	`loadFromDepthCache(java.lang.Double depth)`
`void`	`print()`
`static TauModel`	`readModel(java.lang.String filename)`
`static TauModel`	`readModelFromStream(java.io.InputStream inStream)`
`void`	`setNoDisconDepths(double[] noDisconDepths)`
`TauModel`	`splitBranch(double depth)`	returns a new TauModel with the branches containing depth split at depth.
`java.lang.String`	`toString()`
`boolean`	`validate()`
`void`	`writeModel(java.lang.String filename)`
`void`	`writeModelToStream(java.io.OutputStream outStream)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEBUG
```
public static transient boolean DEBUG
```
    True to enable debugging output.
  - spherical
```
protected boolean spherical
```
    True if this is a spherical slowness model. False if flat.
  - sourceDepth
```
protected double sourceDepth
```
    Depth for which tau model was constructed.
  - sourceBranch
```
protected int sourceBranch
```
    Branch with the source at its top.
  - noDisconDepths
```
protected double[] noDisconDepths
```
    Depths that should not have reflections or phase conversions. For instance, if the source is not at a branch boundary then noDisconDepths contains source depth and reflections and phase conversions are not allowed at this branch boundary. If the source happens to fall on a real discontinuity then then it is not included.
  - mohoDepth
```
protected double mohoDepth
```
    Depth of the moho.
  - mohoBranch
```
protected int mohoBranch
```
    Branch with the moho at its top.
  - cmbDepth
```
protected double cmbDepth
```
    Depth of the cmb.
  - cmbBranch
```
protected int cmbBranch
```
    Branch with the cmb at its top.
  - iocbDepth
```
protected double iocbDepth
```
    Depth of the iocb.
  - iocbBranch
```
protected int iocbBranch
```
    Branch with the iocb at its top.
  - radiusOfEarth
```
protected double radiusOfEarth
```
    Radius of the Earth in km, usually input from the velocity model.
  - rayParams
```
protected double[] rayParams
```
    ray parameters used to construct the tau branches. This may only be a subset of the slownesses/ray parameters saved in the slowness model due to high slowness zones (low velocity zones).
  - tauBranches
```
public TauBranch[][] tauBranches
```
    2D Array containing a TauBranch object corresponding to each "branch" of the tau model, 0 is P and 1 is S. Branches correspond to depth regions between discontinuities or reversals in slowness gradient for a wave type. Each branch contains time, distance, and tau increments for each ray parameter in rayParams for the layer. Rays that turn above the branch layer are assigned 0.0 time, distance, and tau increments.
- Constructor Detail
  - TauModel
```
public TauModel(SlownessModel sMod)
         throws NoSuchLayerException,
                NoSuchMatPropException,
                SlownessModelException,
                TauModelException
```
    Throws:
    
    NoSuchLayerException
    
    NoSuchMatPropException
    
    SlownessModelException
    
    TauModelException
  - TauModel
```
public TauModel(boolean spherical,
                double sourceDepth,
                int sourceBranch,
                double[] noDisconDepths,
                double mohoDepth,
                int mohoBranch,
                double cmbDepth,
                int cmbBranch,
                double iocbDepth,
                int iocbBranch,
                double radiusOfEarth,
                SlownessModel mod,
                double[] rayParams,
                TauBranch[][] tauBranches)
```
- Method Detail
  - isSpherical
```
public boolean isSpherical()
```
  - getModelName
```
public java.lang.String getModelName()
```
    Returns:
    
    the name of the earth model used to construct the tau model.
  - getSlownessModel
```
public SlownessModel getSlownessModel()
```
  - getVelocityModel
```
public VelocityModel getVelocityModel()
```
  - getSourceDepth
```
public double getSourceDepth()
```
    Returns:
    
    depth for which tau model was constructed.
  - getSourceBranch
```
public int getSourceBranch()
```
    Returns:
    
    branch number with the source at its top.
  - getNoDisconDepths
```
public double[] getNoDisconDepths()
```
    Branches, such as the branch with the source at its top, that are not allowed to have reflections and phase conversions at their tops.
  - isNoDisconBranch
```
public boolean isNoDisconBranch(int branchNum)
```
    Does the given branch number have a noDisconDepth at its top? We test against PWave Tau branches (ie true) since S is the same.
  - isNoDisconDepth
```
public boolean isNoDisconDepth(double noDisconDepth)
```
    Is the given depth a "noDisconDepth"?
  - setNoDisconDepths
```
public void setNoDisconDepths(double[] noDisconDepths)
```
  - appendNoDisconDepth
```
public void appendNoDisconDepth(double noDisconDepth)
```
  - getMohoDepth
```
public double getMohoDepth()
```
    Returns:
    
    depth of the moho.
  - getMohoBranch
```
public int getMohoBranch()
```
    Returns:
    
    branch number with the moho at its top.
  - getCmbDepth
```
public double getCmbDepth()
```
    Returns:
    
    depth of the cmb.
  - getCmbBranch
```
public int getCmbBranch()
```
    Returns:
    
    branch number with the cmb at its top.
  - getIocbDepth
```
public double getIocbDepth()
```
    Returns:
    
    depth of the iocb.
  - getIocbBranch
```
public int getIocbBranch()
```
    Returns:
    
    branch number with the iocb at its top.
  - getRadiusOfEarth
```
public double getRadiusOfEarth()
```
    Returns:
    
    the radius of the Earth in km, usually input from the velocity model.
  - getRayParams
```
public double[] getRayParams()
```
    Returns:
    
    an array, cloned, of the ray parameters used to construct the tau branches. This may only be a subset of the slownesses/ray parameters saved in the slowness model due to high slowness zones (low velocity zones).
  - getOneRayParam
```
public double getOneRayParam(int i)
```
  - getNumBranches
```
public int getNumBranches()
```
  - getTauBranch
```
public TauBranch getTauBranch(int branchNum,
                              boolean isPWave)
```
  - getBranchDepths
```
public double[] getBranchDepths()
```
    returns an array of the depths that are boundaries between branches
  - findDepth
```
public double findDepth(double rayParam,
                        boolean isPWave)
                 throws TauModelException
```
    returns the turning depth for a ray of given ray parameter. Note this is for a surface source, and so converted phases my give incorrect results, e.g. SKS for certain ray parameters turns within the upper part of the outer core that is a low velocity zone for P so no P wave of that ray parameter could reach the core. For layer specific turning points, see the other SlownessModel.findDepth.
    
    Throws:
    
    TauModelException
  - findBranch
```
public int findBranch(double depth)
               throws TauModelException
```
    Finds the branch that either has the depth as its top boundary, or strictly contains the depth. Also, we allow the bottommost branch to contain its bottom depth, so that the center if the earth is contained within the bottom branch.
    
    Throws:
    
    TauModelException
  - depthCorrect
```
public TauModel depthCorrect(double depth)
                      throws TauModelException
```
    Computes a new tau model for a source at depth using the previously computed branches for a surface source. No change is needed to the branches above and below the branch containing the depth, except for the addition of a slowness sample. The branch containing the source depth is split into 2 branches, and up going branch and a downgoing branch. Additionally, the slowness at the source depth must be sampled exactly as it is an extremal point for each of these branches. See Buland and Chapman p 1290.
    
    Throws:
    
    TauModelException
  - isBranchDepth
```
public boolean isBranchDepth(double depth)
```
    Checks to see if the given depth is a boundary depth. This could be because it is a discontinuity in the velocity model, or because the layer has been split for the source or reciever.
    
    Parameters:
    
    depth -
    
    Returns:
  - splitBranch
```
public TauModel splitBranch(double depth)
                     throws TauModelException
```
    returns a new TauModel with the branches containing depth split at depth. Used for putting a source at depth since a source can only be located on a branch boundary.
    
    Throws:
    
    TauModelException
  - writeModel
```
public void writeModel(java.lang.String filename)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeModelToStream
```
public void writeModelToStream(java.io.OutputStream outStream)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readModel
```
public static TauModel readModel(java.lang.String filename)
                          throws java.io.FileNotFoundException,
                                 java.io.IOException,
                                 java.io.StreamCorruptedException,
                                 java.lang.ClassNotFoundException,
                                 java.io.OptionalDataException
```
    Throws:
    
    java.io.FileNotFoundException
    
    java.io.IOException
    
    java.io.StreamCorruptedException
    
    java.lang.ClassNotFoundException
    
    java.io.OptionalDataException
  - readModelFromStream
```
public static TauModel readModelFromStream(java.io.InputStream inStream)
                                    throws java.io.InvalidClassException,
                                           java.io.IOException,
                                           java.io.StreamCorruptedException,
                                           java.lang.ClassNotFoundException,
                                           java.io.OptionalDataException
```
    Throws:
    
    java.io.InvalidClassException
    
    java.io.IOException
    
    java.io.StreamCorruptedException
    
    java.lang.ClassNotFoundException
    
    java.io.OptionalDataException
  - validate
```
public boolean validate()
```
  - print
```
public void print()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - loadFromDepthCache
```
protected TauModel loadFromDepthCache(java.lang.Double depth)
```

Class TauModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG

spherical

sourceDepth

sourceBranch

noDisconDepths

mohoDepth

mohoBranch

cmbDepth

cmbBranch

iocbDepth

iocbBranch

radiusOfEarth

rayParams

tauBranches

Constructor Detail

TauModel

TauModel

Method Detail

isSpherical

getModelName

getSlownessModel

getVelocityModel

getSourceDepth

getSourceBranch

getNoDisconDepths

isNoDisconBranch

isNoDisconDepth

setNoDisconDepths

appendNoDisconDepth

getMohoDepth

getMohoBranch

getCmbDepth

getCmbBranch

getIocbDepth

getIocbBranch

getRadiusOfEarth

getRayParams

getOneRayParam

getNumBranches

getTauBranch

getBranchDepths

findDepth

findBranch

depthCorrect

isBranchDepth

splitBranch

writeModel

writeModelToStream

readModel

readModelFromStream

validate

print

toString

loadFromDepthCache