triana.types

Class VectorType

java.lang.Object

triana.types.TrianaType

triana.types.GraphType

triana.types.VectorType

All Implemented Interfaces:

java.io.Serializable, Arithmetic, AsciiComm, SequenceInterface

Direct Known Subclasses:

ComplexSampleSet, ComplexSpectrum, Histogram, SampleSet, Spectrum

public class VectorType
extends GraphType
implements AsciiComm

VectorType is the basic class derived from GraphType to represent one-dimensional array data of type double. It does not define extra parameters, so it is a "raw" data type. It can hold real or complex one-dimensional data sets.

VectorType sets independentVariables = 1 and dependentVariables = 1 so it represents the values of a scalar function of one independent variable. If that variable is sampled uniformly, then the object holds only the sampled data and a Triplet indicating how the sampling is done. If the independent variable is sampled irregularly, then the object holds the sampling values as well. Users can use method isIndependentTriplet (or method isUniform) to see which case holds.

VectorType defines new methods that allow padding or interpolation of the data with zeros. These are useful in many signal-analysis applications that will use types derived from VectorType.

VectorType replaces the old Triana type RawData. For compatibility with that class there are some obsolete functions and parameters added here. In later releases these should be removed.

See Also:

TrianaType, GraphType, Arithmetic, MatrixType, Triplet, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double[]	x (Parameter that is kept for consistency with previous versions, but which is obsolete.
java.lang.String	xlabel (Parameter that is kept for consistency with previous versions, but which is obsolete.
double[]	y (Parameter that is kept for consistency with previous versions, but which is obsolete.
java.lang.String	ylabel (Parameter that is kept for consistency with previous versions, but which is obsolete.

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
VectorType() Creates a new empty VectorType, but it has to have specified dimensions.
VectorType(double[] y) Creates a new real VectorType with a uniformly sampled independent variable by using the argument array of doubles as the data and assuming that the independent variable is simply the index of the data array, ie it runs from 0 to length - 1 in steps of 1.
VectorType(double[] x, double[] y) Creates a new real VectorType using the first argument array of doubles as the sampling values of the independent variable and the second argument array of doubles as the real data.
VectorType(double[] xr, double[] xi, double[] yr, double[] yi) Creates a new complex-valued VectorType with a complex independent variable by using the first two argument arrays of doubles as the real part and imaginary part of the indpendent variable, and the second two argument arrays of doubles as the real part and imaginary part of the dependent variable.
VectorType(Triplet xTr, double[] y) Creates a new real VectorType with a uniformly sampled independent variable by using the first argument as the as the Triplet that determines how the independent variable is uniformly sampled and the second argument as the real data.
VectorType(Triplet xTr, double[] yr, double[] yi) Creates a new complex-valued VectorType with a real uniformly-sampled independent variable by using the first (Triplet) argument to determine how the independent variable is uniformly sampled, the second argument (double[]) as the real part of the data, and the third argument (double[]) as the imaginary part.

Method Summary

Methods

Modifier and Type	Method and Description
TrianaType	copyMe() This is one of the most important methods of Triana data.
void	extendWithZeros(int newLength, boolean front) Extends the data set (both real and imaginary parts) to a longer set by padding with zeros.
double[]	getData() A synonym for getDataReal for use when data is known to be only real.
double[]	getDataImag() Returns the imaginary part of the data array for the dependent variable.
double[]	getDataReal() Returns the real part of the data array for the given dependent variable.
double[]	getGraph() A synonym for getGraphReal for use when the data is known to be real.
double[]	getGraphImag() Returns the imaginary part of the array that will be graphed for the given dependent variable.
double[]	getGraphReal() Returns the real part of the array that will be graphed for the given dependent variable.
double[]	getScale() A synonym for getScaleReal for use when the data are known to be real.
double[]	getScaleImag() Returns an array containing the imaginary part of the data scale for the independent variable.
double[]	getScaleReal() Returns an array containing the real part of the data scale for the independent variable.
double[]	getXArray() A synonym for getXReal for use when the data are known to be real.
double[]	getXImag() Returns the imaginary part of the data array for the independent variable.
double[]	getXReal() Returns the real part of the data array for the independent variable.
Triplet	getXTriplet() Returns the Triplet giving the independent data.
void	initialiseData() Sets the data array(s) to zero if they have been allocated.
void	initialiseDataComplex(int len) Allocates the real and imaginary parts of the data to double arrays of the given length and then sets their elements to zero.
void	initialiseDataReal(int len) Allocates the real part of the data to a double array of the given length and then sets its elements to zero.
void	interpolateZeros(int factor, boolean before) Inserts zeros in between existing elements of the data set.
boolean	isCompatible(TrianaType obj) Tests the argument object to determine if it makes sense to perform arithmetic operations between it and the current object.
boolean	isTriplet() Tests to see if the independent variable is represented by a Triplet.
boolean	isUniform() Tests to see if the independent variable is uniformly sampled.
int	length() A synonym for size.
void	setData(double[] data) An alias for setDataReal, useful in derived classes where the data is assumed to be real all the time.
void	setData(double[] dataReal, double[] dataImag) Sets the two argument double[] arrays as the real and imaginary parts of the dependent variable.
void	setDataImag(double[] data) Sets the argument double[] array as the imaginary part of the dependent variable.
void	setDataReal(double[] data) Sets the argument double[] array as the (real part of) the dependent variable.
void	setX(double[] data) Sets the argument double[] as the independent variable.
void	setX(double[] xReal, double[] xImag) Sets the two argument double[] arrays as the real and imaginary parts of the independent variable.
void	setX(Triplet tr) Sets the argument Triplet as the independent variable.
void	setXImag(double[] data) Sets the argument double[] as the imaginary part of the independent variable.
void	setXReal(double[] data) Sets the argument double[] as the (real part of the) independent variable.
int	size() Returns the size or length of the data array.
boolean	testDataModel() Tests to make sure this Object obeys the VectorType data model.
protected void	updateObsoletePointers()

Methods inherited from class triana.types.GraphType

add, addToTitle, convertDependentDataArraysToBytes, convertDependentDataArraysToDoubles, convertDependentDataArraysToFloats, convertDependentDataArraysToInts, convertDependentDataArraysToLongs, convertDependentDataArraysToShorts, copyData, copyLabels, copyParameters, 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, inputFromStream, 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, outputToStream, resetDependent, resetIndependent, restrictToSubdomain, restrictToSubdomain, setDataArrayImag, setDataArrayReal, setDefaultAxisLabelling, 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

Methods inherited from interface triana.types.AsciiComm

inputFromStream, outputToStream

Field Detail

xlabel

public java.lang.String xlabel

(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.)

The x-axis label. Now obsolete, replaced by GraphType.labels.

ylabel

public java.lang.String ylabel

(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.)

The y-axis label. Now obsolete, replaced by GraphType.labels.

x

public double[] x

(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.)

The x data. Now obsolete, replaced by TrianaType.dataContainer.

y

public double[] y

(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.)

The y data. Now obsolete, replaced by TrianaType.dataContainer.

Constructor Detail

VectorType

public VectorType()

Creates a new empty VectorType, but it has to have specified dimensions.

VectorType

public VectorType(double[] y)

Creates a new real VectorType with a uniformly sampled independent variable by using the argument array of doubles as the data and assuming that the independent variable is simply the index of the data array, ie it runs from 0 to length - 1 in steps of 1.

Parameters:

y - Dependent data array

VectorType

public VectorType(double[] x,
          double[] y)

Creates a new real VectorType using the first argument array of doubles as the sampling values of the independent variable and the second argument array of doubles as the real data.

Parameters:

x - Independent data array

y - Dependent data array

VectorType

public VectorType(Triplet xTr,
          double[] y)

Creates a new real VectorType with a uniformly sampled independent variable by using the first argument as the as the Triplet that determines how the independent variable is uniformly sampled and the second argument as the real data.

One can invoke this method by constructing the Triplet argument in the reference statement to this Constructor, eg by using an argument of the form

 new Triplet(length, start, step) 

Parameters:

xTr - the generator of the independent variable

y - the data of the dependent variable

See Also:

Triplet

VectorType

public VectorType(Triplet xTr,
          double[] yr,
          double[] yi)

Creates a new complex-valued VectorType with a real uniformly-sampled independent variable by using the first (Triplet) argument to determine how the independent variable is uniformly sampled, the second argument (double[]) as the real part of the data, and the third argument (double[]) as the imaginary part.

One can invoke this method by constructing the Triplet argument in the reference statement to this Constructor, eg by using an argument of the form

 new Triplet(length, start, step) 

Parameters:

xTr - the generator of the independent variable

yr - the data of the real part of the dependent variable

yi - the data of the imaginary part of the dependent variable

See Also:

Triplet

VectorType

public VectorType(double[] xr,
          double[] xi,
          double[] yr,
          double[] yi)

Creates a new complex-valued VectorType with a complex independent variable by using the first two argument arrays of doubles as the real part and imaginary part of the indpendent variable, and the second two argument arrays of doubles as the real part and imaginary part of the dependent variable.

Parameters:

xr - the real part of the data of the independent variable

xi - the imaginary part of the data of the independent variable

yr - the real part of the data of the dependent variable

yi - the imaginary part of the data of the dependent variable

Method Detail

isUniform

public boolean isUniform()

Tests to see if the independent variable is uniformly sampled. It calls the isUniform method of GraphType for index 0.

Returns:

boolean True if the independent variable is sampled uniformly

isTriplet

public boolean isTriplet()

Tests to see if the independent variable is represented by a Triplet. It calls the isTriplet method of GraphType for index 0.

Returns:

boolean True if the independent variable is given as a Triplet

See Also:

Triplet

size

public int size()

Returns the size or length of the data array.

Returns:

int Length of the data set

length

public int length()

A synonym for size.

Returns:

int Length of the data set

getDataReal

public double[] getDataReal()

Returns the real part of the data array for the given dependent variable. This is just an alias for getDataArrayReal(0) that allows users not to worry about the index, since in VectorType there is only one dependent data set.

Returns:

double[] The (real part of the ) data array

getGraphReal

public double[] getGraphReal()

Returns the real part of the array that will be graphed for the given dependent variable. This is just an alias for getGraphArrayReal(0) that allows users not to worry about the index, since in VectorType there is only one dependent data set. This method should be not be over-ridden by derived classes, even if the independent data are stored in an unconventional manner, for example non-monotonic. Instead, the method getGraphArrayReal of GraphType should be overridden.

Returns:

double[] The (real part of the) graph array

See Also:

GraphType

getDataImag

public double[] getDataImag()

Returns the imaginary part of the data array for the dependent variable. This is just an alias for getDataArrayImag(0) that allows users not to worry about the index, since in VectorType there is only one dependent data set.

Returns:

double[] The imaginary part of the data array

getGraphImag

public double[] getGraphImag()

Returns the imaginary part of the array that will be graphed for the given dependent variable. This is just an alias for getGraphArrayImag(0) that allows users not to worry about the index, since in VectorType there is only one dependent data set. This method should be not be over-ridden by derived classes, even if the independent data are stored in an unconventional manner, for example non-monotonic. Instead, the method getGraphArrayImag of GraphType should be overridden.

Returns:

double[] The imaginary part of graph array

See Also:

GraphType

getData

public double[] getData()

A synonym for getDataReal for use when data is known to be only real.

Returns:

double[] The real data array

getGraph

public double[] getGraph()

A synonym for getGraphReal for use when the data is known to be real. This method should not be over-ridden in derived classes.

Returns:

double[] The real graph array

setDataReal

public void setDataReal(double[] data)

Sets the argument double[] array as the (real part of) the dependent variable.

Parameters:

data - The new data

setData

public void setData(double[] data)

An alias for setDataReal, useful in derived classes where the data is assumed to be real all the time.

Parameters:

data - The new data

setDataImag

public void setDataImag(double[] data)

Sets the argument double[] array as the imaginary part of the dependent variable.

Parameters:

data - The new data

setData

public void setData(double[] dataReal,
           double[] dataImag)

Sets the two argument double[] arrays as the real and imaginary parts of the dependent variable.

Parameters:

dataReal - The real part of the new data

dataImag - The imaginary part of the new data

initialiseData

public void initialiseData()

Sets the data array(s) to zero if they have been allocated. Does nothing if they have not been allocated.

initialiseDataReal

public void initialiseDataReal(int len)

Allocates the real part of the data to a double array of the given length and then sets its elements to zero.

Parameters:

len - The length of the data array being created

initialiseDataComplex

public void initialiseDataComplex(int len)

Allocates the real and imaginary parts of the data to double arrays of the given length and then sets their elements to zero.

Parameters:

len - The length of the data arrays being created

getXTriplet

public Triplet getXTriplet()

Returns the Triplet giving the independent data. If the data is not uniformly sampled then it returns null.

Returns:

Triplet The independent variable as a Triplet, or null if not uniformly sampled

See Also:

Triplet

getXReal

public double[] getXReal()

Returns the real part of the data array for the independent variable. If it is uniformly sampled, any Triplet is converted to an array.

Returns:

double[] The real part of independent variable

See Also:

Triplet

getScaleReal

public double[] getScaleReal()

Returns an array containing the real part of the data scale for the independent variable. This should be not be over-ridden by derived classes, even if the independent data are stored in an unconventional manner, for example non-monotonic. Instead, the method getIndependentScaleReal of GraphType should be overridden.

Returns:

double[] The real part of independent variable's scale

See Also:

GraphType

getXImag

public double[] getXImag()

Returns the imaginary part of the data array for the independent variable.

Returns:

double[] The imaginary part of the independent variable

getScaleImag

public double[] getScaleImag()

Returns an array containing the imaginary part of the data scale for the independent variable. This should be not be over-ridden by derived classes, even if the independent data are stored in an unconventional manner, for example non-monotonic. Instead, the method getIndependentScaleImag of GraphType should be overridden.

Returns:

double[] The imaginary part of independent variable's scale

See Also:

GraphType

getXArray

public double[] getXArray()

A synonym for getXReal for use when the data are known to be real.

Returns:

double[] The (real part of the) independent variable

getScale

public double[] getScale()

A synonym for getScaleReal for use when the data are known to be real. Do not override this method in derived classes.

Returns:

double[] The (real part of the) independent variable's scale

setX

public void setX(Triplet tr)

Sets the argument Triplet as the independent variable.

Parameters:

tr - The new data

See Also:

Triplet

setX

public void setX(double[] data)

Sets the argument double[] as the independent variable.

Parameters:

data - The new data for the independent variable

setXReal

public void setXReal(double[] data)

Sets the argument double[] as the (real part of the) independent variable. Synonym for SetX.

Parameters:

data - The new data for the real part of the independent variable

setXImag

public void setXImag(double[] data)

Sets the argument double[] as the imaginary part of the independent variable.

Parameters:

data - The new data for the imaginary part of the independent variable

setX

public void setX(double[] xReal,
        double[] xImag)

Sets the two argument double[] arrays as the real and imaginary parts of the independent variable.

Parameters:

xReal - The real part of the independent variable

xImag - The imaginary part of the independent variable

extendWithZeros

public void extendWithZeros(int newLength,
                   boolean front)

Extends the data set (both real and imaginary parts) to a longer set by padding with zeros. The given integer argument gives the new length after padding, and the boolean argument determines whether the padding is at the front or the back.

If the new length is shorter than the old, nothing is done.

Derived types should override this if necessary to provide for the correct handling of parameters and other special features.

Parameters:

newLength - The new length of the data set

front - True if padding is at the front, false for padding at the back

interpolateZeros

public void interpolateZeros(int factor,
                    boolean before)

Inserts zeros in between existing elements of the data set. The integer argument factor gives the number of zeros per existing data point that must be inserted. The boolean argument before regulates whether the zeros should be inserted before each element (if true) or after (false). The new values of the independent variable are interpolated between those of the old ones, using uniform interpolation even if the data are sampled irregularly.

If the argument factor is zero or negative, nothing is done.

Derived types should override this if necessary to provide for the correct handling of parameters and other special features.

Parameters:

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

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

testDataModel

public boolean testDataModel()

Tests to make sure this Object obeys the VectorType data model.

Overrides:

testDataModel in class GraphType

Returns:

boolean True if it obeys the GraphType model and if the values of independentVariables and dependentVariables are right.

See Also:

Triplet

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.

Specified by:

copyMe in class GraphType

Returns:

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

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 VectorType, this method tests first for compatibility with superior classes and then tests whether the input is a VectorType data object with the same value of isUniform as the current one. It does not require that the independent data values should be the same, since one might want to add together subsequent data sets, e.g. when one performs averages.

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.

Parameters:

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

Returns:

True if the object can be combined with the current one

updateObsoletePointers

protected void updateObsoletePointers()

Overrides:

updateObsoletePointers in class TrianaType