triana.types

Class SampleSet

java.lang.Object

triana.types.TrianaType

triana.types.GraphType

triana.types.VectorType

triana.types.SampleSet

All Implemented Interfaces:

java.io.Serializable, Arithmetic, AsciiComm, SequenceInterface, Signal

public class SampleSet
extends VectorType
implements AsciiComm, Signal

SampleSet stores a real double[] array or two real double[] arrays (representing a complex array) by extending the VectorType class to implement the Signal interface. This requires two further parameters for the sampling frequency and the acquisition time. The class allows for irregularly sampled data, for which it sets the sampling frequency to zero.

See Also:

ComplexSampleSet, ComplexSpectrum, Spectrum, VectorType, Triplet, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double[]	data (Parameter that is kept for consistency with previous versions, but which is obsolete.
double	samplingFrequency (Parameter that is kept for consistency with previous versions, but which is obsolete.

Fields inherited from class triana.types.VectorType

x, xlabel, y, ylabel

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
SampleSet() Creates an empty SampleSet.
SampleSet(ComplexSampleSet css) Creates a real-valued SampleSet from a ComplexSampleSet by keeping only the real part of the data.
SampleSet(ComplexSampleSet css, boolean copy) Creates a real-valued SampleSet from a ComplexSampleSet by keeping only the real part of the data.
SampleSet(double[] samplingTimes) Creates a new real-valued SampleSet with given sampling times.
SampleSet(double[] samplingTimes, double acquisitionTime) Creates a new real-valued SampleSet with the given sampling times and data acquisition time.
SampleSet(double[] samplingTimes, double[] d) Creates a new real-valued SampleSet with the given sampling times and array of sampled data.
SampleSet(double[] samplingTimes, double[] d, double acquisitionTime) Creates a new real-valued SampleSet with the given sampling times, data array, and data acquisition time.
SampleSet(double[] samplingTimes, double[] dr, double[] di) Creates a new complex-valued SampleSet with the given sampling times and arrays containing the sampled data.
SampleSet(double[] samplingTimes, double[] dr, double[] di, double acquisitionTime) Creates a new complex-valued SampleSet with the given sampling times, data arrays, and data acquisition time.
SampleSet(double sf, double[] d) Creates a new real-valued SampleSet with the given sampling frequency and array of sampled data.
SampleSet(double sf, double[] d, double acquisitionTime) Creates a new real-valued SampleSet with the given sampling frequency, the array of sampled data, and the acquisition time of the first sample.
SampleSet(double sf, double[] dr, double[] di) Creates a new complex-valued SampleSet with a certain sampling frequency and arrays containing the sampled data.
SampleSet(double sf, double[] dr, double[] di, double acquisitionTime) Creates a new complex-valued SampleSet with a certain sampling frequency, the arrays of sampled data, and the acquisition time of the first sample.
SampleSet(double sf, int samples) Creates a new SampleSet with the given sampling frequency and number of samples.
SampleSet(double sf, int samples, boolean allocateMem) Creates a new real-valued SampleSet with the given sampling frequency and number of samples.
SampleSet(double sf, int samples, double acquisitionTime) Creates a new real-valued SampleSet with the given sampling frequency, number of samples, and data acquisition time.

Method Summary

Methods

Modifier and Type	Method and Description
TrianaType	copyMe() This is one of the most important methods of Triana data.
protected void	copyParameters(TrianaType source) Copies modifiable parameters from the argument object to the current object.
boolean	equals(TrianaType obj) Determines whether the argument TrianaType is equal to the current SampleSet.
double	getAcquisitionTime() Returns the acquisition time as a double giving the number of seconds since the reference time, which should be the same reference time as for the method setAcquisitionTime.
double	getSamplingRate() Returns the sampling frequency of the data.
void	inputFromStream(java.io.BufferedReader dis) Used when Triana types want to be able to receive ASCII data from the output of other programs.
void	interpolateZeros(int factor, boolean before) Adds zeros between existing data values using the method of the same name in VectorType.
boolean	isCompatible(TrianaType obj) Tests the argument object to determine if it makes sense to perform arithmetic operations between it and the current object.
void	outputToStream(java.io.PrintWriter dos) Used when Triana types want to be able to send ASCII data to other programs using strings.
int	samples() Obsolete synonym for size.
double	samplingFrequency() Obsolete synonym for getSamplingRate.
void	setAcquisitionTime(double t) Sets the acquisition time.
void	setDefaultAxisLabelling() Added by I.
void	setSamplingFrequency(double s) Obsolete synonym for setSamplingRate.
void	setSamplingRate(double r) Sets the sampling rate of the signal and adjusts the data for the independent variable accordingly.
protected void	updateObsoletePointers()

Methods inherited from class triana.types.VectorType

extendWithZeros, getData, getDataImag, getDataReal, getGraph, getGraphImag, getGraphReal, getScale, getScaleImag, getScaleReal, getXArray, getXImag, getXReal, getXTriplet, initialiseData, initialiseDataComplex, initialiseDataReal, isTriplet, isUniform, length, setData, setData, setDataImag, setDataReal, setX, setX, setX, setXImag, setXReal, size, testDataModel

Methods inherited from class triana.types.GraphType

add, addToTitle, convertDependentDataArraysToBytes, convertDependentDataArraysToDoubles, convertDependentDataArraysToFloats, convertDependentDataArraysToInts, convertDependentDataArraysToLongs, convertDependentDataArraysToShorts, copyData, copyLabels, divide, equals, getDataArrayClass, getDataArrayImag, getDataArrayImag, getDataArrayImagAsBytes, getDataArrayImagAsDoubles, getDataArrayImagAsFloats, getDataArrayImagAsInts, getDataArrayImagAsLongs, getDataArrayImagAsShorts, getDataArrayReal, getDataArrayReal, getDataArrayRealAsBytes, getDataArrayRealAsDoubles, getDataArrayRealAsFloats, getDataArrayRealAsInts, getDataArrayRealAsLongs, getDataArrayRealAsShorts, getDataArrayTypeNames, getDependentLabels, getDependentVariableDimensions, getDependentVariables, getDimensionLengths, getDimensionLengths, getGraphArrayImag, getGraphArrayImagLog10, getGraphArrayReal, getGraphArrayRealLog10, getIndependentArrayImag, getIndependentArrayReal, getIndependentLabels, getIndependentScaleImag, getIndependentScaleImagLog10, getIndependentScaleReal, getIndependentScaleRealLog10, getIndependentTriplet, getIndependentVariables, getLabels, getLabelsColumn, getTitle, isArithmeticArray, isArithmeticData, isCompatible, isDependentComplex, isIndependentComplex, isPrimitiveArray, isPrimitiveData, isTriplet, isUniform, maxDependentGraphingValuesImag, maxDependentGraphingValuesReal, maxDependentVariablesImag, maxDependentVariablesReal, maxIndependentScalesImag, maxIndependentScalesReal, maxIndependentVariablesImag, maxIndependentVariablesReal, minDependentGraphingValuesImag, minDependentGraphingValuesReal, minDependentVariablesImag, minDependentVariablesReal, minIndependentScalesImag, minIndependentScalesReal, minIndependentVariablesImag, minIndependentVariablesReal, multiply, resetDependent, resetIndependent, restrictToSubdomain, restrictToSubdomain, setDataArrayImag, setDataArrayReal, setDependentLabels, setDependentVariableDimensions, setDimensionLengths, setDimensionLengths, setDimensions, setIndependentArrayImag, setIndependentArrayReal, setIndependentLabels, setIndependentTriplet, setIndependentTriplet, setLabels, setTitle, subtract

Methods inherited from class triana.types.TrianaType

containerSize, dataExists, deleteFromContainer, getDataContainer, getFromContainer, getSequenceNumber, insertIntoContainer, inspectDataContainer, setDataContainer, setSequenceNumber

Methods inherited from class java.lang.Object

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

Field Detail

data

public double[] data

(Parameter that is kept for consistency with previous versions, but which is obsolete. It must be kept to the right values by the updateObsoletePointers method and/or constructors and set... methods.)

A synonym for the array stored in the Hashtable dataContainer and accessed by method getDataReal.

samplingFrequency

public double samplingFrequency

(Parameter that is kept for consistency with previous versions, but which is obsolete. It must be kept to the right values by the updateObsoletePointers method and/or constructors and set... methods.)

A synonym for samplingRate.

Constructor Detail

SampleSet

public SampleSet()

Creates an empty SampleSet.

SampleSet

public SampleSet(double sf,
         int samples)

Creates a new SampleSet with the given sampling frequency and number of samples. It allocates memory for the data but does not initialise it. Use method initialiseData to set all elements to zero if necessary. This Constructor also sets the Triplet for the independent variable to generate data starting at 0 with step 1/samplingFrequency, which is the sampling interval.

Parameters:

sf - The sampling frequency in Hz

samples - The number of samples

See Also:

GraphType.setDataArrayReal(java.lang.Object, int), VectorType.initialiseData(), Triplet

SampleSet

public SampleSet(double sf,
         int samples,
         boolean allocateMem)

Creates a new real-valued SampleSet with the given sampling frequency and number of samples. It allocates memory for the data but does not initialise it. Use method initialiseData to set all elements to zero if necessary. This Constructor also sets the Triplet for the independent variable to generate data starting at 0 with step 1/samplingFrequency, which is the sampling interval.

Parameters:

sf - The sampling frequency in Hz

samples - The number of samples

allocateMem - if true, allocates the memory for the array

See Also:

GraphType.setDataArrayReal(java.lang.Object, int), VectorType.initialiseData(), Triplet

SampleSet

public SampleSet(double[] samplingTimes)

Creates a new real-valued SampleSet with given sampling times. It allocates memory for the data but does not initialise it. Use initialiseData to set all elements to zero if necessary. If the data are not uniform, the constructor sets the sampling rate to zero as a signal that the data are irregularly sampled.

Parameters:

samplingTimes - The sampling times array

See Also:

GraphType.setDataArrayReal(java.lang.Object, int), VectorType.initialiseData()

SampleSet

public SampleSet(double sf,
         int samples,
         double acquisitionTime)

Creates a new real-valued SampleSet with the given sampling frequency, number of samples, and data acquisition time. It allocates memory for the data but does not initialise it. Use method initialiseData to set all elements to zero if necessary. This Constructor also sets the Triplet for the independent variable to generate data starting at the acquisition time and with step 1/samplingFrequency, which is the sampling interval.

Parameters:

sf - The sampling frequency in Hz

samples - The number of samples

acquisitionTime - The time of the first sample, in seconds

See Also:

GraphType.setDataArrayReal(java.lang.Object, int), VectorType.initialiseData(), Triplet

SampleSet

public SampleSet(double[] samplingTimes,
         double acquisitionTime)

Creates a new real-valued SampleSet with the given sampling times and data acquisition time. It allocates memory for the sampled data but does not initialise it. Use method initialiseData to set all elements to zero if necessary. If the sampling times are not uniform, the sampling rate is set to zero to indicate that the data are irregularly sampled.

Parameters:

samplingTimes - The sampling times array, in seconds

acquisitionTime - The time of the first sample, in seconds

See Also:

GraphType.setDataArrayReal(java.lang.Object, int), VectorType.initialiseData()

SampleSet

public SampleSet(double sf,
         double[] d)

Creates a new real-valued SampleSet with the given sampling frequency and array of sampled data. This Constructor also sets the Triplet for the independent variable to generate data starting at 0 with step 1/samplingFrequency, which is the sampling interval.

Parameters:

sf - The sampling frequency in Hz

d - The sampled data

See Also:

Triplet

SampleSet

public SampleSet(double[] samplingTimes,
         double[] d)

Creates a new real-valued SampleSet with the given sampling times and array of sampled data. If the sampling times are not uniformly spaced, the Constructor sets the sampling rate to zero as a signal that the data are irregularly sampled.

Parameters:

samplingTimes - The sampling times array in seconds

d - The sampled data

SampleSet

public SampleSet(double sf,
         double[] d,
         double acquisitionTime)

Creates a new real-valued SampleSet with the given sampling frequency, the array of sampled data, and the acquisition time of the first sample. This Constructor also sets the Triplet for the independent variable to generate data starting at the acquisition time and with step 1/samplingFrequency, which is the sampling interval.

Parameters:

sf - The sampling frequency in Hz

d - The sampled data

acquisitionTime - The time of the first sample, in seconds

See Also:

Triplet

SampleSet

public SampleSet(double[] samplingTimes,
         double[] d,
         double acquisitionTime)

Creates a new real-valued SampleSet with the given sampling times, data array, and data acquisition time. If the data are not uniformly sampled, the Constructor sets the sampling frequency to zero as a signal that the data are irregularly sampled.

Parameters:

samplingTimes - The sampling times in seconds

d - The sampled data

acquisitionTime - The time of the first sample, in seconds

SampleSet

public SampleSet(double sf,
         double[] dr,
         double[] di)

Creates a new complex-valued SampleSet with a certain sampling frequency and arrays containing the sampled data. This Constructor also sets the Triplet for the independent variable to generate data starting at 0 with step 1/samplingFrequency, which is the sampling interval.

Parameters:

sf - The sampling frequency

dr - The real part of the sampled data

di - The imaginary part of the sampled data

See Also:

Triplet

SampleSet

public SampleSet(double[] samplingTimes,
         double[] dr,
         double[] di)

Creates a new complex-valued SampleSet with the given sampling times and arrays containing the sampled data. If the sampling times are not uniformly spaced, the Constructor sets the sampling rate to zero as a signal that the data are irregularly sampled.

Parameters:

samplingTimes - The sampling times array

dr - The real part of the sampled data

di - The imaginary part of the sampled data

SampleSet

public SampleSet(double sf,
         double[] dr,
         double[] di,
         double acquisitionTime)

Creates a new complex-valued SampleSet with a certain sampling frequency, the arrays of sampled data, and the acquisition time of the first sample. This Constructor also sets the Triplet for the independent variable to generate data starting at the acquisition time and with step 1/samplingFrequency, which is the sampling interval.

Parameters:

sf - The sampling frequency

dr - The real part of the sampled data

di - The imaginary part of the sampled data

acquisitionTime - The time of the first sample, in seconds

See Also:

Triplet

SampleSet

public SampleSet(double[] samplingTimes,
         double[] dr,
         double[] di,
         double acquisitionTime)

Creates a new complex-valued SampleSet with the given sampling times, data arrays, and data acquisition time. If the data are not uniformly sampled, the Constructor sets the sampling frequency to zero as a signal that the data are irregularly sampled.

Parameters:

samplingTimes - The sampling times

dr - The real part of the sampled data

di - The imaginary part of the sampled data

acquisitionTime - The time of the first sample, in seconds

SampleSet

public SampleSet(ComplexSampleSet css,
         boolean copy)

Creates a real-valued SampleSet from a ComplexSampleSet by keeping only the real part of the data. The second argument allows the user to choose whether the new data are copied from the old or simply a reference to the old.

Parameters:

css - The input data set

copy - True if the new data are to be copied from the old, false if passed by reference

SampleSet

public SampleSet(ComplexSampleSet css)

Creates a real-valued SampleSet from a ComplexSampleSet by keeping only the real part of the data. The new data are simply a reference to the old.

Parameters:

css - The input data set

Method Detail

setDefaultAxisLabelling

public void setDefaultAxisLabelling()

Added by I. Taylor, August 2001 : This function sets the default labeling scheme used for the axis by this data type. All constructors call this function to set default values for the axis.

Overrides:

setDefaultAxisLabelling in class GraphType

getSamplingRate

public double getSamplingRate()

Returns the sampling frequency of the data. If the data are irregularly sampled it returns 0.

Specified by:

getSamplingRate in interface Signal

Returns:

double The sampling frequency

setSamplingRate

public void setSamplingRate(double r)

Sets the sampling rate of the signal and adjusts the data for the independent variable accordingly. If the sampling frequency argument r is negative, nothing is done. If it is zero, irregular sampling is assumed. If positive, the sampling frequency is set to r and the values of the independent variable are re-adjusted accordingly if necessary, assuming the same starting time as before the change in the rate. This method also writes the new sampling frequency into the description StringVector and calls method updateObsoletePointers. If there is an audio format, it is updated with the new sampling rate.

Specified by:

setSamplingRate in interface Signal

Parameters:

r - The sampling rate

getAcquisitionTime

public double getAcquisitionTime()

Returns the acquisition time as a double giving the number of seconds since the reference time, which should be the same reference time as for the method setAcquisitionTime. The time set is interpreted as the moment of acquisition of the first sample in the data set.

Specified by:

getAcquisitionTime in interface Signal

Returns:

double The time of acquisition in seconds since the reference time

setAcquisitionTime

public void setAcquisitionTime(double t)

Sets the acquisition time. This method also writes the acquisition time into the description StringVector. If the given acquisition time is not equal to the starting time of the independent variable, all values of the independent variable are shifted by the difference between the given time and the previous starting time.

Specified by:

setAcquisitionTime in interface Signal

Parameters:

t - The acquisition time in seconds

samplingFrequency

public double samplingFrequency()

Obsolete synonym for getSamplingRate.

Returns:

double The sampling frequency in Hz

setSamplingFrequency

public void setSamplingFrequency(double s)

Obsolete synonym for setSamplingRate.

Parameters:

s - The new sampling frequency in Hz

samples

public int samples()

Obsolete synonym for size.

Returns:

int The number of samples in this SampleSet

interpolateZeros

public void interpolateZeros(int factor,
                    boolean before)

Adds zeros between existing data values using the method of the same name in VectorType. AdjustssamplingRate accordingly. If added before the first sample, then it adjusts the value of acquisitionTime so that it gives the time of the first zero if the previous first data point is acquired at the previous value of acquisitionTime.

Overrides:

interpolateZeros in class VectorType

Parameters:

factor - The number of zeros per data point to be inserted

before - True if the zeros go before each point, false if after

copyMe

public TrianaType copyMe()

This is one of the most important methods of Triana data. types. It returns a copy of the type invoking it. This must be overridden for every derived data type derived. If not, the data cannot be copied to be given to other units. Copying must be done by value, not by reference.

To override, the programmer should not invoke the super.copyMe method. Instead, create an object of the current type and call methods copyData and copyParameters. If these have been written correctly, then they will do the copying. The code should createTool, for type YourType:

 YourType y = null; try { y =
 (YourType)getClass().newInstance(); y.copyData( this ); y.copyParameters( this ); y.setLegend( this.getLegend()
 ); } catch (IllegalAccessException ee) { System.out.println("Illegal Access: " + ee.getMessage()); } catch
 (InstantiationException ee) { System.out.println("Couldn't be instantiated: " + ee.getMessage()); } return y;
 

The copied object's data should be identical to the original. The method here modifies only one item: a String indicating that the object was created as a copy is added to the description StringVector.

Overrides:

copyMe in class VectorType

Returns:

TrianaType Copy by value of the current Object except for an updated description

copyParameters

protected void copyParameters(TrianaType source)

Copies modifiable parameters from the argument object to the current object. The copying is by value, not by reference. Parameters are defined as data not held in dataContainer. They are modifiable if they have set... methods. Parameters that cannot be modified, but which are set by constructors, should be placed correctly into the copied object when it is constructed.

In SampleSet, only the parameters samplingRate, acquisitionTime, and uniformlySampled need to be copied. The obsolete parameter samplingFrequency is generated automatically when the other parameters are copied and set.

This must be overridden by any subclass that defines new parameters. The overriding method should invoke its super method. It should use the set... and get... methods for the parameters in question. This method is protected so that it cannot be called except by objects that inherit from this one. It is called by copyMe.

Overrides:

copyParameters in class GraphType

Parameters:

source - Data object that contains the data to be copied.

outputToStream

public void outputToStream(java.io.PrintWriter dos)
                    throws java.io.IOException

Used when Triana types want to be able to send ASCII data to other programs using strings. This is used to implement socket and to run other executables, written in C or other languages. With ASCII you don't have to worry about ENDIAN'ness as the conversions are all done via text. This is obviously slower than binary communication since you have to format the input and output within the other program.

This method must be overridden in every subclass that defines new data or parameters. The overriding method should first call<

 super.outputToStream(dos) 

to get output from superior classes, and then new parameters defined for the current subclass must be output. Moreover, subclasses that first dimension their data arrays must explicitly transfer these data arrays.

Specified by:

outputToStream in interface AsciiComm

Overrides:

outputToStream in class GraphType

Parameters:

dos - The data output stream

Throws:

java.io.IOException

inputFromStream

public void inputFromStream(java.io.BufferedReader dis)
                     throws java.io.IOException

Used when Triana types want to be able to receive ASCII data from the output of other programs. This is used to implement socket and to run other executables, written in C or other languages. With ASCII you don't have to worry about ENDIAN'ness as the conversions are all done via text. This is obviously slower than binary communication since you have to format the input and output within the other program.

This method must be overridden in every subclass that defines new data or parameters. The overriding method should first call

 super.inputFromStream(dis) 

to get input from superior classes, and then new parameters defined for the current subclass must be input. Moreover, subclasses that first dimension their data arrays must explicitly transfer these data arrays.

Specified by:

inputFromStream in interface AsciiComm

Overrides:

inputFromStream in class GraphType

Parameters:

dis - The data input stream

Throws:

java.io.IOException

isCompatible

public boolean isCompatible(TrianaType obj)

Tests the argument object to determine if it makes sense to perform arithmetic operations between it and the current object.

In SampleSet, this method first tests for compatibility with superior classes, and then (if the input object is a SampleSet) tests that the input has the same sampling rate as the current object.

Classes derived from this should over-ride this method with further tests as appropriate. The over-riding method should normally have the first lines

 boolean test = super.isCompatible( obj ); 

followed by other tests. If other types not subclassed from GraphType or Const should be allowed to be compatible then other tests must be implemented.

Overrides:

isCompatible in class VectorType

Parameters:

obj - The data object to be compared with the current one

Returns:

True if the object can be combined with the current one

equals

public boolean equals(TrianaType obj)

Determines whether the argument TrianaType is equal to the current SampleSet. They are equal if the argument is a SampleSet with the same size, parameters, and data.

This method must be over-ridden in derived types. In a derived type called xxx the method should begin

 if ( !( obj instanceof xxx ) ) return false; if (
 !isCompatible( obj ) ) return false; 

followed by tests that are specific to type xxx (testing its own parameters) and then as a last line

 return super.equals( obj ); 

This line invokes the other equals methods up the chain to GraphType. Each superior object tests its own parameters.

Parameters:

obj - The object being tested

Returns:

true if they are equal or false otherwise

updateObsoletePointers

protected void updateObsoletePointers()

Overrides:

updateObsoletePointers in class VectorType