triana.types

Class MultipleChannel

java.lang.Object

triana.types.TrianaType

triana.types.GraphType

triana.types.MultipleChannel

All Implemented Interfaces:

java.io.Serializable, Arithmetic, AsciiComm, SequenceInterface

Direct Known Subclasses:

MultipleAudio, MultipleSpectra

public abstract class MultipleChannel
extends GraphType
implements AsciiComm

MultipleChannel is a base class for representing multiple channeled data. Each channel. Each channel can have its own particular format by object that implement the ChannelFormat interface. Furthermore, each channel can contain complex data so that, for example, this type could be used to store multiple channels of complex spectra.

The 2 subclasses which use this class are MultipleAudio and MultipleSpectra. MultipleAudio is a type to store multiple channels of time-series data. This could be used to store stereo music or multiple channels from a recording device. MultipleSpectra is used to contain multiple channels of frequency domain data.

See Also:

GraphType, ChannelFormat, MultipleAudio, MultipleSpectra, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector	channelFormat Used to store the audio format for each channel (for data or real data)

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
MultipleChannel() Creates an empty non-complex MultipleChannel Object.
MultipleChannel(int channels) Creates a MultipleChannel object with a specific number of channels

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.
abstract ChannelFormat	createChannelFormatFrom(java.lang.String line) This function creates a ChannelFormat object from the given String using the toString and setFromString() functions with a ChannelFormat
boolean	equals(TrianaType obj) Determines whether the argument TrianaType is equal to the current MultipleChannel.
java.lang.Object	getChannel(int channelNo)
ChannelFormat	getChannelFormat(int channelNo)
java.util.Vector	getChannelFormatContainer()
java.lang.Object	getChannelImag(int channelNo)
int	getChannelLength(int channelNo)
int	getChannelLengthImag(int channelNo)
int	getChannels()
void	inputFromStream(java.io.BufferedReader dis) Used when Triana types want to be able to receive ASCII data from the output of other programs.
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.
void	setChannel(int channelNo, byte[] data, ChannelFormat format) Inserts a channel whose data contains bytes into this MultipleChannel object at the particular position
void	setChannel(int channelNo, double[] data, ChannelFormat format) Inserts a channel whose data contains doubles into this MultipleChannel object at the particular position
void	setChannel(int channelNo, int[] data, ChannelFormat format) Inserts a channel whose data contains ints into this MultipleChannel object at the particular position
void	setChannel(int channelNo, java.lang.Object data, ChannelFormat format) Inserts a channel into this MultipleChannel Type at the particular position
void	setChannel(int channelNo, short[] data, ChannelFormat format) Inserts a channel whose data contains shorts into this MultipleChannel object at the particular position
void	setChannelImag(int channelNo, byte[] data) Inserts the imaginary part of the given channel whose data contains bytes into this MultipleChannel object at the particular position
void	setChannelImag(int channelNo, double[] data) Inserts the imaginary part of the given channel whose data contains doubles into this MultipleChannel object at the particular position
void	setChannelImag(int channelNo, int[] data) Inserts the imaginary part of the given channel whose data contains ints into this MultipleChannel object at the particular position
void	setChannelImag(int channelNo, java.lang.Object data) Inserts a imaginary part of the given channel into this MultipleChannel Type at the particular position.
void	setChannelImag(int channelNo, short[] data) Inserts the imaginary part of the given channel whose data contains shorts into this MultipleChannel object at the particular position
void	setDimensions(int indChans, int channels) Sets the number of data channels.

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, setDefaultAxisLabelling, setDependentLabels, setDependentVariableDimensions, setDimensionLengths, setDimensionLengths, setIndependentArrayImag, setIndependentArrayReal, setIndependentLabels, setIndependentTriplet, setIndependentTriplet, setLabels, setTitle, subtract, testDataModel

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

Field Detail

channelFormat

protected java.util.Vector channelFormat

Used to store the audio format for each channel (for data or real data)

Constructor Detail

MultipleChannel

public MultipleChannel()

Creates an empty non-complex MultipleChannel Object.

MultipleChannel

public MultipleChannel(int channels)

Creates a MultipleChannel object with a specific number of channels

Method Detail

setDimensions

public void setDimensions(int indChans,
                 int channels)

Sets the number of data channels.

Overrides:

setDimensions in class GraphType

Parameters:

indChans - The number of independent variables (must be positive)

channels - The number of dependent variables (must be positive)

setChannel

public void setChannel(int channelNo,
              java.lang.Object data,
              ChannelFormat format)

Inserts a channel into this MultipleChannel Type at the particular position

setChannelImag

public void setChannelImag(int channelNo,
                  java.lang.Object data)

Inserts a imaginary part of the given channel into this MultipleChannel Type at the particular position. The format for this channel is specified by the format given by the real component.

setChannel

public void setChannel(int channelNo,
              short[] data,
              ChannelFormat format)

Inserts a channel whose data contains shorts into this MultipleChannel object at the particular position

setChannel

public void setChannel(int channelNo,
              byte[] data,
              ChannelFormat format)

Inserts a channel whose data contains bytes into this MultipleChannel object at the particular position

setChannel

public void setChannel(int channelNo,
              int[] data,
              ChannelFormat format)

Inserts a channel whose data contains ints into this MultipleChannel object at the particular position

setChannel

public void setChannel(int channelNo,
              double[] data,
              ChannelFormat format)

Inserts a channel whose data contains doubles into this MultipleChannel object at the particular position

setChannelImag

public void setChannelImag(int channelNo,
                  short[] data)

Inserts the imaginary part of the given channel whose data contains shorts into this MultipleChannel object at the particular position

setChannelImag

public void setChannelImag(int channelNo,
                  byte[] data)

Inserts the imaginary part of the given channel whose data contains bytes into this MultipleChannel object at the particular position

setChannelImag

public void setChannelImag(int channelNo,
                  int[] data)

Inserts the imaginary part of the given channel whose data contains ints into this MultipleChannel object at the particular position

setChannelImag

public void setChannelImag(int channelNo,
                  double[] data)

Inserts the imaginary part of the given channel whose data contains doubles into this MultipleChannel object at the particular position

getChannel

public java.lang.Object getChannel(int channelNo)

Returns:

the data at the requested channel. This could be any type of java object array i.e. short[], int[], byte[], double[] etc

getChannelImag

public java.lang.Object getChannelImag(int channelNo)

Returns:

the imaginary data at the requested channel. This could be any type of java object array i.e. short[], int[], byte[], double[] etc

getChannelLength

public int getChannelLength(int channelNo)

Returns:

the number of samples contained within the given channel

getChannelLengthImag

public int getChannelLengthImag(int channelNo)

Returns:

the number of samples contained within the given imaginary component of the given channel

getChannelFormat

public ChannelFormat getChannelFormat(int channelNo)

Returns:

the format of the data at the requested channel.

getChannelFormatContainer

public java.util.Vector getChannelFormatContainer()

getChannels

public int getChannels()

copyMe

public TrianaType copyMe()

Description copied from class: GraphType

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

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

createChannelFormatFrom

public abstract ChannelFormat createChannelFormatFrom(java.lang.String line)

This function creates a ChannelFormat object from the given String using the toString and setFromString() functions with a ChannelFormat

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 Mutiple Audio, this method first tests for compatibility with superior classes, and then (if the input object is a Mutiple Audio) tests that the input has the same channel count.

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

equals

public boolean equals(TrianaType obj)

Determines whether the argument TrianaType is equal to the current MultipleChannel. They are equal if the argument is a MultipleChannel 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