gov.usgs.earthquake.nshmp.geo

Class LocationVector

java.lang.Object

gov.usgs.earthquake.nshmp.geo.LocationVector

public class LocationVector
extends Object

This class encapsulates information describing a vector between two Locations. Internally, this vector is defined by the azimuth (bearing) and the horizontal and vertical separation between the points. Note that a LocationVector from point A to point B is not the complement of that from point B to A. Although the horizontal and vertical components will be the same, the azimuth will likely change by some value other than 180°.

NOTE: Although a LocationVector will function in any reference frame, the convention in seismology and that adopted in OpenSHA is for depth to be positive down. Also, azimuth is stored internally in radians for computational convenience. Be sure to use the azimuth() (radians) or // azimuthDegrees() (decimal-degrees) where appropriate.

Author:

Peter Powers

Method Summary

Modifier and Type	Method and Description
double	azimuth() Returns the azimuth of this vector in radians.
double	azimuthDegrees() Returns the azimuth of this vector in decimal degrees.
static LocationVector	create(double azimuth, double horizontal, double vertical) Initializes a new LocationVector with the supplied values.
static LocationVector	create(Location p1, Location p2) Returns the LocationVector describing the move from one Location to another.
static LocationVector	createWithPlunge(double azimuth, double plunge, double length) Creates a new LocationVector with horizontal and vertical components derived from the supplied plunge and length.
double	horizontal() Returns the horizontal component of this vector.
double	plunge() Returns the angle (in radians) between this vector and a horizontal plane.
double	plungeDegrees() Returns the angle (in decimal degrees) between this vector and a horizontal plane.
static LocationVector	reverseOf(LocationVector v) Returns a copy of the supplied vector with azimuth and vertical components reversed.
String	toString()
double	vertical() Returns the vertical component of this vector.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LocationVector create(double azimuth,
                                    double horizontal,
                                    double vertical)

Initializes a new LocationVector with the supplied values. Note that azimuth is expected in radians.

Parameters:

azimuth - to set in radians

horizontal - component to set in km

vertical - component to set in km

Returns:

a new LocationVector

createWithPlunge

public static LocationVector createWithPlunge(double azimuth,
                                              double plunge,
                                              double length)

Creates a new LocationVector with horizontal and vertical components derived from the supplied plunge and length. Note that azimuth and plunge are expected in radians.

Parameters:

azimuth - to set in radians

plunge - to set in radians

length - of vector in km

Returns:

a new LocationVector

create

public static LocationVector create(Location p1,
                                    Location p2)

Returns the LocationVector describing the move from one Location to another.

Parameters:

p1 - the first Location

p2 - the second Location

Returns:

a new LocationVector

reverseOf

public static LocationVector reverseOf(LocationVector v)

Returns a copy of the supplied vector with azimuth and vertical components reversed.

NOTE: create(p1, p2) is not equivalent to create reverseOf(create(p2, p1)). Although the horizontal and vertical components will likley be the same but the azimuths will potentially be different.

Parameters:

v - LocationVector to copy and flip

Returns:

the flipped copy

azimuthDegrees

public double azimuthDegrees()

Returns the azimuth of this vector in decimal degrees.

Returns:

the azimuth in decimal degrees

See Also:

azimuth()

azimuth

public double azimuth()

Returns the azimuth of this vector in radians.

Returns:

the azimuth in radians

See Also:

azimuthDegrees()

plunge

public double plunge()

Returns the angle (in radians) between this vector and a horizontal plane. This method is intended for use at relatively short separations (e.g. ≤200km) as it degrades at large distances where curvature is not considered. Note that positive angles are down, negative angles are up.

Returns:

the plunge of this vector

plungeDegrees

public double plungeDegrees()

Returns the angle (in decimal degrees) between this vector and a horizontal plane. This method is intended for use at relatively short separations (e.g. ≤200km) as it degrades at large distances where curvature is not considered. Note that positive angles are down, negative angles are up.

Returns:

the plunge of this vector

vertical

public double vertical()

Returns the vertical component of this vector.

Returns:

the vertical component in km

horizontal

public double horizontal()

Returns the horizontal component of this vector.

Returns:

the horizontal component in km

toString

public String toString()

Overrides:

toString in class Object