Provides a C++ object interface to various vector routines

Inheritance:

Public Methods

	LwsVector () Object creator.
	~LwsVector () Object destructor.
float	Energy ( float* inputData, long numberOfElements ) Calculates the energy in the given trace.
float*	Semblance ( float* traceData, long nTrace, float* eventData, long nEvent, long* semblanceLength ) Calculates the semblance between the two given trace.

Inherited from LwsBase:

Public Methods

void Clean()

void Setup()

void SetErrorMessage( string newErrorMessage)

void AppendErrorMessage( string nextErrorMessage )

string GetPreviousErrorMessage()

string GetErrorMessage( )

void StdOut( float* output, long numberOfSamples )

void StdFileOut( float* output, long numberOfSamples, string outputFileName="lastDataOutput" )

void FileOut( float* output, long numberOfSamples, string outputFileName="lastDataOutput" )

float* GetFileInput( string inputFileName, long* numberOfSamples )

string GetTempName( string seed = "ktmp")

Private Fields

string previousError

string currentError

Documentation

Provides a C++ object interface to various vector routines

LwsVector()

Object creator. You can provide the filter parameters here, or settle for the defaults.

Parameters:

none. -

Returns:

none.

~LwsVector()

Object destructor. Frees up the objects memory. Does not free up the array returned by build. The latter is the user's responsibility.

Parameters:

none. -

Returns:

none.

float Energy( float* inputData, long numberOfElements )

Calculates the energy in the given trace. This is the sum of the squares of the elements.

Parameters:

- inputData is the input trace.
numberOfElements - is the number of elements in the trace.

Returns:

energy, the float that is the energy.

float* Semblance( float* traceData, long nTrace, float* eventData, long nEvent, long* semblanceLength )

Calculates the semblance between the two given trace. The semblance is the energy of the sum to the mean energy of the components. See the RunSemblance documentation for more information.

Parameters:

traceData - is the first input trace.
eventData - is the second input trace.
nTrace - is the number of elements in traceData.
nEvent - is the number of elements in eventData.
semblanceLength - is the length of semblance array, nTrace+2*nEvent. In the case of an error, we return a NULL pointer.

Returns:

semblance, a floating point array that contains the semblance. This array must be deleted by the calling routine when it is no longer needed.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

Copyright 1993, 1994 Geophysical Software, Inc.

2603 Peninsulas Drive, Missouri City Texas 77459, (713)438-0583.

All Rights Reserved Company Confidential

Prepared for University of Minnesota, October, 2001