edu.iris.Fissures.seed.container
Class Waveform

java.lang.Object
  edu.iris.Fissures.seed.container.SeedObject
      edu.iris.Fissures.seed.container.Waveform

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class Waveform

extends SeedObject

Default waveform container. Data is stored in its native encoded form. This object retains information on the encoding format, the number of samples, and the byte swapping flag.

Version:

10/9/2002

Author:

Robert Casey, IRIS DMC

See Also:

Serialized Form

Constructor Summary

Waveform(byte[] record, int dataOffset, int numSamples, java.lang.String encoding, boolean swapBytes)
Initialize the waveform object with an encoded data set starting at the offset index indicated.

Waveform(float[] floatData, int maxByteLen, java.lang.String encoding)
Initialize the waveform object with an array of float values.

Waveform(float[] floatData, int maxByteLen, java.lang.String encoding, float bias)
Initialize the waveform object with an array of float values.

Waveform(int[] intData, int maxByteLen, java.lang.String encoding)
Initialize the waveform object with an array of integer values.

Waveform(int[] intData, int maxByteLen, java.lang.String encoding, int bias)
Initialize the waveform object with an array of integer values.

Method Summary

float[]	getDecodedFloats() Decode waveform data to an array of float values.
float[]	getDecodedFloats(float bias) Decode waveform data to an array of float values.
int[]	getDecodedIntegers() Decode waveform data to an array of integer values.
int[]	getDecodedIntegers(int bias) Decode waveform data to an array of integer values.
byte[]	getEncodedBytes() Return the raw encoded byte stream.
java.lang.String	getEncoding() Return the String representing the encoding format of the data.
int	getLookupId() Return a fixed value for the lookup ID.
int	getNumSamples() Return the number of samples of this waveform.
boolean	getSwapBytes() Return the byte swap flag.
int	getType() Return a fixed value representing this SeedObject type.
static void	main(java.lang.String[] args) Test method.
void	setEncoding(java.lang.String format) Identify the encoding of the data contained in this object.
void	setNumSamples(int samples) Change the number of samples representing this data, if you dare.
void	setSwapBytes(boolean flag) Toggle the swap byte flag to true or false.
java.lang.String	toString() Display a string description of this Waveform object's contents.

Methods inherited from class edu.iris.Fissures.seed.container.SeedObject

compareTo

Methods inherited from class java.lang.Object

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

Constructor Detail

Waveform

public Waveform(byte[] record,
                int dataOffset,
                int numSamples,
                java.lang.String encoding,
                boolean swapBytes)

Initialize the waveform object with an encoded data set starting at the offset index indicated. The encoding format and byte swap flag is indicated during build time. Encoding format is a predefined String pertaining to a SEED-recognized format. swapBytes is set to true for VAX/8086 word order.

Waveform

public Waveform(int[] intData,
                int maxByteLen,
                java.lang.String encoding,
                int bias)
         throws java.lang.Exception

Initialize the waveform object with an array of integer values. Encode the data with the specified encoding format to a maximum byte length of maxByteLen. bias is an initial value representing the last sample of the previous Waveform, for use in difference compression. Default value is 0.

Waveform

public Waveform(int[] intData,
                int maxByteLen,
                java.lang.String encoding)
         throws java.lang.Exception

Initialize the waveform object with an array of integer values. Encode the data with the specified encoding format to a maximum byte length of maxByteLen. Assumed bias value of 0 for differencing compression.

Waveform

public Waveform(float[] floatData,
                int maxByteLen,
                java.lang.String encoding,
                float bias)
         throws java.lang.Exception

Initialize the waveform object with an array of float values. Encode the data with the specified encoding format to a maximum byte length of maxByteLen. bias is an initial value representing the last sample of the previous Waveform, for use in difference compression. Default value is 0.

Waveform

public Waveform(float[] floatData,
                int maxByteLen,
                java.lang.String encoding)
         throws java.lang.Exception

Initialize the waveform object with an array of float values. Encode the data with the specified encoding format to a maximum byte length of maxByteLen. Assumed bias value of 0 for difference compression.

Method Detail

getType

public int getType()

Return a fixed value representing this SeedObject type.

Specified by:

getType in class SeedObject

getLookupId

public int getLookupId()

Return a fixed value for the lookup ID. Waveform objects do not need to be distinguished from others, since they are always attached to Blockettes.

Specified by:

getLookupId in class SeedObject

getDecodedIntegers

public int[] getDecodedIntegers(int bias)
                         throws java.lang.Exception

Decode waveform data to an array of integer values. Indicate bias as a carryover from a previous data record.

Throws:

java.lang.Exception

getDecodedIntegers

public int[] getDecodedIntegers()
                         throws java.lang.Exception

Decode waveform data to an array of integer values. Bias is assumed to be zero.

Throws:

java.lang.Exception

getDecodedFloats

public float[] getDecodedFloats(float bias)
                         throws java.lang.Exception

Decode waveform data to an array of float values. Indicate bias as a carryover from a previous data record.

Throws:

java.lang.Exception

getDecodedFloats

public float[] getDecodedFloats()
                         throws java.lang.Exception

Decode waveform data to an array of float values.

Throws:

java.lang.Exception

getEncodedBytes

public byte[] getEncodedBytes()
                       throws java.lang.Exception

Return the raw encoded byte stream.

Throws:

java.lang.Exception

getNumSamples

public int getNumSamples()

Return the number of samples of this waveform.

getSwapBytes

public boolean getSwapBytes()

Return the byte swap flag. Indicates true if in VAX/8086 order, since Java is by nature 68000/Sun order.

getEncoding

public java.lang.String getEncoding()

Return the String representing the encoding format of the data. contained.

setNumSamples

public void setNumSamples(int samples)

Change the number of samples representing this data, if you dare.

setSwapBytes

public void setSwapBytes(boolean flag)

Toggle the swap byte flag to true or false.

setEncoding

public void setEncoding(java.lang.String format)

Identify the encoding of the data contained in this object.

toString

public java.lang.String toString()

Display a string description of this Waveform object's contents.

Specified by:

toString in class SeedObject

main

public static void main(java.lang.String[] args)

Test method.