visad

Interface Field

All Superinterfaces:

Data, Function, Thing

All Known Subinterfaces:

FlatFieldIface, ImageSequence, NavigatedField, RemoteClientField, RemoteClientPartitionedField, RemoteField, RemoteFlatField, RemoteNodeField, RemoteNodePartitionedField, SingleBandedImage

All Known Implementing Classes:

AreaImageCacheAdapter, CachedFlatField, FieldImpl, FileField, FileFlatField, FlatField, ImageFlatField, ImageSequenceImpl, JamaMatrix, NavigatedImage, RemoteClientFieldImpl, RemoteClientPartitionedFieldImpl, RemoteFieldImpl, RemoteFlatFieldImpl, RemoteNodeFieldImpl, RemoteNodePartitionedFieldImpl, SatelliteImage, SingleBandedImageImpl, Sounding, Spectrum

public interface Field
extends Function

Field is the VisAD interface for finite samplings of functions from R^n to a range type, where n>0.

A Field domain type may be either a RealType (for a function with domain = R) or a RealTupleType (for a function with domain = R^n for n > 0).

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
java.util.Enumeration	domainEnumeration() Here's how to use this: for (Enumeration e = field.domainEnumeration() ; e.hasMoreElements(); ) { RealTuple domain_sample = (RealTuple) e.nextElement(); Data range = field.evaluate(domain_sample); }
Field	domainFactor(RealType factor) factor Field domain into domains of two nested Fields
Field	domainMultiply() combine domains of two outermost nested Fields into a single domain and Field
Field	domainMultiply(int depth) combine domains to depth, if possible
Field	extract(int component) assumes the range type of this is a Tuple and returns a Field with the same domain as this, but whose range samples consist of the specified Tuple component of the range samples of this; in shorthand, this[].component
Unit[]	getDefaultRangeUnits() get default range Unit-s for 'Flat' components
Set	getDomainSet() get the domain Set
float[][]	getFloats() invokes getFloats(true)
float[][]	getFloats(boolean copy) get the 'Flat' components of this Field's range values in their default range Units (as defined by the range of the Field's FunctionType); if the range type is a RealType it is a 'Flat' component, if the range type is a TupleType its RealType components and RealType components of its RealTupleType components are all 'Flat' components; the return array is dimensioned: float[number_of_flat_components][number_of_range_samples]; return a copy if copy == true
int	getLength() get number of samples
CoordinateSystem[]	getRangeCoordinateSystem() get range CoordinateSystem for 'RealTuple' range; index may enumerate samples, if they differ
CoordinateSystem[]	getRangeCoordinateSystem(int component) get range CoordinateSystem for 'RealTuple' components; index may enumerate samples, if they differ
Unit[][]	getRangeUnits() get range Unit-s for 'Flat' components; second index may enumerate samples, if they differ
Data	getSample(int index) get the range value at the index-th sample
java.lang.String[][]	getStringValues() get String values for Text components
double[][]	getValues() invokes getValues(true)
double[][]	getValues(boolean copy) get the 'Flat' components of this Field's range values in their default range Units (as defined by the range of the Field's FunctionType); if the range type is a RealType it is a 'Flat' component, if the range type is a TupleType its RealType components and RealType components of its RealTupleType components are all 'Flat' components; the return array is dimensioned: double[number_of_flat_components][number_of_range_samples]; return a copy if copy == true
boolean	isFlatField() return true if this a FlatField or a RemoteField adapting a FlatField
void	setSample(int index, Data range) set the range value at the index-th sample
void	setSample(int index, Data range, boolean copy) set the range value at the index-th sample
void	setSample(RealTuple domain, Data range) set the range value at the sample nearest to domain
void	setSample(RealTuple domain, Data range, boolean copy) set the range value at the sample nearest to domain
void	setSamples(Data[] range, boolean copy) set the range samples of the function; the order of range samples must be the same as the order of domain indices in the DomainSet; copy range objects if copy is true; should use same MathType object in each Data object in range array
void	setSamples(double[][] range) set range array as range values of this Field; this must have a Flat range; the array is dimensioned float[number_of_range_components][number_of_range_samples]; the order of range values must be the same as the order of domain indices in the DomainSet
void	setSamples(float[][] range) set range array as range values of this Field; this must have a Flat range; the array is dimensioned float[number_of_range_components][number_of_range_samples]; the order of range values must be the same as the order of domain indices in the DomainSet

Methods inherited from interface visad.Function

derivative, derivative, derivative, derivative, derivative, evaluate, evaluate, evaluate, evaluate, getDomainCoordinateSystem, getDomainDimension, getDomainUnits, resample, resample

Methods inherited from interface visad.Data

abs, abs, acos, acos, acosDegrees, acosDegrees, add, add, adjustSamplingError, asin, asin, asinDegrees, asinDegrees, atan, atan, atan2, atan2, atan2Degrees, atan2Degrees, atanDegrees, atanDegrees, binary, binary, ceil, ceil, changeMathType, computeRanges, computeRanges, computeRanges, cos, cos, cosDegrees, cosDegrees, dataClone, divide, divide, exp, exp, floor, floor, getType, isMissing, local, log, log, longString, 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, unary

Methods inherited from interface visad.Thing

addReference, removeReference

Method Detail

setSamples

void setSamples(Data[] range,
                boolean copy)
         throws VisADException,
                java.rmi.RemoteException

set the range samples of the function; the order of range samples must be the same as the order of domain indices in the DomainSet; copy range objects if copy is true; should use same MathType object in each Data object in range array

Throws:

VisADException

java.rmi.RemoteException

setSamples

void setSamples(double[][] range)
         throws VisADException,
                java.rmi.RemoteException

set range array as range values of this Field; this must have a Flat range; the array is dimensioned float[number_of_range_components][number_of_range_samples]; the order of range values must be the same as the order of domain indices in the DomainSet

Throws:

VisADException

java.rmi.RemoteException

setSamples

void setSamples(float[][] range)
         throws VisADException,
                java.rmi.RemoteException

set range array as range values of this Field; this must have a Flat range; the array is dimensioned float[number_of_range_components][number_of_range_samples]; the order of range values must be the same as the order of domain indices in the DomainSet

Throws:

VisADException

java.rmi.RemoteException

getDomainSet

Set getDomainSet()
          throws VisADException,
                 java.rmi.RemoteException

get the domain Set

Throws:

VisADException

java.rmi.RemoteException

getLength

int getLength()
       throws VisADException,
              java.rmi.RemoteException

get number of samples

Throws:

VisADException

java.rmi.RemoteException

getSample

Data getSample(int index)
        throws VisADException,
               java.rmi.RemoteException

get the range value at the index-th sample

Throws:

VisADException

java.rmi.RemoteException

setSample

void setSample(RealTuple domain,
               Data range)
        throws VisADException,
               java.rmi.RemoteException

set the range value at the sample nearest to domain

Throws:

VisADException

java.rmi.RemoteException

setSample

void setSample(RealTuple domain,
               Data range,
               boolean copy)
        throws VisADException,
               java.rmi.RemoteException

set the range value at the sample nearest to domain

Throws:

VisADException

java.rmi.RemoteException

setSample

void setSample(int index,
               Data range)
        throws VisADException,
               java.rmi.RemoteException

set the range value at the index-th sample

Throws:

VisADException

java.rmi.RemoteException

setSample

void setSample(int index,
               Data range,
               boolean copy)
        throws VisADException,
               java.rmi.RemoteException

set the range value at the index-th sample

Throws:

VisADException

java.rmi.RemoteException

extract

Field extract(int component)
       throws VisADException,
              java.rmi.RemoteException

assumes the range type of this is a Tuple and returns a Field with the same domain as this, but whose range samples consist of the specified Tuple component of the range samples of this; in shorthand, this[].component

Throws:

VisADException

java.rmi.RemoteException

domainMultiply

Field domainMultiply()
              throws VisADException,
                     java.rmi.RemoteException

combine domains of two outermost nested Fields into a single domain and Field

Throws:

VisADException

java.rmi.RemoteException

domainMultiply

Field domainMultiply(int depth)
              throws VisADException,
                     java.rmi.RemoteException

combine domains to depth, if possible

Throws:

VisADException

java.rmi.RemoteException

domainFactor

Field domainFactor(RealType factor)
            throws VisADException,
                   java.rmi.RemoteException

factor Field domain into domains of two nested Fields

Throws:

VisADException

java.rmi.RemoteException

getValues

double[][] getValues()
              throws VisADException,
                     java.rmi.RemoteException

invokes getValues(true)

Throws:

VisADException

java.rmi.RemoteException

getValues

double[][] getValues(boolean copy)
              throws VisADException,
                     java.rmi.RemoteException

get the 'Flat' components of this Field's range values in their default range Units (as defined by the range of the Field's FunctionType); if the range type is a RealType it is a 'Flat' component, if the range type is a TupleType its RealType components and RealType components of its RealTupleType components are all 'Flat' components; the return array is dimensioned: double[number_of_flat_components][number_of_range_samples]; return a copy if copy == true

Throws:

VisADException

java.rmi.RemoteException

getFloats

float[][] getFloats()
             throws VisADException,
                    java.rmi.RemoteException

invokes getFloats(true)

Throws:

VisADException

java.rmi.RemoteException

getFloats

float[][] getFloats(boolean copy)
             throws VisADException,
                    java.rmi.RemoteException

get the 'Flat' components of this Field's range values in their default range Units (as defined by the range of the Field's FunctionType); if the range type is a RealType it is a 'Flat' component, if the range type is a TupleType its RealType components and RealType components of its RealTupleType components are all 'Flat' components; the return array is dimensioned: float[number_of_flat_components][number_of_range_samples]; return a copy if copy == true

Throws:

VisADException

java.rmi.RemoteException

getStringValues

java.lang.String[][] getStringValues()
                              throws VisADException,
                                     java.rmi.RemoteException

get String values for Text components

Throws:

VisADException

java.rmi.RemoteException

getDefaultRangeUnits

Unit[] getDefaultRangeUnits()
                     throws VisADException,
                            java.rmi.RemoteException

get default range Unit-s for 'Flat' components

Throws:

VisADException

java.rmi.RemoteException

getRangeUnits

Unit[][] getRangeUnits()
                throws VisADException,
                       java.rmi.RemoteException

get range Unit-s for 'Flat' components; second index may enumerate samples, if they differ

Throws:

VisADException

java.rmi.RemoteException

getRangeCoordinateSystem

CoordinateSystem[] getRangeCoordinateSystem()
                                     throws VisADException,
                                            java.rmi.RemoteException

get range CoordinateSystem for 'RealTuple' range; index may enumerate samples, if they differ

Throws:

VisADException

java.rmi.RemoteException

getRangeCoordinateSystem

CoordinateSystem[] getRangeCoordinateSystem(int component)
                                     throws VisADException,
                                            java.rmi.RemoteException

get range CoordinateSystem for 'RealTuple' components; index may enumerate samples, if they differ

Throws:

VisADException

java.rmi.RemoteException

isFlatField

boolean isFlatField()
             throws VisADException,
                    java.rmi.RemoteException

return true if this a FlatField or a RemoteField adapting a FlatField

Throws:

VisADException

java.rmi.RemoteException

domainEnumeration

java.util.Enumeration domainEnumeration()
                                 throws VisADException,
                                        java.rmi.RemoteException

   Here's how to use this:

   for (Enumeration e = field.domainEnumeration() ; e.hasMoreElements(); ) {
     RealTuple domain_sample = (RealTuple) e.nextElement();
     Data range = field.evaluate(domain_sample);
   }

Throws:

VisADException

java.rmi.RemoteException