triana.types

Class MultipleSpectra

java.lang.Object

triana.types.TrianaType

triana.types.GraphType

triana.types.MultipleChannel

triana.types.MultipleSpectra

All Implemented Interfaces:

java.io.Serializable, Arithmetic, AsciiComm, SequenceInterface

public class MultipleSpectra
extends MultipleChannel
implements AsciiComm

MultipleSpectra stores many channels of frequency data.Each channel can have its own particular format of the data e.g. sampling frequency, number of points, whether the data is one or two sided, whether it is narrow etc

See Also:

ChannelFormat, SpectralChannelFormat, MultipleChannel, Serialized Form

Field Summary

Fields inherited from class triana.types.MultipleChannel

channelFormat

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
MultipleSpectra() Creates an empty MultipleSpectra Object with no channels added.
MultipleSpectra(int channels) Creates a MultipleSpectra object with a specific number of channels

Method Summary

Methods

Modifier and Type	Method and Description
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 MultipleSpectra.
SpectralChannelFormat	getSpectralChannelFormat(int channelNo)
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	setDefaultAxisLabelling() Added by I.

Methods inherited from class triana.types.MultipleChannel

copyMe, copyParameters, getChannel, getChannelFormat, getChannelFormatContainer, getChannelImag, getChannelLength, getChannelLengthImag, getChannels, inputFromStream, outputToStream, setChannel, setChannel, setChannel, setChannel, setChannel, setChannelImag, setChannelImag, setChannelImag, setChannelImag, setChannelImag, setDimensions

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

Methods inherited from interface triana.types.AsciiComm

inputFromStream, outputToStream

Constructor Detail

MultipleSpectra

public MultipleSpectra()

Creates an empty MultipleSpectra Object with no channels added.

MultipleSpectra

public MultipleSpectra(int channels)

Creates a MultipleSpectra object with a specific number of channels

Method Detail

setDefaultAxisLabelling

public void setDefaultAxisLabelling()

Added by I. Taylor, August 2001 : This function sets the default labeling scheme used for all GraphTypes. Default values are 'X' for the X-axis and 'Y' for the Y axis. The various subclasses can override this function with their specific axis-labelling conventions.

Overrides:

setDefaultAxisLabelling in class GraphType

getSpectralChannelFormat

public SpectralChannelFormat getSpectralChannelFormat(int channelNo)

Returns:

the format of the data at the requested channel.

createChannelFormatFrom

public 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

Specified by:

createChannelFormatFrom in class MultipleChannel

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.

Overrides:

isCompatible in class MultipleChannel

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 MultipleSpectra. They are equal if the argument is a MultipleSpectra 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.

Overrides:

equals in class MultipleChannel

Parameters:

obj - The object being tested

Returns:

true if they are equal or false otherwise