triana.types

Class Histogram

java.lang.Object

triana.types.TrianaType

triana.types.GraphType

triana.types.VectorType

triana.types.Histogram

All Implemented Interfaces:

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

public class Histogram
extends VectorType
implements Histogramming, AsciiComm

Histogram is a data type that represents numerical values (the dependent variable) that are assigned to intervals of a single independent variable, rather than being assigned to values of the independent variable, as in the case of functions. It is typically used to count the number of times the value of a variable falls within a certain interval (frequency histogram). Histogram is a sub-class of VectorType that implements the Histogramming interface.

The dependent variable of Histogram is the histogrammed data. The independent variable is the set of delimiters of the intervals to which the dependent values relate. The convention is that the dependent data value whose index is j is defined on the interval between the independent data values (delimiters) with indices j and j + 1. The delimiters must be monotonically increasing but they can define intervals of variable length. /p>

The GraphType data model requires that the number of points in the independent and dependent variable should be the same. For a histogram, however, the highest delimiter (the upper end of the last interval) must have an index value one larger than the last index of the dependent data. To solve this problem, Histogram adopts the convention that the independent variable stores all the delimiters except the last one. This is stored in the parameter lastDelimiter.

Some histograms may be binned in such a way that the first or the last interval might be infinite; this happens for example if the data point represents the number of times a variable exceeds a certain value x (last interval stretches from x to infinity). In such cases Histogram stores the value Double.NEGATIVE_INFINITY in the first delimiter, and/or the value Double.POSITIVE_INFINITY in the parameter lastDelimiter, as appropriate. Histogram implements tests to determine if these infinite values are present, and it implements a method to return finite values for such delimiters, in order to aid graphing the data.

See Also:

VectorType, Histogramming, GraphType, Triplet, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	binLabel (Parameter that is kept for consistency with previous versions, but which is obsolete.
double[]	data (Parameter that is kept for consistency with previous versions, but which is obsolete.
double[]	delimiters (Parameter that is kept for consistency with previous versions, but which is obsolete.
java.lang.String	hLabel (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
Histogram() Creates a new Histogram, setting its state to false
Histogram(double[] delims, double[] values) Creates a Histogram with given delimiter array and value array.
Histogram(double[] delims, double[] values, double last) Creates a Histogram with given delimiter array, value array, and an explicitly given last delimiter.
Histogram(int nB, int nH, java.lang.String labelB, java.lang.String labelH) (Obsolete constructor kept for compatibility with previous version of Histogram.
Histogram(java.lang.String labelB, java.lang.String labelH, double[] bs, double[] hv) (Obsolete constructor kept for compatibility with previous version.

Method Summary

Methods

Modifier and Type	Method and Description
int	bsize() (Obsolete method required for compatibility with previous versions.)
protected void	copyData(TrianaType source) Copies the data held in this object, by value not reference.
TrianaType	copyMe() This is one of the most important methods of Triana data.
protected void	copyParameters(TrianaType source) Copies parameters from the source to the current object.
boolean	equals(TrianaType obj) Determines whether the argument TrianaType is equal to the current Histogram.
void	extendWithZeros(int newLength, boolean front) Extends the histogram data (dependent data) to a longer set by padding with zeros.
double[]	getDelimiterArray(int dim) Returns the whole set of delimiters (including the last one) for the intervals of the histogram in the given dimension (independent variable).
double[]	getDelimiterMidpoints(int dim) Returns x-axis values for graphing a histogram with a standard grapher that expects the same number of x-values as y-values.
double[]	getDelimiterMidpointsLog10(int dim) Returns logarithmic x-axis values for graphing a histogram with a standard grapher that expects the same number of x-values as y-values.
Triplet	getDelimiterTriplet(int dim) Returns a Triplet that describes the set of delimiters in the given dimension.
double[]	getFiniteDelimiters(int dim) Returns an entire set of delimiters in finite positions for the intervals of the histogram in the given dimension (independent variable).
double	getFirstDelimiter() Return value of the first delimiter (the left-most delimiter).
double[]	getIndependentScaleImag(int dim) Returns null because the data is real.
double[]	getIndependentScaleReal(int dim) Returns the independent data scaled the way they should be graphed.
double	getLastDelimiter() Return value of lastDelimiter (the right-most delimiter).
int	hsize() (Obsolete method required for compatibility with previous versions.)
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) Overrides the method of VectorType, which inserts zeros between existing elements of the data set, to do nothing at all in Histogram.
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	isUnboundedIntervalAbove(int dim) Returns true if the last interval in the given dimension is unbounded above, i.e.
boolean	isUnboundedIntervalBelow(int dim) Returns true if the first interval in the given dimension is unbounded below, i.e.
boolean	isUniformDelimiterSet(int dim) Returns true if the set of delimiters in the given dimension is uniform, false otherwise.
void	outputToStream(java.io.PrintWriter dos) Used when Triana types want to be able to send ASCII data to other programs using strings.
void	resetHData(double[] hdata) (Obsolete method required for compatibility with previous versions.)
void	setDefaultAxisLabelling() Added by I.
void	setDelimiters(double[] delims, int dim) Sets the independent variable data array and the parameter lastDelimiter from the data held in the given array.
void	setDelimiters(Triplet del, int dim) Sets the delimiters associated with the given dimension to values given by the given Triplet.
void	setHistogramBinLabel(java.lang.String labelB) (Obsolete method required for compatibility with previous versions.)
void	setHistogramDataLabel(java.lang.String labelH) (Obsolete method required for compatibility with previous versions.)
void	setLastDelimiter(double ld) Set value of lastDelimiter (the right-most delimiter) to the given value.
protected void	updateObsoletePointers()

Methods inherited from class triana.types.VectorType

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

binLabel

public java.lang.String binLabel

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

The bin-axis (independent variable) label. Must be kept up-to-date with GraphType.independentLabels.

hLabel

public java.lang.String hLabel

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

The h-axis (dependent variable) label. Must be kept up-to-date with GraphType.dependentLabels.

delimiters

public double[] delimiters

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

The interval delimiter data. It is not identical with the GraphType independent variable, since this array contains the last delimiter, which is stored as the parameter lastDelimiter.

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 constructors and set... methods.)

The histogram data. Must be kept up-to-date with the dependent variable.

Constructor Detail

Histogram

public Histogram()

Creates a new Histogram, setting its state to false

Histogram

public Histogram(double[] delims,
         double[] values)

Creates a Histogram with given delimiter array and value array. The given delimiter array (first argument) should have one more element than the values array (second argument), and should contain all the delimiters. If one wants to specify the independent variable array for the delimiters, use the next constructor.

Parameters:

delims - An array containing all the delimiters, including the last

values - The array of histogram data

Histogram

public Histogram(double[] delims,
         double[] values,
         double last)

Creates a Histogram with given delimiter array, value array, and an explicitly given last delimiter. The given delimiter array (first argument) should have the same length as the values array (second argument), and should contain all the delimiters except the last. The final argument gives the last delimiter. If one wants to specify all the delimiters in one array, use the previous constructor.

Parameters:

delims - An array containing all the delimiters, including the last

values - The array of histogram data

last - The last (greatest) delimiter

Histogram

public Histogram(int nB,
         int nH,
         java.lang.String labelB,
         java.lang.String labelH)

(Obsolete constructor kept for compatibility with previous version of Histogram. Will be removed in subsequent versions.)

Creates a new Histogram of a given size, with given labels for the intervals and histogram values. It allocates storage for the data vectors, but only assigns values to possible infinite end delimiters. This follows the obsolete algorithm of the earlier version. First, if the number of delimiters nB is one less than the number of histogram values nH, the first interval is assumed to start at negative infinity and the final one to end at positive infinity. Second, if nB equals nH, then only the final interval is assumed infinite. If nB is one larger than nH then all intervals are of finite size. If nB and nH do not satisfy one of these conditions, then an empty Histogram is created.

Parameters:

nB - the number of bin delimiter values.

nH - the number of histogram values.

labelB - the label for the bin values.

labelH - the label for the histogram values.

Histogram

public Histogram(java.lang.String labelB,
         java.lang.String labelH,
         double[] bs,
         double[] hv)

(Obsolete constructor kept for compatibility with previous version. It will be removed in later versions.)

Creates a new Histogram for given values of the histogram and bin labels, with references to data for the bin delimiters and the histogram values, and with a description.

Normally the given delimiter array bs should have length one greater than that of the given histogram array hv. For compatibility with previous versions, however, bs is also allowed to have length equal to or one less than that of hv. The algorithm for constructing the delimiter set is given in the previous constructor.

Parameters:

labelB - the bin label.

labelH - the histogram axis label.

bs - the bin-delimiter data in an array of doubles

hv - the histogram data in an array of doubles

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

getLastDelimiter

public double getLastDelimiter()

Return value of lastDelimiter (the right-most delimiter).

Returns:

double the last delimiter

setLastDelimiter

public void setLastDelimiter(double ld)

Set value of lastDelimiter (the right-most delimiter) to the given value.

getFirstDelimiter

public double getFirstDelimiter()

Return value of the first delimiter (the left-most delimiter).

Returns:

double The first delimiter

getDelimiterArray

public double[] getDelimiterArray(int dim)

Returns the whole set of delimiters (including the last one) for the intervals of the histogram in the given dimension (independent variable). Since there is only one dimension in this case, the given value of dim is ignored.

Specified by:

getDelimiterArray in interface Histogramming

Parameters:

dim - The index of the independent variable being queried, ignored here

Returns:

The array of interval delimiters

getFiniteDelimiters

public double[] getFiniteDelimiters(int dim)

Returns an entire set of delimiters in finite positions for the intervals of the histogram in the given dimension (independent variable). If the first and/or last delimiter is infinite, it is replaced by a finite value chosen in such a way that the final (or first) interval has the same width as the one adjacent to it. This is useful for graphing purposes, where the infinite interval must be displayed in a finite way. Since there is only one dimension in this case, the given value of dim is ignored.

Parameters:

dim - The index of the independent variable being queried, ignored here

Returns:

The array of interval delimiters as finite numbers

getDelimiterTriplet

public Triplet getDelimiterTriplet(int dim)

Returns a Triplet that describes the set of delimiters in the given dimension. A Triplet can only describe a uniformly spaced set of numbers, so if the interval delimiters are not uniform this returns null. Since there is only one dimension in this case, the given value of dim is ignored.

Specified by:

getDelimiterTriplet in interface Histogramming

Parameters:

dim - The index of the independent variable being queried, ignored here

Returns:

The Triplet that can generate the interval delimiters

See Also:

Triplet

isUniformDelimiterSet

public boolean isUniformDelimiterSet(int dim)

Returns true if the set of delimiters in the given dimension is uniform, false otherwise. This excludes the possibility that either the lowest or the highest is infinite. Since there is only one dimension in this case, the given value of dim is ignored.

Specified by:

isUniformDelimiterSet in interface Histogramming

Parameters:

dim - The index of the independent variable being queried, ignored here

Returns:

True if the delimiters are uniformly spaced

setDelimiters

public void setDelimiters(double[] delims,
                 int dim)

Sets the independent variable data array and the parameter lastDelimiter from the data held in the given array. If the delimiters are uniformly spaced (apart possibly from the last) then they will be stored as a Triplet and not an array. The method sets the parameter delimiters to the correct reference. This method should be used to set delimiters; VectorType.setX will not work properly because it does not know about the delimiter model for histograms, in particular the extra last delimiter.

Specified by:

setDelimiters in interface Histogramming

Parameters:

delims - An array containing all the delimiters

dim - The index of the independent variable being queried, ignored here

See Also:

Triplet

setDelimiters

public void setDelimiters(Triplet del,
                 int dim)

Sets the delimiters associated with the given dimension to values given by the given Triplet. The user is expected to check that the length of this array is correct (i.e. one more than the length of the dependent data array). The highest value of the Triplet is stored in lastDelimiter, and the remaining values are kept as a new Triplet with a shorter length.

Specified by:

setDelimiters in interface Histogramming

Parameters:

del - The Triplet that generates the array of delimiters

dim - The index of the independent variable being queried, ignored in this case

See Also:

Triplet

isUnboundedIntervalBelow

public boolean isUnboundedIntervalBelow(int dim)

Returns true if the first interval in the given dimension is unbounded below, i.e. if the first delimiter is Double.NEGATIVE_INFINITY, and false otherwise.

Specified by:

isUnboundedIntervalBelow in interface Histogramming

Parameters:

dim - The index of the independent variable being queried

Returns:

True if the lowest interval reaches to negative infinity

isUnboundedIntervalAbove

public boolean isUnboundedIntervalAbove(int dim)

Returns true if the last interval in the given dimension is unbounded above, i.e. if the first delimiter is Double.POSITIVE_INFINITY, and false otherwise.

Specified by:

isUnboundedIntervalAbove in interface Histogramming

Parameters:

dim - The index of the independent variable being queried

Returns:

True if the highest interval reaches to positive infinity

hsize

public int hsize()

(Obsolete method required for compatibility with previous versions.)

This is identical to size() but provides a name that makes it clear that the number being returned is the number of histogram values, which is one less than the number of bin delimiters.

Returns:

the number of histogram values in this Histogram type.

bsize

public int bsize()

(Obsolete method required for compatibility with previous versions.)

Returns the number of non-infinite bin delimiters.

Returns:

the number of bin delimiters in this Histogram type.

resetHData

public void resetHData(double[] hdata)

(Obsolete method required for compatibility with previous versions.)

Resets the independent variable array to the array whose reference is passed to it. This is identical to setData.

Parameters:

hdata - the new histogram data

setHistogramBinLabel

public void setHistogramBinLabel(java.lang.String labelB)

(Obsolete method required for compatibility with previous versions.)

Sets the graph label for the histogram intervals.

Parameters:

labelB - The histogram bin axis label

setHistogramDataLabel

public void setHistogramDataLabel(java.lang.String labelH)

(Obsolete method required for compatibility with previous versions.)

Sets the graph label for the histogram values.

Parameters:

labelH - The histogram value axis label

getIndependentScaleReal

public double[] getIndependentScaleReal(int dim)

Returns the independent data scaled the way they should be graphed. For Histogram, this returns an array of delimiters, one longer than the array of dependent data. This method simply returns the value of getFiniteDelimiters, which return finite values for the delimiters even if the histogram is formed with end intervals that are infinite in length. The user should use other methods to check if the true delimiters are infinite.

Overrides:

getIndependentScaleReal in class GraphType

Parameters:

dim - The independent dimension under consideration

Returns:

The scaled independent data values

See Also:

getFiniteDelimiters(int)

getIndependentScaleImag

public double[] getIndependentScaleImag(int dim)

Returns null because the data is real.

Overrides:

getIndependentScaleImag in class GraphType

Parameters:

dim - The independent dimension under consideration

Returns:

The scaled independent data values

getDelimiterMidpoints

public double[] getDelimiterMidpoints(int dim)

Returns x-axis values for graphing a histogram with a standard grapher that expects the same number of x-values as y-values. The x-values returned are the midpoints of the histogram intervals, after making them finite if one or both ends extend to infinity.

Parameters:

dim - The independent dimension under consideration

Returns:

The array of independent data

getDelimiterMidpointsLog10

public double[] getDelimiterMidpointsLog10(int dim)

Returns logarithmic x-axis values for graphing a histogram with a standard grapher that expects the same number of x-values as y-values. The x-values returned are the midpoints of the histogram intervals, after making them finite if one or both ends extend to infinity.

Parameters:

dim - The independent dimension under consideration

Returns:

The array of independent data

extendWithZeros

public void extendWithZeros(int newLength,
                   boolean front)

Extends the histogram data (dependent data) 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.

For a Histogram, the extra zeros must be accompanied by an equal number of extra delimiters. If the zeros are to be added at the beginning, then the first delimiter must be finite; if it is NEGATIVE_INFINITY then the method returns without doing anything and prints a warning. Otherwise, it simply uses the extension method of VectorType. If the zeros are to be added at the end, then the last delimiter must be finite; if it is POSITIVE_INFINITY then the method returns without doing anything and prints a warning. Otherwise, it must move the last delimiter's position. It does this by artificially defining a scratch VectorType data type to hold a set of one greater size that can be interpolated in the usual way, and then makes end adjustments.

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

Overrides:

extendWithZeros in class VectorType

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)

Overrides the method of VectorType, which inserts zeros between existing elements of the data set, to do nothing at all in Histogram. The operation does not make sense in terms of the definition of the Histogram.

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

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 Histogram, this method first tests for compatibility with superior classes, and then (if the input object is a Histogram) tests that the input has the same delimiters 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 Histogram. They are equal if the argument is a Histogram 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

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

copyData

protected void copyData(TrianaType source)

Copies the data held in this object, by value not reference. It over-rides the same method of GraphType, invoking that method and then tidying up references to obsolete paramters. If these are elimited in future versions, then this method can be eliminated.

Overrides:

copyData in class GraphType

Parameters:

source - The data object being copied

copyParameters

protected void copyParameters(TrianaType source)

Copies parameters from the source to the current object. Many of the statements keep the obsolete parameters up-to-date, so they can be eliminated when these parameters are eliminated in future versions.

Overrides:

copyParameters in class GraphType

Parameters:

source - The object from which the copy is made

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

updateObsoletePointers

protected void updateObsoletePointers()

Overrides:

updateObsoletePointers in class VectorType