anl.aida.data
Class DataUtilities

java.lang.Object
  extended by anl.aida.data.DataUtilities

public class DataUtilities
extends java.lang.Object

Version:
$Revision$ $Date$

Nested Class Summary
static class DataUtilities.MinMax
           
static class DataUtilities.MinMaxPoint
           
 
Field Summary
static int NO_LAYER
           
 
Constructor Summary
DataUtilities()
           
 
Method Summary
private static DataFrame createDataFrame(DataFrame frame)
           
private static DataUtilities.MinMax minMax(ucar.ma2.Array array)
           
static DataUtilities.MinMax minMax(DataFrame frame)
          Gets the minimum value contained by the specified DataFrame.
static DataUtilities.MinMax minMax(DataFrame frame, int timeStep)
          Gets the min max value from the DataFrame at the specified time step.
static DataUtilities.MinMax minMax(DataFrame frame, int timeStep, int layer)
           
static DataUtilities.MinMax minMaxForTimeLayer(DataFrame frame, int layer)
          Gets the min max for the specified layer over the frame's entire time range.
static DataUtilities.MinMaxPoint minMaxPoint(DataFrame frame, int timestep)
           
static DataUtilities.MinMax minMaxTimeOther(DataFrame frame, int axisIndex)
          Gets the min max value over all time steps for a specified axisIndex.
static DataUtilities.MinMaxPoint minMaxTLPoint(DataFrame frame, int timeStep, int layer)
          Gets the min max point at the specified time step and layer over all the x,y cells.
static DataUtilities.MinMax minMaxTX(DataFrame frame, int timeStep, int x)
          Gets the min max of the frame data for the specified time step and x value over all the layers and y range.
static DataUtilities.MinMaxPoint minMaxTXPoint(DataFrame frame, int timestep, int x)
           
static DataUtilities.MinMax minMaxTY(DataFrame frame, int timeStep, int y)
          Gets the min max of the frame data for the specified time step and y value over all the layers and x range.
static DataUtilities.MinMaxPoint minMaxTYPoint(DataFrame frame, int timestep, int y)
           
static DataFrame[] unitVectorTransform(DataFrame xFrame, DataFrame yFrame)
          Normalizes the xFrame and yFrame data into unit vectors.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_LAYER

public static final int NO_LAYER
See Also:
Constant Field Values
Constructor Detail

DataUtilities

public DataUtilities()
Method Detail

minMax

public static DataUtilities.MinMax minMax(DataFrame frame)
Gets the minimum value contained by the specified DataFrame.

Parameters:
frame - the DataFrame to get the value from
Returns:
the minimum value contained by the specified DataFrame.

minMax

private static DataUtilities.MinMax minMax(ucar.ma2.Array array)

minMaxTX

public static DataUtilities.MinMax minMaxTX(DataFrame frame,
                                            int timeStep,
                                            int x)
                                     throws ucar.ma2.InvalidRangeException
Gets the min max of the frame data for the specified time step and x value over all the layers and y range.

Parameters:
frame - the data
timeStep - the timestep
x - the x value
Returns:
the min max of the frame data for the specified time step and x value over all the layers and y range.
Throws:
ucar.ma2.InvalidRangeException - if the timestep or x value is out of range.

minMaxTimeOther

public static DataUtilities.MinMax minMaxTimeOther(DataFrame frame,
                                                   int axisIndex)
                                            throws ucar.ma2.InvalidRangeException
Gets the min max value over all time steps for a specified axisIndex.

Parameters:
frame -
axisDataFrameIndex -
axisIndex -
Returns:
Throws:
ucar.ma2.InvalidRangeException

minMaxTY

public static DataUtilities.MinMax minMaxTY(DataFrame frame,
                                            int timeStep,
                                            int y)
                                     throws ucar.ma2.InvalidRangeException
Gets the min max of the frame data for the specified time step and y value over all the layers and x range.

Parameters:
frame - the data
timeStep - the timestep
y - the y value
Returns:
the min max of the frame data for the specified time step and x value over all the layers and y range.
Throws:
ucar.ma2.InvalidRangeException - if the timestep or x value is out of range.

minMax

public static DataUtilities.MinMax minMax(DataFrame frame,
                                          int timeStep,
                                          int layer)
                                   throws ucar.ma2.InvalidRangeException
Throws:
ucar.ma2.InvalidRangeException

minMaxTYPoint

public static DataUtilities.MinMaxPoint minMaxTYPoint(DataFrame frame,
                                                      int timestep,
                                                      int y)
                                               throws ucar.ma2.InvalidRangeException
Throws:
ucar.ma2.InvalidRangeException

minMaxPoint

public static DataUtilities.MinMaxPoint minMaxPoint(DataFrame frame,
                                                    int timestep)
                                             throws ucar.ma2.InvalidRangeException
Throws:
ucar.ma2.InvalidRangeException

minMaxTXPoint

public static DataUtilities.MinMaxPoint minMaxTXPoint(DataFrame frame,
                                                      int timestep,
                                                      int x)
                                               throws ucar.ma2.InvalidRangeException
Throws:
ucar.ma2.InvalidRangeException

minMaxTLPoint

public static DataUtilities.MinMaxPoint minMaxTLPoint(DataFrame frame,
                                                      int timeStep,
                                                      int layer)
                                               throws ucar.ma2.InvalidRangeException
Gets the min max point at the specified time step and layer over all the x,y cells.

Parameters:
frame - the frame containing the data
timeStep - the timestep
layer - the layer
Returns:
the min max point at the specified time step and layer over all the x,y cells.
Throws:
ucar.ma2.InvalidRangeException - if the frame's rank does not equal four.

minMaxForTimeLayer

public static DataUtilities.MinMax minMaxForTimeLayer(DataFrame frame,
                                                      int layer)
                                               throws ucar.ma2.InvalidRangeException
Gets the min max for the specified layer over the frame's entire time range.

Parameters:
frame - the frame
layer - the index of the layer whose min max is desired
Returns:
the min max for the specified layer over the frame's entire time range.
Throws:
ucar.ma2.InvalidRangeException - if the range is invalid.

minMax

public static DataUtilities.MinMax minMax(DataFrame frame,
                                          int timeStep)
                                   throws ucar.ma2.InvalidRangeException
Gets the min max value from the DataFrame at the specified time step. The range for the other axes will be their existing range.

Parameters:
frame - the frame whose min max we want
timeStep - the timestep for the min max
Returns:
the min max value from the DataFrame at the specified time step. The range for the other axes will be their existing range.
Throws:
ucar.ma2.InvalidRangeException - if the range is invalid.

createDataFrame

private static DataFrame createDataFrame(DataFrame frame)

unitVectorTransform

public static DataFrame[] unitVectorTransform(DataFrame xFrame,
                                              DataFrame yFrame)
Normalizes the xFrame and yFrame data into unit vectors.

Parameters:
xFrame -
yFrame -
Returns: