triana.types

Interface Histogramming

All Known Implementing Classes:

Histogram

public interface Histogramming

Histogramming is an interface that can be implemented by any Triana data types that include data that represent a histogram. The key point is that histograms differ from other functions in that the histogram data is related to $intervals^ of the independent variable(s), rather than to single values of these variables. This means that the independent data for a histogram must define the intervals, and this is done by storing $delimiters^ as independent data.

Delimiters are the boundaries of the intervals that histogram values refer to. The intervals are assumed to be contiguous, so that a given delimiter is the right-hand boundary of one interval and the left-hand boundary of the next higher interval. Only the lowest and highest delimiters are boundaries of only one interval. Delimiter values are assumed to be monotonically increasing.

In each dimension there is one more delimiter value than the number of intervals, so the number of independent data values is one larger than the length of the corresponding dimension of the dependent data array (histogram values). The Histogramming interface provides methods to set and access the extra independent data. It allows for the possibility that the lowest or highest interval may be unbounded, so that the first delimiter could have the value $Double.NEGATIVE_INFINITY^ or the last could be $Double.POSITIVE_INFINITY^.

The Histogramming interface does not specify how a type should implement the storage of this data. This is up to the programmer. In the TrianaType called Histogram, which implements the Histogramming interface for one-dimensional histograms, the extra delimiter value is stored as a parameter.

See Also:

Histogram, GraphType, Signal, Spectral

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getDelimiterArray(int dim) Returns the whole set of delimiters for the intervals of the histogram in the given dimension (independent variable).
Triplet	getDelimiterTriplet(int dim) Returns a Triplet that describes the set of delimiters in the given dimension.
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.^ if the first delimiter is $Double.NEGATIVE_INFINITY^, and $false^ otherwise.
boolean	isUniformDelimiterSet(int dim) Returns $true^ if the set of delimiters in the given dimension is uniform, $false^ otherwise.
void	setDelimiters(double[] del, int dim) Sets the delimiters associated with the given dimension to the given double[] array.
void	setDelimiters(Triplet del, int dim) Sets the delimiters associated with the given dimension to the given Triplet.

Method Detail

getDelimiterArray

double[] getDelimiterArray(int dim)

Returns the whole set of delimiters for the intervals of the histogram in the given dimension (independent variable). If the lowest interval is unbounded below, then the first delimiter (first element of the array returned by this method) should be $Double.NEGATIVE_INFINITY^, and if the highest interval is unbounded above then the last element should be $Double.POSITIVE_INFINITY^.

Parameters:

dim - The index of the independent variable being queried

Returns:

The array of interval delimiters

getDelimiterTriplet

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 or if at least one end delimiter is infinite, then this method should return null.

Parameters:

dim - The index of the independent variable being queried

Returns:

The Triplet that can generate the interval delimiters

isUniformDelimiterSet

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.

Parameters:

dim - The index of the independent variable being queried

Returns:

True if the delimiters are uniformly spaced

setDelimiters

void setDelimiters(double[] del,
                 int dim)

Sets the delimiters associated with the given dimension to the given double[] array. The array's first and last elements can be $Double.NEGATIVE_INFINITY^ or $Double.POSITIVE_INFINITY^, respectively. The user is expected to check that the length of this array is correct.

Parameters:

del - The array of delimiters

dim - The index of the independent variable being queried

setDelimiters

void setDelimiters(Triplet del,
                 int dim)

Sets the delimiters associated with the given dimension to the given Triplet. The user is expected to check that the length of this array is correct. This method can only be used if there are no infinite end delimiters.

Parameters:

del - The array of delimiters

dim - The index of the independent variable being queried

isUnboundedIntervalBelow

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.

Parameters:

dim - The index of the independent variable being queried

Returns:

True if the lowest interval reaches to negative infinity

isUnboundedIntervalAbove

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.

Parameters:

dim - The index of the independent variable being queried

Returns:

True if the highest interval reaches to positive infinity