triana.types

Class MatrixType

java.lang.Object

triana.types.TrianaType

triana.types.GraphType

triana.types.MatrixType

All Implemented Interfaces:

java.io.Serializable, Arithmetic, AsciiComm, SequenceInterface

Direct Known Subclasses:

Spectrum2D, TimeFrequency

public class MatrixType
extends GraphType
implements AsciiComm

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

MatrixType sets GraphType.independentVariables = 2 and GraphType.dependentVariables = 1, so it represents the values of a scalar function of two independent variables. If the variables are sampled uniformly, then the object holds only the sampled data and two Triplets indicating how the sampling is done. If the independent variables are sampled irregularly, then the object holds the sampling values as well. Users can test method isIndependentTriplet (or method isUniform ) to see which case holds.

See Also:

TrianaType, GraphType, Arithmetic, VectorType, Triplet, Serialized Form

Field Summary

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
MatrixType() Creates a new empty MatrixType, but with the specific dimensions of this class
MatrixType(double[][] z) Creates a new real MatrixType with a uniformly sampled independent variables by using the 2D argument array z of doubles as the data and assuming that the independent variables are simply the indices of the data array, ie x runs from 0 to z.length - 1 in steps of 1 and y runs from 0 to z[0].length - 1 in steps of 1.
MatrixType(double[] x, double[] y, double[][] z) Creates a new real MatrixType using the first argument array of doubles as the sampling values of the first independent variable (x), the second argument array as the samples of the second independent variable (y), and the third argument 2D array of doubles as the dependent variable real data.
MatrixType(double[] xr, double[] xi, double[] yr, double[] yi, double[][] zr, double[][] zi) Creates a new complex-valued MatrixType with complex independent variables by using the first two argument arrays of doubles as the real part and imaginary part of the first independent variable (x), the third and fourth arguments as the real and imaginary parts of the second independent variable (y), and the fifth and sixth argument double[][] arrays as the real and imaginary parts of the dependent variable.
MatrixType(Triplet xTr, Triplet yTr, double[][] z) Creates a new real MatrixType with a uniformly sampled independent variable by using the first argument as the as the Triplet that determines how the first independent variable (x) is uniformly sampled, the second Triplet argument to determine how the second independent variable (y) is uniformly sampled, and the third argument as the dependent variable real data.
MatrixType(Triplet xTr, Triplet yTr, double[][] zr, double[][] zi) Creates a new complex-valued MatrixType with real uniformly-sampled independent variables by using the first two (Triplet) arguments to determine how the independent variables are uniformly sampled, the third argument (double[][]) as the real part of the dependent variable data, and the fourth 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.
double[][]	getData() Returns the (real part of the) data array for the dependent variable.
double[][]	getDataImag() Returns the imaginary part of the data array for the dependent variable.
double[][]	getDataReal() A synonym for getData.
double[]	getXorYArray(int dim) Returns the real part of the data values for the given independent variable.
double[]	getXorYImag(int dim) Returns the imaginary part of the data array for the given independent variable.
double[]	getXorYReal(int dim) A synonym for getXYArray.
Triplet	getXorYTriplet(int dim) Method getXorYTriplet returns the Triplet that determines the values of the given independent variable.
void	initialiseData() Sets the data array(s) to zero if they have been allocated.
void	initialiseDataComplex(int xlen, int ylen) Allocates the real and imaginary parts of the data to double arrays of the given lengths and then sets their elements to zero.
void	initialiseDataReal(int xlen, int ylen) Allocates the real part of the data to a double array of the given lengths and then sets its elements to zero.
boolean	isCompatible(TrianaType obj) Tests the argument object to determine if it makes sense to perform arithmetic operations between it and the current object.
int[]	length() A synonym for size.
void	setData(double[][] data) Sets the argument double[][] array as the dependent variable.
void	setData(double[][] dataReal, double[][] dataImag) Sets the two argument double[][] arrays as the real and imaginary parts of the dependent variable.
void	setXorY(double[] xReal, double[] xImag, int dim) This variant of method setXorY sets the first two argument double[] arrays as the real and imaginary parts of the independent variable whose index is the third argument.
void	setXorY(java.lang.Object data, int dim) Sets the first argument Object as the independent variable for the index given by the second argument.
int[]	size() Returns an array containing the sizes or lengths of the two dimensions of the dependent data array.
boolean	testDataModel() Tests to make sure this Object obeys the MatrixType data model.

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, updateObsoletePointers

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

Constructor Detail

MatrixType

public MatrixType()

Creates a new empty MatrixType, but with the specific dimensions of this class

MatrixType

public MatrixType(double[][] z)

Creates a new real MatrixType with a uniformly sampled independent variables by using the 2D argument array z of doubles as the data and assuming that the independent variables are simply the indices of the data array, ie x runs from 0 to z.length - 1 in steps of 1 and y runs from 0 to z[0].length - 1 in steps of 1.

Parameters:

z - The two-dimensional matrix of data

MatrixType

public MatrixType(double[] x,
          double[] y,
          double[][] z)

Creates a new real MatrixType using the first argument array of doubles as the sampling values of the first independent variable (x), the second argument array as the samples of the second independent variable (y), and the third argument 2D array of doubles as the dependent variable real data.

Parameters:

x - The values of the first independent variable

y - The values of the second independent variable

z - The two-dimensional matrix of data

MatrixType

public MatrixType(Triplet xTr,
          Triplet yTr,
          double[][] z)

Creates a new real MatrixType with a uniformly sampled independent variable by using the first argument as the as the Triplet that determines how the first independent variable (x) is uniformly sampled, the second Triplet argument to determine how the second independent variable (y) is uniformly sampled, and the third argument as the dependent variable 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 Triplet giving the uniformly sampled values of the first independent variable

yTr - The Triplet giving the uniformly sampled values of the second independent variable

z - The two-dimensional matrix of data

See Also:

Triplet

MatrixType

public MatrixType(Triplet xTr,
          Triplet yTr,
          double[][] zr,
          double[][] zi)

Creates a new complex-valued MatrixType with real uniformly-sampled independent variables by using the first two (Triplet) arguments to determine how the independent variables are uniformly sampled, the third argument (double[][]) as the real part of the dependent variable data, and the fourth argument (double[][]) as the imaginary part. If either of the first two arguments is null, then the corresponding independent variable will be a Triplet constructed by default from the size of the input arrays.

Parameters:

xTr - The Triplet giving the uniformly sampled values of the first independent variable

yTr - The Triplet giving the uniformly sampled values of the second independent variable

zr - The two-dimensional matrix of real part of the data

zi - The two-dimensional matrix of imaginary part of the data

See Also:

Triplet

MatrixType

public MatrixType(double[] xr,
          double[] xi,
          double[] yr,
          double[] yi,
          double[][] zr,
          double[][] zi)

Creates a new complex-valued MatrixType with complex independent variables by using the first two argument arrays of doubles as the real part and imaginary part of the first independent variable (x), the third and fourth arguments as the real and imaginary parts of the second independent variable (y), and the fifth and sixth argument double[][] arrays as the real and imaginary parts of the dependent variable.

Method Detail

size

public int[] size()

Returns an array containing the sizes or lengths of the two dimensions of the dependent data array.

Returns:

int[] Lengths of the matrix columns and rows

length

public int[] length()

A synonym for size.

Returns:

int Lengths of the matrix columns and rows

getData

public double[][] getData()

Returns the (real part of the) data array for the dependent variable.

Returns:

double[][] The data array

getDataImag

public double[][] getDataImag()

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

Returns:

double[][] The imaginary part of the data array

getDataReal

public double[][] getDataReal()

A synonym for getData.

Returns:

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

setData

public void setData(double[][] data)

Sets the argument double[][] array as 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 xlen,
                      int ylen)

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

Parameters:

xlen - The size of the first dimension of the matrix

ylen - The size of the second dimension of the matrix

initialiseDataComplex

public void initialiseDataComplex(int xlen,
                         int ylen)

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

Parameters:

xlen - The size of the first dimension of the matrix

ylen - The size of the second dimension of the matrix

getXorYArray

public double[] getXorYArray(int dim)

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

Parameters:

dim - The index of the independent variable being examined

Returns:

double[] The values of the given independent variable

See Also:

Triplet

getXorYTriplet

public Triplet getXorYTriplet(int dim)

Method getXorYTriplet returns the Triplet that determines the values of the given independent variable. If the data is not uniformly sampled in this direction then it returns null.

Parameters:

dim - The index of the independent variable being examined

Returns:

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

See Also:

Triplet

getXorYImag

public double[] getXorYImag(int dim)

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

Parameters:

dim - The index of the independent variable being examined

Returns:

The imaginary part of the given independent variable

getXorYReal

public double[] getXorYReal(int dim)

A synonym for getXYArray.

Parameters:

dim - The index of the independent variable being examined

Returns:

The real part of the given independent variable

setXorY

public void setXorY(java.lang.Object data,
           int dim)

Sets the first argument Object as the independent variable for the index given by the second argument. (This Object must be either a Triplet or a double[].)

Parameters:

data - The new data, either a Triplet or a double[]

dim - The index of the independent variable being set

See Also:

Triplet

setXorY

public void setXorY(double[] xReal,
           double[] xImag,
           int dim)

This variant of method setXorY sets the first two argument double[] arrays as the real and imaginary parts of the independent variable whose index is the third argument.

Parameters:

xReal - The real part of the independent variable

xImag - The imaginary part of the independent variable

dim - The index of the independent variable being set

testDataModel

public boolean testDataModel()

Tests to make sure this Object obeys the MatrixType 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 MatrixType, this method only tests for compatibility with superior classes, and to see that the input object is a Histogram.

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