Class SlbmInterface
- All Implemented Interfaces:
java.lang.AutoCloseable
public class SlbmInterface
extends java.lang.Object
implements java.lang.AutoCloseable
A Java Native Interface to the SLBM C++ library, providing access to all supported functionality.
SlbmInterface (Java) manages a connection to the C++ SLBM library. To make this work, 5 conditions must be met:
- The C++ shared objects libgeotesscpp.so, libslbm.so and libslbmjni.so must both be accessible via the LD_LIBRARY_PATH.
- The java application must include the jar file slbmjni.jar in its classpath.
- The java application must import gov.sandia.gnem.slbmjni.*;
- The java application must execute the command: System.loadLibrary("slbmjni");
- The java applicaiton can then instantiate a new SlbmInterface object by calling SlbmInterface slbm = new SlbmInterface();
If all of these conditions are successfully met, then the the Java application can use the slbm attribute to access all the methods described in this document.
A SlbmInterface object maintains a C++ Grid object, which manages interaction with the Earth model. The Earth model is loaded by calling the loadVelocityModelBinary(java.lang.String) method, described below. This Grid object remains in memory until the SlbmInterface object goes out of scope, or a different Earth model is loaded with another call to loadVelocityModelBinary(java.lang.String).
SlbmInterface also maintains a single instance of a C++ GreatCircle object which is instantiated with a call to createGreatCircle(). Once instantiated, many SlbmInterface methods can retrieve information from this GreatCircle object, such as getTravelTime(), getWeights(), toString(int), and more. Once instantiated, the GreatCircle can be interrogated until it is replaced with another GreatCircle by a subsequent call to createGreatCircle(), or is deleted by clear().
The Grid object owned by SlbmInterface stores a vector of map objects which associates the phase and Location of a CrustalProfile object with a pointer to the instance of the CrustalProfile. When createGreatCircle() is called with a latitude, longitude and depth which has been used before, the Grid object will return a pointer to the existing CrustalProfile object, thereby enhancing performance. This vector of maps is cleared when clear() is called. The implications of all this is that applications that loop over many calls to createGreatCircle() will see a performance improvement if clear() is not called within the loop. However, for problems where the number of sources and/or receivers is so large that memory becomes an issue, applications could call clear() within the loop to save memory.
All calculations assume the Earth is defined by a GRS80 ellipsoid. For a description of how points along a great circle are calculated see SLBM_Root/doc/geovectors.pdf
Copyright 2009 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.
BSD Open Source License
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Author: Brian A. Young et al.
Version: 3.2.0
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSlbmInterface.Layers -
Field Summary
-
Constructor Summary
Constructors Constructor Description SlbmInterface()This is the constructor that should be used under normal circumstances.SlbmInterface(double earthRadius)Location::EARTH_RADIUS is a variable that controls how the radius of the earth is defined. -
Method Summary
Modifier and Type Method Description private voidaccessGridProfileNative(int nodeId)voidclear()Delete the current GreatCircle object from memory and clear the pool of stored CrustalProfile objects.voidclearHitCount()Reset the hit count of every grid node to zero.private voidclearHitCountNative()private voidclearNative()voidclose()Delete the C++ SlbmInterface object from memory.private voidcloseNative()private voidcomputeGreatCircleLocationsNative()private voidcomputeGreatCirclePointsNative(double aLat, double aLon, double bLat, double bLon, int npoints, boolean onCenters)private voidcomputeWeightsNative()private voidcomputeWeightsReceiverNative()private voidcomputeWeightsSourceNative()voidcreateGreatCircle(java.lang.String phase, double sourceLat, double sourceLon, double sourceDepth, double receiverLat, double receiverLon, double receiverDepth)Instantiate a new GreatCircle object between two locations.private voidcreateGreatCircleNative(int phase, double sourceLat, double sourceLon, double sourceDepth, double receiverLat, double receiverLon, double receiverDepth)private voidcreateQueryProfileNative(double lat, double lon)private voiddeleteGreatCirclePointsNative()private voiddeleteQueryProfileNative()private voiddeleteWeightsNative()voidfinalize()Delete the C++ SlbmInterface object from memory.doubleget_dtt_ddepth()Retrieve the derivative of travel time wrt to source depth, in seconds/km.doubleget_dtt_dlat()Retrieve the derivative of travel time wrt to source latitude, in seconds/radian.doubleget_dtt_dlon()Retrieve the derivative of travel time wrt to source longitude, in seconds/radian.GridProfilegetActiveNodeData(int nodeId)Retrieve the lat (radians), lon (radians), interface depths (km), P and S wave interval velocities (km/sec) and P and S mantle gradient (1/sec) information associated with a specified active node in the velocity grid.intgetActiveNodeId(int gridNodeId)Retrieve the active node ID that corresponds to a specified grid node ID.private intgetActiveNodeIdNative(int gridNodeId)QueryNeighborInfogetActiveNodeNeighborInfo(int actnid)Retrieve NeighborInfoint[]getActiveNodeNeighbors(int nodeId)Retrieve the active node IDs of the nodes that surround the specified active node.private int[]getActiveNodeNeighborsNative(int nodeId)GridWeightgetActiveNodeWeights()Retrieve the weight assigned to each active node that was touched by the GreatCircle that is currently in memory.GridWeightgetActiveNodeWeightsReceiver()GridWeightgetActiveNodeWeightsSource()private doublegetActualPathIncrementNative()doublegetAverageMantleVelocity(int type)Retrieve the average P or S wave mantle velocity that is specified in the model input file.private doublegetAverageMantleVelocityNative(int type)doublegetCHMax()Retrieve the current value of chMax.private doublegetCHMaxNative()doublegetDelDepth()Retrieve del_depth, the vertical separation of two points used to compute derivative of travel time with respect to depth (in km).private doublegetDelDepthNative()doublegetDelDistance()Retrieve the horizontal separation of two points used to compute horizontal slowness and derivatives of travel time with respect to latitude and longitude (in radians).private doublegetDelDistanceNative()doublegetDistance()Retrieve the source-receiver separation, in radians.private doublegetDistanceNative()double[]getDistAz(double latA, double lonA, double latB, double lonB, double naValue)Retrieve distance and azimuth between two points, A and B (all quantities are in radians).private double[]getDistAzNative(double latA, double lonA, double latB, double lonB, double naValue)private doublegetDttDdepthNative()private doublegetDttDlatNative()private doublegetDttDlonNative()doublegetFractionActive()Retrieve the fraction of the path length of the current GreatCircle object that is within the currently defined active region.private doublegetFractionActiveNative()private double[]getGreatCircleCoefficientsNative(int i)GreatCircleDatagetGreatCircleData()Retrieve the information required for input to the travel time calculation, for the GreatCircle object currently in memory.private double[]getGreatCircleHeadwaveGradientNative()private double[]getGreatCircleHeadwaveVelocityNative()double[][]getGreatCircleLocations()Retrieve the latitudes, longitudes and depths of all the profile positions along the moho.private int[]getGreatCircleNeighborsNative(int i)private java.lang.StringgetGreatCirclePhaseNative()double[][]getGreatCirclePoints(double aLat, double aLon, double bLat, double bLon, int npoints)Retrieve an array of lat, lon points along a great circle path between two points, a and b.private double[]getGreatCirclePointsDepthNative()private double[]getGreatCirclePointsLatNative()private double[]getGreatCirclePointsLonNative()double[][]getGreatCirclePointsOnCenters(double aLat, double aLon, double bLat, double bLon, int npoints)Retrieve an array of lat, lon points along a great circle path between two specified points.private double[]getGreatCircleReceiverDepthNative()private double[]getGreatCircleReceiverVelocityNative()private double[]getGreatCircleSourceDepthNative()private double[]getGreatCircleSourceVelocityNative()GridProfilegetGridData(int nodeId)Retrieve data from a single grid node in the earth model.private double[]getGridDepthNative()private double[]getGridGradientNative()private doublegetGridLatNative()private doublegetGridLonNative()intgetGridNodeId(int activeNodeId)Retrieve the grid node ID that corresponds to a specified active node ID.private intgetGridNodeIdNative(int activeNodeId)private double[]getGridVelocityNative(int waveType)doublegetHeadwaveDistance()Retrieve the angular distance traveled by the ray below the headwave interface, in radians.doublegetHeadwaveDistanceKm()Retrieve horizontal distance traveled by the ray below the headwave interface, in km.private doublegetHeadwaveDistanceKmNative()private doublegetHeadwaveDistanceNative()QueryProfilegetInterpolatedPoint(double lat, double lon)Retrieve interpolated data from the earth model at a single specified latitude, longitude.java.util.ArrayList<QueryProfile>getInterpolatedTransect(java.util.ArrayList<java.lang.Double> lat, java.util.ArrayList<java.lang.Double> lon)Retrieve interpolated data from the earth model along a 1 dimensional transect across the model.java.lang.StringgetInterpolatorType()Retrieve the current interpolatorType, either 'linear' or 'natural_neighbor'.private java.lang.StringgetInterpolatorTypeNative()doublegetMaxDepth()Retrieve the current value for the maximum source depth, in km.private doublegetMaxDepthNative()doublegetMaxDistance()Retrieve the current value for the maximum source-receiver separation, in radians.private doublegetMaxDistanceNative()intgetNActiveNodes()Retrieve the number of active nodes in the Grid.private intgetNActiveNodesNative()intgetNGridNodes()Retrieve the number of Grid nodes in the Earth model.private intgetNGridNodesNative()intgetNHeadWavePoints()Retrieve the number of Head Wave Points.private intgetNHeadWavePointsNative()doublegetNodeAzimuth(int node1, int node2)Retrieve the azimuth from grid node1 to grid node2, radians.private doublegetNodeAzimuthNative(int node1, int node2)intgetNodeHitCount(int nodeId)Retrieve the number of times that the specified node has been 'touched' by a GreatCircle object.private intgetNodeHitCountNative(int nodeId)QueryNeighborInfogetNodeNeighborInfo(int nid)Retrieve NeighborInfoint[]getNodeNeighbors(int nodeId)Retrieve the node IDs of the nodes that surround the specified node.private int[]getNodeNeighborsNative(int nodeId)doublegetNodeSeparation(int node1, int node2)Retrieve the angular separation of two grid nodes, in radians.private doublegetNodeSeparationNative(int node1, int node2)doublegetPathIncrement()Retrieve the current value of the spacing of great circle nodes along the head wave interface, in radians.private doublegetPathIncrementNative()double[]getPgLgComponents()Retrieve information about Pg/Lg travel time calculations.private double[]getPgLgComponentsNative()java.lang.StringgetPhase()Retrieve phase specified in last call to createGreatCircle()private java.lang.StringgetPhaseNative()double[]getPiercePointReceiver()Retrieve the geographic latitude, longitude and depth of the moho pierce point below the receiver, in radians, km.private double[]getPiercePointReceiverNative()double[]getPiercePointSource()Retrieve the geographic latitude, longitude and depth of the moho pierce point below the receiver, in radians, km.private double[]getPiercePointSourceNative()private double[]getQueryCoefficientNative()private double[]getQueryDepthNative()private double[]getQueryGradientNative()private int[]getQueryNodeIdNative()private double[]getQueryVelocityNative(int waveType)doublegetRayParameter()Retrieve the ray parameter in sec/km.private doublegetRayParameterNative()double[]getReceiverCoefficients()Retrieve the interpolation coefficients for grid nodes that contributed to the interpolation of values at the receiver location.private double[]getReceiverCoefficientsNative()doublegetReceiverDistance()Retrieve horizontal offset below the receiver, in radians.private doublegetReceiverDistanceNative()int[]getReceiverNodeIds()Retrieve the node IDs for grid nodes that contributed to the interpolation of values at the receiver location.private int[]getReceiverNodeIdsNative()doublegetSlowness()Retrieve horizontal slowness, in seconds/radian.private doublegetSlownessNative()doublegetSlownessUncertainty()Get the slowness uncertainty (seconds/radian) resulting from last call to createGreatCircle()doublegetSlownessUncertainty(java.lang.String phase, double distance)Retrieve uncertainty of horizontal slowness, in seconds/radian-km.private doublegetSlownessUncertaintyNative(int phase, double distance)double[]getSourceCoefficients()Retrieve the interpolation coefficients for grid nodes that contributed to the interpolation of values at the source location.private double[]getSourceCoefficientsNative()doublegetSourceDistance()Retrieve horizontal offset below the source, in radians.private doublegetSourceDistanceNative()int[]getSourceNodeIds()Retrieve the node IDs for grid nodes that contributed to the interpolation of values at the source location.private int[]getSourceNodeIdsNative()java.lang.StringgetTessId()Retrieve the tessellation ID of the model currently in memory.private java.lang.StringgetTessIdNative()doublegetTravelTime()Retrieve the total travel time for the GreatCircle, in seconds.double[]getTravelTimeComponents()Retrieve the total travel time and all the components that contributed to the total.private double[]getTravelTimeComponentsNative()private doublegetTravelTimeNative()doublegetTravelTimeUncertainty()Calculate an uncertainty value (seconds) resulting from last call to createGreatCircle()doublegetTravelTimeUncertainty(boolean calcRandomError)Calculate an uncertainty value (seconds) resulting from last call to createGreatCircle().doublegetTravelTimeUncertainty(java.lang.String phase, double distance)Calculate an uncertainty value (seconds) as a function of distance in radians for a supported seismic phase (Pn, Sn, Pg, Lg).doublegetTravelTimeUncertainty1D()Calculate an uncertainty value (seconds) resulting from last call to createGreatCircle().private doublegetTravelTimeUncertainty1DNative()private doublegetTravelTimeUncertaintyNative()private doublegetTravelTimeUncertaintyNative(boolean calcRandomError)private doublegetTravelTimeUncertaintyPhaseDistanceNative(int phase, double distance)doublegetTurningRadius()Retrieve turning radius in kmprivate doublegetTurningRadiusNative()java.lang.StringgetVersion()Retrieve the SLBM version number.private java.lang.StringgetVersionNative()private int[]getWeightNodesNative()GridWeightgetWeights()Retrieve the weight assigned to each grid node that was touched by the GreatCircle that is currently in memory.private double[]getWeightsNative()GridWeightgetWeightsReceiver()GridWeightgetWeightsSource()ZhaoParametersgetZhaoParameters()Retrieve some of the parameters that contribute to the calculation of of total travel time using the Zhao algorithm.private double[]getZhaoParametersNative()private intgetZhaoUdSignNative()voidinitializeActiveNodes(double latmin, double lonmin, double latmax, double lonmax)Initialize the list of active nodes in the model grid.private voidinitializeActiveNodesNative(double latmin, double lonmin, double latmax, double lonmax)voidloadVelocityModel(java.lang.String modelFileName)Load the velocity model into memory from the specified file.voidloadVelocityModelBinary(java.lang.String modelDirectory)Load the velocity model into memory from the specified file.private voidloadVelocityModelNative(java.lang.String modelFileName)static booleanmodelsEqual(java.lang.String modelPath1, java.lang.String modelPath2)Check if two models are equalprivate static booleanmodelsEqualNative(java.lang.String modelPath1, java.lang.String modelPath2)double[]movePoint(double latA, double lonA, double distance, double azimuth)Find geographic latitude and longitude of the point that is the specified distance and azimuth from point A.private double[]movePointNative(double latA, double lonA, double distance, double azimuth)voidsaveVelocityModel(java.lang.String modelFileName)Save the velocity model currently in memory to the specified file.voidsaveVelocityModel(java.lang.String modelFileName, int format)\brief Save the velocity model currently in memory to the specified file.voidsaveVelocityModelBinary()Write the model currently in memory out to files.private voidsaveVelocityModelBinaryNative()private java.lang.StringsaveVelocityModelNative(java.lang.String modelFileName, int format)voidsetActiveNodeData(GridProfile gridProfile)Modify the velocity and gradient information associated with a specified active node in the Grid.voidsetAverageMantleVelocity(int type, double velocity)Set the average P or S wave mantle velocity that is specified in the model input file.private voidsetAverageMantleVelocityNative(int type, double velocity)voidsetCHMax(double chMax)Set the value of chMax.private voidsetCHMaxNative(double chMax)voidsetDelDepth(double del_depth)Modify the value of del_depth, the vertical separation of two points used to compute derivative of travel time with respect to depth (in km).private voidsetDelDepthNative(double del_depth)voidsetDelDistance(double del_distance)Modify the horizontal separation of two points used to compute horizontal slowness and derivatives of travel time with respect to latitude and longitude.private voidsetDelDistanceNative(double del_distance)voidsetGridData(GridProfile gridProfile)Modify the velocity and gradient information for a single grid node in the earth model currently in memory.private voidsetGridDataNative(int nodeId, double[] depths, double[] pvelocities, double[] svelocities, double[] gradients)private double[]setGridDepthNative(double[] depth)private double[]setGridGradientNative(double[] gradient)private double[]setGridVelocityNative(int waveType, double[] velocity)voidsetInterpolatorType(java.lang.String interpolatorType)Set the interpolatorType to either 'linear' or 'natural_neighbor'.private voidsetInterpolatorTypeNative(java.lang.String interpolatorType)voidsetMaxDepth(double maxDepth)Set the maximum source depth for Pn/Sn phase, in km.private voidsetMaxDepthNative(double maxDepth)voidsetMaxDistance(double maxDistance)Set the maximum source-receiver separation for Pn/Sn phase, in radians.private voidsetMaxDistanceNative(double maxDistance)voidsetPathIncrement(double pathIncrement)Set the desired spacing of great circle nodes along the head wave interface, in radians.private voidsetPathIncrementNative(double pathIncrement)private voidSlbmInterfaceFixedEarthRadiusNative(double earthRadius)private voidSlbmInterfaceNative()voidspecifyOutputDirectory(java.lang.String directoryName)Specify the directory where the model that is currently in memory should be written to the next time that saveVelocityModelBinary() is called.private voidspecifyOutputDirectoryNative(java.lang.String directoryName)java.lang.StringtoString(int verbosity)Retrieve a formatted String representation of the results computed by a GreatCircle object.private java.lang.StringtoStringNative(int verbosity)
-
Field Details
-
vtkId
protected int vtkId -
PWAVE
public static final int PWAVE- See Also:
- Constant Field Values
-
SWAVE
public static final int SWAVE- See Also:
- Constant Field Values
-
-
Constructor Details
-
SlbmInterface
public SlbmInterface()This is the constructor that should be used under normal circumstances. -
SlbmInterface
public SlbmInterface(double earthRadius)Location::EARTH_RADIUS is a variable that controls how the radius of the earth is defined. It is initialized to -1 in SLBM::Location.cc, outside the class definition. If Location::EARTH_RADIUS is less than zero, then Location::getEarthRadius() will return the radius of the earth that is a function of geocentric latitude (larger at the equator, smaller at the poles). If Location::EARTH_RADIUS is > 0, then getEarthRadius() returns Location::EARTH_RADIUS. Applications can modify Location::EARTH_RADIUS by calling this routine.In it's default state, SLBM will return travel times that do not require application of ellipticity corrections, since the radius of the elliptical earth is computed at every latitude. However, when comparing SLBM results to results obtained with radially symmetric, 1D models, or any model which assumes a spherical earth, it is important to fix the Earth radius to the correct value for the comparison (usually 6371 km).
- Parameters:
earthRadius- double earth radius in km.
-
-
Method Details
-
SlbmInterfaceNative
private void SlbmInterfaceNative() -
SlbmInterfaceFixedEarthRadiusNative
private void SlbmInterfaceFixedEarthRadiusNative(double earthRadius) -
finalize
public void finalize()Delete the C++ SlbmInterface object from memory.- Overrides:
finalizein classjava.lang.Object
-
close
public void close()Delete the C++ SlbmInterface object from memory.- Specified by:
closein interfacejava.lang.AutoCloseable
-
closeNative
private void closeNative() -
getVersion
public java.lang.String getVersion()Retrieve the SLBM version number.- Returns:
- String
-
getVersionNative
private java.lang.String getVersionNative() -
loadVelocityModel
Load the velocity model into memory from the specified file.- Parameters:
modelFileName- String- Throws:
SLBMException- if native method fails
-
loadVelocityModelNative
private void loadVelocityModelNative(java.lang.String modelFileName) -
loadVelocityModelBinary
Load the velocity model into memory from the specified file.- Parameters:
modelDirectory- String- Throws:
SLBMException- if native method fails
-
saveVelocityModel
Save the velocity model currently in memory to the specified file.- Parameters:
modelFileName- String- Throws:
SLBMException- if native method fails
-
saveVelocityModel
\brief Save the velocity model currently in memory to the specified file. Save the velocity model currently in memory to the specified file or directory.The following formats are supported:
- SLBM version 1 ascii file. All model information is output to a single file in ascii format. This format was available in SLBM version 2, but never used.
- SLBM version 2 directory format. Model information is output to a number of different files and directories, mostly in binary format. This format was used almost exclusively in SLBM version 2.
- SLBM version 3 directory format. Model information is output to a number of different files and directories, mostly in binary format. This format is very similar to format 2 with the difference being that the model tessellation and values are stored in GeoTess format instead of the custom SLBM format.
- SLBM version 3 single-file format. This is the default+preferred format. All model information is written to a single file. If the modelFileName extension is '.ascii' the file is written in ascii format, otherwise it is written in binary format.
Models stored in SLBM version 1 and 2 formats (formats 1 and 2) only support linear interpolation. Models stored in SLBM version 3 formats (formats 3 and 4) support both linear and natural neighbor interpolation.
- Parameters:
modelFileName- the full or relative path to the file or directory to which the earth model is to be written. For formats 2 and 3, the directory will be created if it does not exist.format- the desired format of the output. If omitted, defaults to 4: all model information written to a single file.- Throws:
SLBMException- if native method fails
-
saveVelocityModelNative
private java.lang.String saveVelocityModelNative(java.lang.String modelFileName, int format) -
specifyOutputDirectory
public void specifyOutputDirectory(java.lang.String directoryName)Specify the directory where the model that is currently in memory should be written to the next time that saveVelocityModelBinary() is called. A call to specifyOutputDirectory() will check to make sure that the specified directory exists. If it does not exist, slbm will attempt to create it. Then slbm will write a very small file called deleteme.buf to the specified directory and then delete that file. All of this is done to ensure that when the model is actually written to the specified directory, the probability of error is minimized. Call method saveVelocityModelBinary() to actually write the model to the specified directory.Note that specified directory name is associated with the Grid object currently in memory. If the current Grid object is deleted and a different Grid object loaded, the directoryName will be reset to "".
- Parameters:
directoryName- String
-
specifyOutputDirectoryNative
private void specifyOutputDirectoryNative(java.lang.String directoryName) -
saveVelocityModelBinary
public void saveVelocityModelBinary()Write the model currently in memory out to files. The model is written to a directory which was previously specified with a call to specifyOutputDirectory(). -
saveVelocityModelBinaryNative
private void saveVelocityModelBinaryNative() -
createGreatCircle
public void createGreatCircle(java.lang.String phase, double sourceLat, double sourceLon, double sourceDepth, double receiverLat, double receiverLon, double receiverDepth) throws SLBMExceptionInstantiate a new GreatCircle object between two locations.- Parameters:
phase- the phase that this GreatCircle is to support. Recognized phases are Pn, Sn, Pg and Lg.sourceLat- the geographic latitude of the source in radians.sourceLon- the geographic longitude of source in radians.sourceDepth- the depth of the source in km.receiverLat- the geographic latitude of the receiver in radians.receiverLon- the geographic longitude of the receiver in radians.receiverDepth- the depth of the receiver in km. along the head wave interface, in radians.- Throws:
SLBMException- if native method fails
-
createGreatCircleNative
private void createGreatCircleNative(int phase, double sourceLat, double sourceLon, double sourceDepth, double receiverLat, double receiverLon, double receiverDepth) -
clear
public void clear()Delete the current GreatCircle object from memory and clear the pool of stored CrustalProfile objects. The model Grid is not deleted and remains accessible. The Grid object owned by SlbmInterface stores a vector of map objects which associates the phase and Location of a CrustalProfile object with a pointer to the instance of the CrustalProfile . WhencreateGreatCircle(java.lang.String, double, double, double, double, double, double)is called with a latitude, longitude and depth which has been used before, the Grid object will return a pointer to the existing CrustalProfile object, thereby enhancing performance. This vector of maps is cleared whenclear()is called. The implications of all this is that applications that loop over many calls tocreateGreatCircle(java.lang.String, double, double, double, double, double, double)will see a performance improvement ifclear()is not called within the loop. However, for problems with a huge number of sources and or receivers, if memory becomes an issue, applications could callclear()within the loop to save memory. -
clearNative
private void clearNative() -
toString
Retrieve a formatted String representation of the results computed by a GreatCircle object.- Parameters:
verbosity- specifies the amount of information that is to be included in the return string. Each verbosity level includes all information in preceeding verbosity levels.
- 0 : nothing. An empty string is returned.
- 1 : total distance and travel time summary
- 2 : gradient correction information for Pn/Sn. Nothing for Pg/Lg
- 3 : Source and receiver profiles
- 4 : Grid node weights.
- 5 : Head wave interface profiles
- 6 : Interpolation coefficients for great circle nodes on the head wave interface.- Returns:
- String a formatted String representation of the results computed by a GreatCircle object.
- Throws:
SLBMException- if native method fails
-
toStringNative
private java.lang.String toStringNative(int verbosity) -
getTravelTime
Retrieve the total travel time for the GreatCircle, in seconds.- Returns:
- double the total travel time for the GreatCircle, in seconds.
- Throws:
SLBMException- if native method fails
-
getTravelTimeNative
private double getTravelTimeNative() -
getPhase
Retrieve phase specified in last call to createGreatCircle()- Returns:
- String phase
- Throws:
SLBMException- if native method fails
-
getPhaseNative
private java.lang.String getPhaseNative() -
getDistance
Retrieve the source-receiver separation, in radians.- Returns:
- double the source-receiver separation, in radians.
- Throws:
SLBMException- if native method fails
-
getDistanceNative
private double getDistanceNative() -
getSourceDistance
Retrieve horizontal offset below the source, in radians. This is the angular distance between the location of the source and the source pierce point where the ray impinged on the headwave interface.- Returns:
- the horizontal offset below the source, in radians.
- Throws:
SLBMException- if native method fails
-
getSourceDistanceNative
private double getSourceDistanceNative() -
getReceiverDistance
Retrieve horizontal offset below the receiver, in radians. This is the angular distance between the location of the receiver and the receiver pierce point where the ray impinged on the headwave interface.- Returns:
- the horizontal offset below the receiver, in radians.
- Throws:
SLBMException- if native method fails
-
getReceiverDistanceNative
private double getReceiverDistanceNative() -
getHeadwaveDistance
Retrieve the angular distance traveled by the ray below the headwave interface, in radians. This is the total distance minus the horizontal offsets below the source and receiver. getSourceDistance() + getReceiverDistance() + getHeadwaveDistance() = getDistance().- Returns:
- the angular distance traveled by the ray below the headwave interface, in radians.
- Throws:
SLBMException- if native method fails
-
getHeadwaveDistanceNative
private double getHeadwaveDistanceNative() -
getHeadwaveDistanceKm
Retrieve horizontal distance traveled by the ray below the headwave interface, in km. This is the sum of actual_path_increment(i) * R(i) where actual_path_increment(i) is the angular distance traveled by the ray in each angular distance increment along the head wave interface, and R(i) is the radius of the head wave interface in that same horizontal increment.- Returns:
- the horizontal distance traveled by the ray below the headwave interface, in km.
- Throws:
SLBMException- if native method fails
-
getHeadwaveDistanceKmNative
private double getHeadwaveDistanceKmNative() -
getTravelTimeComponents
Retrieve the total travel time and all the components that contributed to the total. All values are in seconds.- Returns:
- double[]
t[0] : total travel time
t[1] : crustal travel time below the source
t[2] : crustal travel time below the receiver
t[3] : travel time along the head wave interface
t[4] : gradient correction term. Zero for Pg/Lg - Throws:
SLBMException- if native method fails
-
getTravelTimeComponentsNative
private double[] getTravelTimeComponentsNative() -
getWeights
Retrieve the weight assigned to each grid node that was touched by the GreatCircle that is currently in memory.A map which associates an instance of a GridProfile object with a double weight is initialized. Then every LayerProfile on the head wave interface between the source and receiver is visited and the angular distance, d, that the ray traveled in the horizontal segment is retreived. If d > 0, then the neighboring GridProfile objects that contributed to the interpolated value of the LayerProfile are visited. The product of d * R * C is added to the weight associated with that GridProfile object, where R is the radius of the head wave interface for the LayerProfile object being evaluated, and C is the interpolation coefficient for the GridProfile - LayerProfile pair under consideration. Then, all the GridProfile objects in the map are visited, the grid node IDs extracted into int array node, and the weight extracted into double array weight.
Note: Only grid nodes touched by this GreatCircle are included in the output. Each grid node is included only once, even though more than one LayerProfile object may have contributed some weight to it. The sum of all the weights will equal the horizontal distance traveled by the ray along the head wave interface, from the source pierce point to the receiver pierce point, in km.
- Returns:
- GridWeight a storage container for the results.
- Throws:
SLBMException- if native method fails
-
computeWeightsNative
private void computeWeightsNative() -
getWeightNodesNative
private int[] getWeightNodesNative() -
getWeightsNative
private double[] getWeightsNative() -
deleteWeightsNative
private void deleteWeightsNative() -
getWeightsSource
- Throws:
SLBMException
-
computeWeightsSourceNative
private void computeWeightsSourceNative() -
getActiveNodeWeightsSource
- Throws:
SLBMException
-
getWeightsReceiver
- Throws:
SLBMException
-
computeWeightsReceiverNative
private void computeWeightsReceiverNative() -
getActiveNodeWeightsReceiver
- Throws:
SLBMException
-
getSourceNodeIds
public int[] getSourceNodeIds()Retrieve the node IDs for grid nodes that contributed to the interpolation of values at the source location. There should be 4 of these.- Returns:
- int[] source node ids.
-
getSourceNodeIdsNative
private int[] getSourceNodeIdsNative() -
getSourceCoefficients
public double[] getSourceCoefficients()Retrieve the interpolation coefficients for grid nodes that contributed to the interpolation of values at the source location. There should be 4 of these and they should sum to one.- Returns:
- int[] source interpolation coefficients
-
getSourceCoefficientsNative
private double[] getSourceCoefficientsNative() -
getReceiverNodeIds
public int[] getReceiverNodeIds()Retrieve the node IDs for grid nodes that contributed to the interpolation of values at the receiver location. There should be 4 of these.- Returns:
- int[] receiver node ids.
-
getReceiverNodeIdsNative
private int[] getReceiverNodeIdsNative() -
getReceiverCoefficients
public double[] getReceiverCoefficients()Retrieve the interpolation coefficients for grid nodes that contributed to the interpolation of values at the receiver location. There should be 4 of these and they should sum to one.- Returns:
- int[] receiver interpolation coefficients
-
getReceiverCoefficientsNative
private double[] getReceiverCoefficientsNative() -
getGridData
Retrieve data from a single grid node in the earth model.- Parameters:
nodeId- the grid node ID number.- Returns:
- GridProfile
- Throws:
SLBMException- if native method fails
-
accessGridProfileNative
private void accessGridProfileNative(int nodeId) -
getGridLatNative
private double getGridLatNative() -
getGridLonNative
private double getGridLonNative() -
getGridDepthNative
private double[] getGridDepthNative() -
getGridVelocityNative
private double[] getGridVelocityNative(int waveType) -
getGridGradientNative
private double[] getGridGradientNative() -
setGridDepthNative
private double[] setGridDepthNative(double[] depth) -
setGridVelocityNative
private double[] setGridVelocityNative(int waveType, double[] velocity) -
setGridGradientNative
private double[] setGridGradientNative(double[] gradient) -
setGridData
Modify the velocity and gradient information for a single grid node in the earth model currently in memory. The Earth model in the input file is not modified. To save the Earth model that is currently in memory to the file system call methodsaveVelocityModel(String)- Parameters:
gridProfile- GridProfile containing the nodeId, velocity and gradient information that is to replace the information currently stored in the Earth model in memory.- Throws:
SLBMException- if native method fails
-
setGridDataNative
private void setGridDataNative(int nodeId, double[] depths, double[] pvelocities, double[] svelocities, double[] gradients) -
setActiveNodeData
Modify the velocity and gradient information associated with a specified active node in the Grid.- Parameters:
gridProfile- the node number of the grid point in the model. (zero based index).- Throws:
SLBMException- if native method fails
-
getInterpolatedPoint
Retrieve interpolated data from the earth model at a single specified latitude, longitude.- Parameters:
lat- the latitude where information is to be interpolated, in radians.lon- the longitude where information is to be interpolated, in radians.- Returns:
- QueryProfile
- Throws:
SLBMException- if native method fails
-
createQueryProfileNative
private void createQueryProfileNative(double lat, double lon) -
deleteQueryProfileNative
private void deleteQueryProfileNative() -
getQueryNodeIdNative
private int[] getQueryNodeIdNative() -
getQueryDepthNative
private double[] getQueryDepthNative() -
getQueryCoefficientNative
private double[] getQueryCoefficientNative() -
getQueryVelocityNative
private double[] getQueryVelocityNative(int waveType) -
getQueryGradientNative
private double[] getQueryGradientNative() -
getInterpolatedTransect
public java.util.ArrayList<QueryProfile> getInterpolatedTransect(java.util.ArrayList<java.lang.Double> lat, java.util.ArrayList<java.lang.Double> lon) throws SLBMExceptionRetrieve interpolated data from the earth model along a 1 dimensional transect across the model.- Parameters:
lat- the latitudes where information is to be interpolated, in radians.lon- the longitudes where information is to be interpolated, in radians.- Returns:
- QueryProfile
- Throws:
SLBMException- if native method fails
-
getGreatCircleData
Retrieve the information required for input to the travel time calculation, for the GreatCircle object currently in memory.- Returns:
- GreatCircleData a storage container for the results.
- Throws:
SLBMException- if native method fails
-
getGreatCirclePhaseNative
private java.lang.String getGreatCirclePhaseNative() -
getActualPathIncrementNative
private double getActualPathIncrementNative() -
getGreatCircleNeighborsNative
private int[] getGreatCircleNeighborsNative(int i) -
getGreatCircleCoefficientsNative
private double[] getGreatCircleCoefficientsNative(int i) -
getGreatCircleSourceDepthNative
private double[] getGreatCircleSourceDepthNative() -
getGreatCircleReceiverDepthNative
private double[] getGreatCircleReceiverDepthNative() -
getGreatCircleSourceVelocityNative
private double[] getGreatCircleSourceVelocityNative() -
getGreatCircleReceiverVelocityNative
private double[] getGreatCircleReceiverVelocityNative() -
getGreatCircleHeadwaveVelocityNative
private double[] getGreatCircleHeadwaveVelocityNative() -
getGreatCircleHeadwaveGradientNative
private double[] getGreatCircleHeadwaveGradientNative() -
getGreatCircleLocations
Retrieve the latitudes, longitudes and depths of all the profile positions along the moho. Profile positions are located at the center of each segment of the head wave interface between the source and receiver. The first position is located actualPathIncrement/2 radians from the source, the last profile position is located actualPathIncrement/2 radians from the receiver, and the others are spaced actualPathIncrement radians apart.- Returns:
- double[][] a 3 x npoints array containing the latitudes, longitudes and depths of the points along the great circle. Latitudes and longitudes are in radians. Depths are in km.
- Throws:
SLBMException- if native method fails
-
computeGreatCircleLocationsNative
private void computeGreatCircleLocationsNative() -
getGreatCirclePoints
public double[][] getGreatCirclePoints(double aLat, double aLon, double bLat, double bLon, int npoints) throws SLBMExceptionRetrieve an array of lat, lon points along a great circle path between two points, a and b. The great circle path between a and b is divided into npoints-1 equal size cells and the computed points are located at the boundaries of those cells. First point will coincide with point a and last point with point b.- Parameters:
aLat- double the latitude of the first point in radians.aLon- double the longitude of the first point in radians.bLat- double the latitude of the second point in radians.bLon- double the longitude of the second point in radians.npoints- int the number of points desired.- Returns:
- double[][] a 2 x npoints array containing the latitudes and longitudes of the points along the great circle, in radians.
- Throws:
SLBMException- if native method fails
-
getGreatCirclePointsOnCenters
public double[][] getGreatCirclePointsOnCenters(double aLat, double aLon, double bLat, double bLon, int npoints) throws SLBMExceptionRetrieve an array of lat, lon points along a great circle path between two specified points. The great circle path between a and b is divided into npoints equal size cells and the computed points are located at the centers of those cells.- Parameters:
aLat- double the latitude of the first point in radians.aLon- double the longitude of the first point in radians.bLat- double the latitude of the second point in radians.bLon- double the longitude of the second point in radians.npoints- int the number of points desired.- Returns:
- double[][] a 2 x npoints array containing the latitudes and longitudes of the points along the great circle, in radians.
- Throws:
SLBMException- if native method fails
-
computeGreatCirclePointsNative
private void computeGreatCirclePointsNative(double aLat, double aLon, double bLat, double bLon, int npoints, boolean onCenters) -
deleteGreatCirclePointsNative
private void deleteGreatCirclePointsNative() -
getGreatCirclePointsLatNative
private double[] getGreatCirclePointsLatNative() -
getGreatCirclePointsLonNative
private double[] getGreatCirclePointsLonNative() -
getGreatCirclePointsDepthNative
private double[] getGreatCirclePointsDepthNative() -
getTravelTimeUncertainty
Calculate an uncertainty value (seconds) resulting from last call to createGreatCircle()- Returns:
- the uncertainty in seconds
- Throws:
SLBMException- if native method fails
-
getTravelTimeUncertaintyNative
private double getTravelTimeUncertaintyNative(boolean calcRandomError) -
getTravelTimeUncertainty
Calculate an uncertainty value (seconds) resulting from last call to createGreatCircle(). Uses Random Error in the computation.- Parameters:
calcRandomError- Boolean describing whether or not to calculate random error (default: false)- Returns:
- the uncertainty in seconds
- Throws:
SLBMException- if native method fails
-
getTravelTimeUncertainty1D
Calculate an uncertainty value (seconds) resulting from last call to createGreatCircle(). Computes the 1D-model uncertainties.- Returns:
- the uncertainty in seconds
- Throws:
SLBMException- if native method fails
-
getTravelTimeUncertainty
public double getTravelTimeUncertainty(java.lang.String phase, double distance) throws SLBMExceptionCalculate an uncertainty value (seconds) as a function of distance in radians for a supported seismic phase (Pn, Sn, Pg, Lg).- Parameters:
phase- String one of Pn, Sn, Pg, Lgdistance- the angular distance in radians- Returns:
- the uncertainty in seconds
- Throws:
SLBMException- if native method fails
-
getTravelTimeUncertaintyPhaseDistanceNative
private double getTravelTimeUncertaintyPhaseDistanceNative(int phase, double distance) -
getTravelTimeUncertaintyNative
private double getTravelTimeUncertaintyNative() -
getTravelTimeUncertainty1DNative
private double getTravelTimeUncertainty1DNative() -
getZhaoParameters
Retrieve some of the parameters that contribute to the calculation of of total travel time using the Zhao algorithm. This method only returns meaningful results for phases Pn and Sn. For Pg and Lg, all the parameters of type double are returned with values BaseObject::NA_VALUE and udSign is returned with value of -999.- Returns:
- ZhaoParameters
- Throws:
SLBMException- if native method fails
-
getZhaoParametersNative
private double[] getZhaoParametersNative() -
getZhaoUdSignNative
private int getZhaoUdSignNative() -
getPgLgComponents
Retrieve information about Pg/Lg travel time calculations. This method only returns useful information when the phase is Pg or Lg. For Pn and Sn, all information is returned as SLBMGlobals::NA_VALUE.This method returns a 7 element array of doubles. The values have the following interpretation:
0: total travel time, sec
1: TauP travel time, sec
2: Headwave travel time, sec
3: TauP ray parameter, seconds/radian
4: Headwave ray parameter, seconds/km
5: TauP Turning radius, km
6: Headwave turning radius, km- Returns:
- double[]
- Throws:
SLBMException- if native method fails
-
getPgLgComponentsNative
private double[] getPgLgComponentsNative() -
getNodeNeighbors
public int[] getNodeNeighbors(int nodeId)Retrieve the node IDs of the nodes that surround the specified node.- Parameters:
nodeId- int- Returns:
- int[]
-
getNodeNeighborsNative
private int[] getNodeNeighborsNative(int nodeId) -
getActiveNodeNeighbors
public int[] getActiveNodeNeighbors(int nodeId)Retrieve the active node IDs of the nodes that surround the specified active node.- Parameters:
nodeId- int- Returns:
- int[]
-
getActiveNodeNeighborsNative
private int[] getActiveNodeNeighborsNative(int nodeId) -
getNodeSeparation
public double getNodeSeparation(int node1, int node2)Retrieve the angular separation of two grid nodes, in radians.- Parameters:
node1- intnode2- int- Returns:
- double
-
getNodeSeparationNative
private double getNodeSeparationNative(int node1, int node2) -
getNodeAzimuth
public double getNodeAzimuth(int node1, int node2)Retrieve the azimuth from grid node1 to grid node2, radians.- Parameters:
node1- intnode2- int- Returns:
- double
-
getNodeAzimuthNative
private double getNodeAzimuthNative(int node1, int node2) -
initializeActiveNodes
public void initializeActiveNodes(double latmin, double lonmin, double latmax, double lonmax)Initialize the list of active nodes in the model grid. After a call to this method, active nodes can be accessed by looping over the active nodes. See getNActiveNodes() and getActiveNodeData().Active nodes includes all grid nodes that fall within the specified range of latitude and longitude. Lats and lons must be specified in radians. Lonmin and lonmax should -PI <= lon <= PI.
- Parameters:
latmin- doublelonmin- doublelatmax- doublelonmax- double
-
initializeActiveNodesNative
private void initializeActiveNodesNative(double latmin, double lonmin, double latmax, double lonmax) -
getNodeHitCount
public int getNodeHitCount(int nodeId)Retrieve the number of times that the specified node has been 'touched' by a GreatCircle object. The hit count of each node is initialized in the loadVelocityModel() method. Every time the getWeights() method is called for a particular GreatCircle object, all the nodeIds that contribute any weight to that GreatCircle object have their hit count incremented by one.- Parameters:
nodeId- int- Returns:
- int
-
getNodeHitCountNative
private int getNodeHitCountNative(int nodeId) -
getNActiveNodes
public int getNActiveNodes()Retrieve the number of active nodes in the Grid.- Returns:
- int
-
getNActiveNodesNative
private int getNActiveNodesNative() -
getGridNodeId
public int getGridNodeId(int activeNodeId)Retrieve the grid node ID that corresponds to a specified active node ID.- Parameters:
activeNodeId- int- Returns:
- int
-
getGridNodeIdNative
private int getGridNodeIdNative(int activeNodeId) -
getActiveNodeId
public int getActiveNodeId(int gridNodeId)Retrieve the active node ID that corresponds to a specified grid node ID.- Parameters:
gridNodeId- int- Returns:
- int
-
getActiveNodeIdNative
private int getActiveNodeIdNative(int gridNodeId) -
getActiveNodeWeights
Retrieve the weight assigned to each active node that was touched by the GreatCircle that is currently in memory.A map which associates an instance of a GridProfile object with a double weight is initialized. Then every LayerProfile on the head wave interface between the source and receiver is visited and the angular distance, d, that the ray traveled in the horizontal segment is retreived. If d > 0, then the neighboring GridProfile objects that contributed to the interpolated value of the LayerProfile are visited. The product of d * R * C is added to the weight associated with that GridProfile object, where R is the radius of the head wave interface for the LayerProfile object being evaluated, and C is the interpolation coefficient for the GridProfile - LayerProfile pair under consideration. Then, all the GridProfile objects in the map are visited, the grid node IDs extracted into int array node, and the weight extracted into double array weight.
Note: Only active nodes touched by this GreatCircle are included in the output. Each active node is included only once, even though more than one LayerProfile object may have contributed some weight to it. The sum of all the weights will equal the horizontal distance traveled by the ray along the head wave interface, from the source pierce point to the receiver pierce point, in km.
- Returns:
- GridWeight a storage container for the results.
- Throws:
SLBMException- if native method fails
-
getActiveNodeData
Retrieve the lat (radians), lon (radians), interface depths (km), P and S wave interval velocities (km/sec) and P and S mantle gradient (1/sec) information associated with a specified active node in the velocity grid. Retrieve the interface depth, velocity and gradient information associated with a specified active node in the velocity grid.- Parameters:
nodeId- the active node ID of the grid point in the model (zero based index).- Returns:
- GridProfile
- Throws:
SLBMException- if native method fails
-
getNGridNodes
public int getNGridNodes()Retrieve the number of Grid nodes in the Earth model.- Returns:
- int
-
getNGridNodesNative
private int getNGridNodesNative() -
getNHeadWavePoints
public int getNHeadWavePoints()Retrieve the number of Head Wave Points.- Returns:
- int
-
getNHeadWavePointsNative
private int getNHeadWavePointsNative() -
getNodeNeighborInfo
Retrieve NeighborInfo- Parameters:
nid- int- Returns:
- QueryNeighborInfo
-
getActiveNodeNeighborInfo
Retrieve NeighborInfo- Parameters:
actnid- int- Returns:
- QueryNeighborInfo
-
setCHMax
public void setCHMax(double chMax)Set the value of chMax. c is the zhao c parameter and h is the turning depth of the ray below the moho. Zhao method only valid for c*h << 1. When c*h > chMax, then slbm will throw an exception. This call modifies global parameter BaseObject::ch_max- Parameters:
chMax- double
-
setCHMaxNative
private void setCHMaxNative(double chMax) -
getCHMax
public double getCHMax()Retrieve the current value of chMax. c is the zhao c parameter and h is the turning depth of the ray below the moho. Zhao method only valid for c*h << 1. When c*h > chMax, then slbm will throw an exception. This call retrieves global parameter BaseObject::ch_max- Returns:
- double
-
getCHMaxNative
private double getCHMaxNative() -
getAverageMantleVelocity
public double getAverageMantleVelocity(int type)Retrieve the average P or S wave mantle velocity that is specified in the model input file. This value is used in the calculation of the Zhao c parameter.- Parameters:
type- specify either BaseObject::PWAVE or BaseObject::SWAVE.- Returns:
- double
-
getAverageMantleVelocityNative
private double getAverageMantleVelocityNative(int type) -
setAverageMantleVelocity
public void setAverageMantleVelocity(int type, double velocity)Set the average P or S wave mantle velocity that is specified in the model input file. This value is used in the calculation of the Zhao c parameter.- Parameters:
type- specify either BaseObject::PWAVE or BaseObject::SWAVE.velocity- the P or S wave velocity that is to be set, in km/sec. This value will be stored in the model file, if the model file is written to file by a call to saveVelocityModel() subsequent to a call to this method.
-
setAverageMantleVelocityNative
private void setAverageMantleVelocityNative(int type, double velocity) -
getTessId
public java.lang.String getTessId()Retrieve the tessellation ID of the model currently in memory.- Returns:
- String
-
getTessIdNative
private java.lang.String getTessIdNative() -
getFractionActive
public double getFractionActive()Retrieve the fraction of the path length of the current GreatCircle object that is within the currently defined active region.- Returns:
- double
-
getFractionActiveNative
private double getFractionActiveNative() -
setMaxDistance
public void setMaxDistance(double maxDistance)Set the maximum source-receiver separation for Pn/Sn phase, in radians. Source-receiver separations greater than the specified value will result in an exception being thrown in createGreatCircle(). Default value is PI radians.- Parameters:
maxDistance- double
-
setMaxDistanceNative
private void setMaxDistanceNative(double maxDistance) -
getMaxDistance
public double getMaxDistance()Retrieve the current value for the maximum source-receiver separation, in radians.- Returns:
- double
-
getMaxDistanceNative
private double getMaxDistanceNative() -
setMaxDepth
public void setMaxDepth(double maxDepth)Set the maximum source depth for Pn/Sn phase, in km. Source depths greater than the specified value will result in an exception being thrown in createGreatCircle(). Default value is 9999 km.- Parameters:
maxDepth- double
-
setMaxDepthNative
private void setMaxDepthNative(double maxDepth) -
getMaxDepth
public double getMaxDepth()Retrieve the current value for the maximum source depth, in km.- Returns:
- double
-
getMaxDepthNative
private double getMaxDepthNative() -
get_dtt_dlat
Retrieve the derivative of travel time wrt to source latitude, in seconds/radian.- Returns:
- double the derivative of travel time wrt to source latitude, in seconds/radian.
- Throws:
SLBMException- if native method fails
-
getDttDlatNative
private double getDttDlatNative() -
get_dtt_dlon
Retrieve the derivative of travel time wrt to source longitude, in seconds/radian.- Returns:
- double the derivative of travel time wrt to source longitude, in seconds/radian.
- Throws:
SLBMException- if native method fails
-
getDttDlonNative
private double getDttDlonNative() -
get_dtt_ddepth
Retrieve the derivative of travel time wrt to source depth, in seconds/km.- Returns:
- double the derivative of travel time wrt to source depth, in seconds/km.
- Throws:
SLBMException- if native method fails
-
getDttDdepthNative
private double getDttDdepthNative() -
getSlowness
Retrieve horizontal slowness, in seconds/radian.- Returns:
- double the horizontal slowness, in seconds/radian.
- Throws:
SLBMException- if native method fails
-
getSlownessNative
private double getSlownessNative() -
getSlownessUncertainty
Get the slowness uncertainty (seconds/radian) resulting from last call to createGreatCircle()- Returns:
- the uncertainty in seconds/radian
- Throws:
SLBMException- if native method fails
-
getSlownessUncertainty
Retrieve uncertainty of horizontal slowness, in seconds/radian-km.- Parameters:
phase- Stringdistance- double- Returns:
- double the uncertainty of horizontal slowness, in seconds/radian-km.
- Throws:
SLBMException- if native method fails
-
getSlownessUncertaintyNative
private double getSlownessUncertaintyNative(int phase, double distance) -
movePoint
public double[] movePoint(double latA, double lonA, double distance, double azimuth)Find geographic latitude and longitude of the point that is the specified distance and azimuth from point A.- Parameters:
latA- radianslonA- radiansdistance- radiansazimuth- radians- Returns:
- [latB, lonB] in radians
-
movePointNative
private double[] movePointNative(double latA, double lonA, double distance, double azimuth) -
getDistAz
public double[] getDistAz(double latA, double lonA, double latB, double lonB, double naValue)Retrieve distance and azimuth between two points, A and B (all quantities are in radians). Computed distance will range between 0 and PI and azimuth will range from -PI to PI. If distance is zero, or if A is located at north or south pole, azimuth will be set to naValue.- Parameters:
latA- geographic latitude of point A, in radians.lonA- geographic longitude of point A, in radians.latB- geographic latitude of point B, in radians.lonB- geographic longitude of point B, in radians.naValue- if distance is zero or if A is coincident with north or south pole, then azimuth is invalid and this value will be returned as the azimuth.- Returns:
- [distance, azimuth] in radians.
-
getDistAzNative
private double[] getDistAzNative(double latA, double lonA, double latB, double lonB, double naValue) -
getPiercePointSource
public double[] getPiercePointSource()Retrieve the geographic latitude, longitude and depth of the moho pierce point below the receiver, in radians, km. For Pg, Lg an exception is thrown.- Returns:
- pierce point at the source
-
getPiercePointSourceNative
private double[] getPiercePointSourceNative() -
getPiercePointReceiver
public double[] getPiercePointReceiver()Retrieve the geographic latitude, longitude and depth of the moho pierce point below the receiver, in radians, km. For Pg, Lg an exception is thrown.- Returns:
- the geographic latitude, longitude and depth of the moho pierce point below the receiver, in radians, km
-
getPiercePointReceiverNative
private double[] getPiercePointReceiverNative() -
getDelDistance
Retrieve the horizontal separation of two points used to compute horizontal slowness and derivatives of travel time with respect to latitude and longitude (in radians).- Returns:
- double del_distance, in radians
- Throws:
SLBMException- if native method fails
-
getDelDistanceNative
private double getDelDistanceNative() -
setDelDistance
public void setDelDistance(double del_distance)Modify the horizontal separation of two points used to compute horizontal slowness and derivatives of travel time with respect to latitude and longitude.- Parameters:
del_distance- in radians
-
setDelDistanceNative
private void setDelDistanceNative(double del_distance) -
getDelDepth
Retrieve del_depth, the vertical separation of two points used to compute derivative of travel time with respect to depth (in km).- Returns:
- del_depth, in km.
- Throws:
SLBMException- if native method fails
-
getDelDepthNative
private double getDelDepthNative() -
setDelDepth
public void setDelDepth(double del_depth)Modify the value of del_depth, the vertical separation of two points used to compute derivative of travel time with respect to depth (in km).- Parameters:
del_depth- in km.
-
setDelDepthNative
private void setDelDepthNative(double del_depth) -
getRayParameter
Retrieve the ray parameter in sec/km.- Returns:
- rayParameter in sec/km
- Throws:
SLBMException- if native method fails
-
getRayParameterNative
private double getRayParameterNative() -
getTurningRadius
Retrieve turning radius in km- Returns:
- turningRadius in km.
- Throws:
SLBMException- if native method fails
-
getTurningRadiusNative
private double getTurningRadiusNative() -
setPathIncrement
public void setPathIncrement(double pathIncrement)Set the desired spacing of great circle nodes along the head wave interface, in radians. The actual spacing will be reduced from the requested value in order that an integral number of equally spaced LayerProfile objects will exactly span the source-receiver separation. Defaults to 0.1 degrees if not specified.- Parameters:
pathIncrement- the desired spacing of great circle nodes along the head wave interface, in radians.
-
setPathIncrementNative
private void setPathIncrementNative(double pathIncrement) -
getPathIncrement
public double getPathIncrement()Retrieve the current value of the spacing of great circle nodes along the head wave interface, in radians. The actual spacing will be reduced from the requested value in order that an integral number of equally spaced LayerProfile objects will exactly span the source-receiver separation. The default value is 0.1 degrees.- Returns:
- the current value of the spacing of great circle nodes along the head wave interface, in radians.
-
getPathIncrementNative
private double getPathIncrementNative() -
setInterpolatorType
public void setInterpolatorType(java.lang.String interpolatorType)Set the interpolatorType to either 'linear' or 'natural_neighbor'. The default value is 'natural_neighbor';- Parameters:
interpolatorType- either 'linear' or 'natural_neighbor'.
-
setInterpolatorTypeNative
private void setInterpolatorTypeNative(java.lang.String interpolatorType) -
getInterpolatorType
public java.lang.String getInterpolatorType()Retrieve the current interpolatorType, either 'linear' or 'natural_neighbor'. The default value is 'natural_neighbor';- Returns:
- interpolatorType either 'linear' or 'natural_neighbor'.
-
getInterpolatorTypeNative
private java.lang.String getInterpolatorTypeNative() -
clearHitCount
public void clearHitCount()Reset the hit count of every grid node to zero. -
clearHitCountNative
private void clearHitCountNative() -
modelsEqual
public static boolean modelsEqual(java.lang.String modelPath1, java.lang.String modelPath2) throws SLBMExceptionCheck if two models are equal- Parameters:
modelPath1- StringmodelPath2- String- Returns:
- true or false, whether the models are equal, or not
- Throws:
SLBMException- if native method fails
-
modelsEqualNative
private static boolean modelsEqualNative(java.lang.String modelPath1, java.lang.String modelPath2)
-