visad

Interface TupleIface

All Superinterfaces:

Data, Thing

All Known Subinterfaces:

RealTupleIface, RemoteClientTuple, RemoteNodeTuple, RemoteTupleIface

All Known Implementing Classes:

DoubleStringTuple, DoubleTuple, EarthLocationLite, EarthLocationTuple, JamaCholeskyDecomposition, JamaEigenvalueDecomposition, JamaLUDecomposition, JamaQRDecomposition, JamaSingularValueDecomposition, LatLonTuple, NamedLocationTuple, RealTuple, RemoteClientTupleImpl, RemoteNodeTupleImpl, Tuple, UTMCoordinate

public interface TupleIface
extends Data

TupleIface is the VisAD data interface for vectors.

Field Summary

Fields inherited from interface visad.Data

ABS, ACOS, ACOS_DEGREES, ADD, ASIN, ASIN_DEGREES, ATAN, ATAN_DEGREES, ATAN2, ATAN2_DEGREES, CEIL, COS, COS_DEGREES, DEGREES_TO_RADIANS, DEPENDENT, DIVIDE, EXP, FLOOR, INDEPENDENT, INV_ATAN2, INV_ATAN2_DEGREES, INV_DIVIDE, INV_POW, INV_REMAINDER, INV_SUBTRACT, LOG, MAX, MIN, MULTIPLY, NEAREST_NEIGHBOR, NEGATE, NO_ERRORS, NOP, POW, RADIANS_TO_DEGREES, REMAINDER, RINT, ROUND, SIN, SIN_DEGREES, SQRT, SUBTRACT, TAN, TAN_DEGREES, WEIGHTED_AVERAGE

Method Summary

Modifier and Type	Method and Description
Data	adjustSamplingError(Data error, int error_mode) return a Tuple that clones this, except its ErrorEstimate-s are adjusted for sampling errors in error
Data	binary(Data data, int op, MathType new_type, int sampling_mode, int error_mode) Pointwise binary operation between this and data.
DataShadow	computeRanges(ShadowType type, DataShadow shadow) Recursive version of computeRanges(), called down through Data object tree.
Data	getComponent(int i) return component for i between 0 and getDimension() - 1
int	getDimension() return number of components
Real[]	getRealComponents()
boolean	isMissing()
java.lang.String	longString(java.lang.String pre)
Data	unary(int op, MathType new_type, int sampling_mode, int error_mode) Pointwise unary operation applied to this.

Methods inherited from interface visad.Data

abs, abs, acos, acos, acosDegrees, acosDegrees, add, add, asin, asin, asinDegrees, asinDegrees, atan, atan, atan2, atan2, atan2Degrees, atan2Degrees, atanDegrees, atanDegrees, binary, ceil, ceil, changeMathType, computeRanges, computeRanges, cos, cos, cosDegrees, cosDegrees, dataClone, divide, divide, exp, exp, floor, floor, getType, local, log, log, longString, max, max, min, min, multiply, multiply, negate, negate, pow, pow, remainder, remainder, rint, rint, round, round, sin, sin, sinDegrees, sinDegrees, sqrt, sqrt, subtract, subtract, tan, tan, tanDegrees, tanDegrees, unary

Methods inherited from interface visad.Thing

addReference, removeReference

Method Detail

getRealComponents

Real[] getRealComponents()
                  throws VisADException,
                         java.rmi.RemoteException

Throws:

VisADException

java.rmi.RemoteException

getDimension

int getDimension()
          throws java.rmi.RemoteException

return number of components

Throws:

java.rmi.RemoteException

getComponent

Data getComponent(int i)
           throws VisADException,
                  java.rmi.RemoteException

return component for i between 0 and getDimension() - 1

Throws:

VisADException

java.rmi.RemoteException

isMissing

boolean isMissing()
           throws java.rmi.RemoteException

Specified by:

isMissing in interface Data

Returns:

flag indicating whether this Data has a missing value

Throws:

java.rmi.RemoteException - an RMI error occurred

binary

Data binary(Data data,
            int op,
            MathType new_type,
            int sampling_mode,
            int error_mode)
     throws VisADException,
            java.rmi.RemoteException

Description copied from interface: Data

Pointwise binary operation between this and data. Applies to Reals, Tuples (recursively to components), and to Field ranges (Field domains implicitly resampled if necessary). Does not apply to Field domains or Sets (regarded as domains of Fields wthout ranges). Data.ADD is only op defined for Text, interpreted as concatenate. MathTypes of this and data must match, or one may match the range of the other if it is a FunctionType.

Specified by:

binary in interface Data

Parameters:

data - other Data operand for binary operation

op - may be Data.ADD, Data.SUBTRACT, etc; these include all binary operations defined for Java primitive data types

new_type - MathType of the result

sampling_mode - may be Data.NEAREST_NEIGHBOR or Data.WEIGHTED_AVERAGE

error_mode - may be Data.INDEPENDENT, Data.DEPENDENT or Data.NO_ERRORS;

Returns:

result, with MathType = new_type

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

unary

Data unary(int op,
           MathType new_type,
           int sampling_mode,
           int error_mode)
    throws VisADException,
           java.rmi.RemoteException

Description copied from interface: Data

Pointwise unary operation applied to this. Applies to Reals, Tuples (recursively to components), and to Field ranges (Field domains implicitly resampled if necessary). Does not apply to Field domains, Sets (regarded as domains of Fields wthout ranges) or Text.

Specified by:

unary in interface Data

Parameters:

op - may be Data.ABS, Data.ACOS, etc; these include all unary operations defined for Java primitive data types

new_type - MathType of the result

sampling_mode - may be Data.NEAREST_NEIGHBOR or Data.WEIGHTED_AVERAGE

error_mode - may be Data.INDEPENDENT, Data.DEPENDENT or Data.NO_ERRORS;

Returns:

result, with MathType = new_type

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

computeRanges

DataShadow computeRanges(ShadowType type,
                         DataShadow shadow)
                  throws VisADException,
                         java.rmi.RemoteException

Description copied from interface: Data

Recursive version of computeRanges(), called down through Data object tree.

Specified by:

computeRanges in interface Data

Parameters:

type - ShadowType generated for MathType of this

shadow - DataShadow instance whose contained double[][] array and animation sampling Set are modified according to RealType values in this, and used as return value

Returns:

DataShadow instance containing double[][] array of RealType ranges, and an animation sampling Set

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

adjustSamplingError

Data adjustSamplingError(Data error,
                         int error_mode)
                  throws VisADException,
                         java.rmi.RemoteException

return a Tuple that clones this, except its ErrorEstimate-s are adjusted for sampling errors in error

Specified by:

adjustSamplingError in interface Data

error_mode - may be Data.INDEPENDENT, Data.DEPENDENT or Data.NO_ERRORS;

Returns:

clone of this, except with ErrorEstimates set according to values in error

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

longString

java.lang.String longString(java.lang.String pre)
                     throws VisADException,
                            java.rmi.RemoteException

Specified by:

longString in interface Data

Parameters:

pre - String added to start of each line

Returns:

a longer String than returned by toString(), indented by pre (a string of blanks)

Throws:

VisADException

java.rmi.RemoteException