org.javaseis.properties
Class DataDomain

java.lang.Object
  extended by org.javaseis.properties.DataDomain
All Implemented Interfaces:
java.io.Serializable

public class DataDomain
extends java.lang.Object
implements java.io.Serializable

This class provides a type-safe representation of domains, such as space, time, and frequency.

See Also:
Serialized Form

Field Summary
static DataDomain ALACRITY
          Squared velocity
static DataDomain AMPLITUDE
          Amplitude
static DataDomain COHERENCE
          Some non-semblance measurement of coherency.
static DataDomain DELTA
          Anisotropic Thompsen parameter delta
static DataDomain DENSITY
          Units of mass per volume
static DataDomain DEPTH
          Vertical distance
static DataDomain DIP
          In units of time over space
static DataDomain ENVELOPE
          Analytic envelope of a waveform
static DataDomain EPSILON
          Anisotropic Thompsen parameter epsilon
static DataDomain ETA
          Anisotropic Thompsen parameter eta
static DataDomain FOLD
          Number of independent data that have been summed for a result
static DataDomain FREQUENCY
          The Fourier dual of time
static DataDomain IMPEDANCE
          Rock property impedance, in units of density times velocity.
static DataDomain INCIDENCE_ANGLE
          Angle at which a ray (or normal to a wavefront) strikes a surface
static DataDomain NULL
          Unspecified value
static DataDomain ROTATION_ANGLE
          Angle of rotation of two traces
static DataDomain SEMBLANCE
          Normalized coherency measurement
(package private) static long serialVersionUID
           
static DataDomain SLOTH
          Squared reciprocol velocity
static DataDomain SLOWNESS
          Reciprocol velocity
static DataDomain SPACE
          In units of distance
static DataDomain TIME
          In seconds or milliseconds
static DataDomain UNKNOWN
          Unknown value
static DataDomain VELOCITY
          In units of space over time
static DataDomain VS
          Shear velocity
static DataDomain VSVP
          Ratio of shear velocity to pressure velocity
static DataDomain WAVENUMBER
          The Fourier dual of space
 
Constructor Summary
DataDomain(java.lang.String name)
          Creates a new DataDomain object with the description equal to the name.
DataDomain(java.lang.String name, java.lang.String description)
          Creates a new DataDomain object with the description equal to the name.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is equal to this object.
static DataDomain get(java.lang.String name)
          Gets the domain based on the name, or null if the name is not found.
 java.lang.String getDescription()
          Returns the description the domain.
 java.lang.String getName()
          Returns the name the domain.
 int hashCode()
          Overrides Object.hashCode() because this class overrides Object.equals().
 java.lang.String toString()
          Returns a String representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ALACRITY

public static final DataDomain ALACRITY
Squared velocity


AMPLITUDE

public static final DataDomain AMPLITUDE
Amplitude


COHERENCE

public static final DataDomain COHERENCE
Some non-semblance measurement of coherency.


DELTA

public static final DataDomain DELTA
Anisotropic Thompsen parameter delta


DENSITY

public static final DataDomain DENSITY
Units of mass per volume


DEPTH

public static final DataDomain DEPTH
Vertical distance


DIP

public static final DataDomain DIP
In units of time over space


ENVELOPE

public static final DataDomain ENVELOPE
Analytic envelope of a waveform


EPSILON

public static final DataDomain EPSILON
Anisotropic Thompsen parameter epsilon


ETA

public static final DataDomain ETA
Anisotropic Thompsen parameter eta


FOLD

public static final DataDomain FOLD
Number of independent data that have been summed for a result


FREQUENCY

public static final DataDomain FREQUENCY
The Fourier dual of time


IMPEDANCE

public static final DataDomain IMPEDANCE
Rock property impedance, in units of density times velocity.


INCIDENCE_ANGLE

public static final DataDomain INCIDENCE_ANGLE
Angle at which a ray (or normal to a wavefront) strikes a surface


NULL

public static final DataDomain NULL
Unspecified value


ROTATION_ANGLE

public static final DataDomain ROTATION_ANGLE
Angle of rotation of two traces


SEMBLANCE

public static final DataDomain SEMBLANCE
Normalized coherency measurement


serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

SLOTH

public static final DataDomain SLOTH
Squared reciprocol velocity


SLOWNESS

public static final DataDomain SLOWNESS
Reciprocol velocity


SPACE

public static final DataDomain SPACE
In units of distance


TIME

public static final DataDomain TIME
In seconds or milliseconds


UNKNOWN

public static final DataDomain UNKNOWN
Unknown value


VELOCITY

public static final DataDomain VELOCITY
In units of space over time


VS

public static final DataDomain VS
Shear velocity


VSVP

public static final DataDomain VSVP
Ratio of shear velocity to pressure velocity


WAVENUMBER

public static final DataDomain WAVENUMBER
The Fourier dual of space

Constructor Detail

DataDomain

public DataDomain(java.lang.String name)
Creates a new DataDomain object with the description equal to the name.

Parameters:
name - the domain name. All names are reduced to lower case to avoid similar but different names.

DataDomain

public DataDomain(java.lang.String name,
                  java.lang.String description)
Creates a new DataDomain object with the description equal to the name.

Parameters:
name - the domain name. All names are reduced to lower case to avoid similar but different names.
description - a description of the domain.
Method Detail

equals

public boolean equals(java.lang.Object obj)
Indicates whether some other object is equal to this object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - an object.
Returns:
true if the input object equals this object, otherwise false.

get

public static DataDomain get(java.lang.String name)
Gets the domain based on the name, or null if the name is not found.

Parameters:
name - the name of the domain.
Returns:
the domain, or null if the name is not found.

getDescription

public java.lang.String getDescription()
Returns the description the domain.

Returns:
the description of the domain.

getName

public java.lang.String getName()
Returns the name the domain.

Returns:
the name of the domain.

hashCode

public int hashCode()
Overrides Object.hashCode() because this class overrides Object.equals(). If a.equals(b), then a.hashCode()==b.hashCode(). If a.hashCode()!=b.hashCode(), then !a.equals(b).

Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Returns a String representation of the object.

Overrides:
toString in class java.lang.Object
Returns:
a String representation of the object.