Package ucar.nc2.dt
Interface TrajectoryObsDatatype
-
public interface TrajectoryObsDatatypeDeprecated.use ucar.nc2.ft.*A sequence (one-dimensional, variable-length list) of PointObsDatatype, connected in space and time. The observations are ordered in time (in other words, the time dimension must increase monotonically along the trajectory).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description ucar.unidata.geoloc.LatLonRectgetBoundingBox()Deprecated.BoundingBox for the trajectory.ucar.ma2.StructureDatagetData(int point)Deprecated.Get values for all parameters (except time, lat, lon, and elev) at the requested trajectory point.ucar.ma2.ArraygetData(int point, String parameterName)Deprecated.ucar.ma2.ArraygetData(ucar.ma2.Range range, String parameterName)Deprecated.Get the values of the requested parameter on the given Range of the trajectory.DataIteratorgetDataIterator(int bufferSize)Deprecated.Get an efficient iterator over all the data in the Trajectory in time order.ucar.nc2.VariableSimpleIFgetDataVariable(String name)Deprecated.Get the named data Variable.ListgetDataVariables()Deprecated.Return a list of the data Variables available in this dataset.StringgetDescription()Deprecated.A description of the trajectory.doublegetElevation(int point)Deprecated.Return the elevation at the requested trajectory point in units of meters, missing values = NaN.ucar.ma2.ArraygetElevation(ucar.ma2.Range range)Deprecated.Get the elevation values on the given Range of the trajectory.DategetEndDate()Deprecated.End date for the trajectory.ucar.ma2.RangegetFullRange()Deprecated.Get the range for the entire trajectory.StringgetId()Deprecated.The ID of the trajectory, may not be null.doublegetLatitude(int point)Deprecated.Return the latitude at the requested trajectory point in units of "degrees_north".ucar.ma2.ArraygetLatitude(ucar.ma2.Range range)Deprecated.Get the latitude values on the given Range of the trajectory.ucar.unidata.geoloc.EarthLocationgetLocation(int point)Deprecated.Return the location for the given point.doublegetLongitude(int point)Deprecated.Return the longitude at the requested trajectory point in units of "degrees_east".ucar.ma2.ArraygetLongitude(ucar.ma2.Range range)Deprecated.Get the longitude values on the given Range of the trajectory.intgetNumberPoints()Deprecated.The number of points along the trajectory.PointObsDatatypegetPointObsData(int point)Deprecated.Get a PointObsDatatype for the requested trajectory point.ucar.ma2.RangegetPointRange(int point)Deprecated.Get a range for a single point in the trajectory.ucar.ma2.RangegetRange(int start, int end, int stride)Deprecated.Get a range with the given start, end, and stride in the trajectory.DategetStartDate()Deprecated.Start date for the trajectory.DategetTime(int point)Deprecated.Return the time for the given point as a java.util.Date.ucar.ma2.ArraygetTime(ucar.ma2.Range range)Deprecated.Get the time values on the given Range of the trajectory.StringgetTimeUnitsIdentifier()Deprecated.Return the String representation of the units for time.doublegetTimeValue(int point)Deprecated.Return the time for the given point as a double in the units given by getTimeUnitsIdentifier().
-
-
-
Method Detail
-
getId
String getId()
Deprecated.The ID of the trajectory, may not be null.
-
getDescription
String getDescription()
Deprecated.A description of the trajectory.
-
getNumberPoints
int getNumberPoints()
Deprecated.The number of points along the trajectory.
-
getDataVariables
List getDataVariables()
Deprecated.Return a list of the data Variables available in this dataset. The list contains only "data variables of interest", not metadata or coordinate system variables, etc.- Returns:
- List of type TypedDataVariable
-
getDataVariable
ucar.nc2.VariableSimpleIF getDataVariable(String name)
Deprecated.Get the named data Variable.- Parameters:
name- of data Variable.- Returns:
- TypedDataVariable or null.
-
getPointObsData
PointObsDatatype getPointObsData(int point) throws IOException
Deprecated.Get a PointObsDatatype for the requested trajectory point.- Parameters:
point- the point along the trajectory- Returns:
- corresponding PointObsDatatype
- Throws:
IOException
-
getStartDate
Date getStartDate()
Deprecated.Start date for the trajectory.
-
getEndDate
Date getEndDate()
Deprecated.End date for the trajectory.
-
getBoundingBox
ucar.unidata.geoloc.LatLonRect getBoundingBox()
Deprecated.BoundingBox for the trajectory. May not be available.
-
getTime
Date getTime(int point) throws IOException
Deprecated.Return the time for the given point as a java.util.Date.- Throws:
IOException
-
getLocation
ucar.unidata.geoloc.EarthLocation getLocation(int point) throws IOExceptionDeprecated.Return the location for the given point.- Throws:
IOException
-
getTimeValue
double getTimeValue(int point) throws IOExceptionDeprecated.Return the time for the given point as a double in the units given by getTimeUnitsIdentifier().- Throws:
IOException
-
getTimeUnitsIdentifier
String getTimeUnitsIdentifier()
Deprecated.Return the String representation of the units for time.
-
getLatitude
double getLatitude(int point) throws IOExceptionDeprecated.Return the latitude at the requested trajectory point in units of "degrees_north".- Throws:
IOException
-
getLongitude
double getLongitude(int point) throws IOExceptionDeprecated.Return the longitude at the requested trajectory point in units of "degrees_east".- Throws:
IOException
-
getElevation
double getElevation(int point) throws IOExceptionDeprecated.Return the elevation at the requested trajectory point in units of meters, missing values = NaN.- Throws:
IOException
-
getData
ucar.ma2.StructureData getData(int point) throws IOException, ucar.ma2.InvalidRangeExceptionDeprecated.Get values for all parameters (except time, lat, lon, and elev) at the requested trajectory point. Units are as given by getXXUnitsIdentifier() methods.- Parameters:
point- the index point into the trajectory- Returns:
- ucar.nc2.StructureData containing an Array for each parameter.
- Throws:
IOException- if problems reading data.ucar.ma2.InvalidRangeException
-
getData
ucar.ma2.Array getData(int point, String parameterName) throws IOExceptionDeprecated.- Throws:
IOException
-
getDataIterator
DataIterator getDataIterator(int bufferSize) throws IOException
Deprecated.Get an efficient iterator over all the data in the Trajectory in time order. This is an optional method; it will return null if no iterator is available. This is the efficient way to get all the data, it can be 100 times faster than getData(). This will return an iterator over type getDataClass(), and the actual data has already been read into memory, that is, dataType.getData() will not incur any I/O.This is accomplished by buffering bufferSize amount of data at once. You must fully process the data, or copy it out of the StructureData, as you iterate over it, in order for the garbage collector to work.
We dont need a cancelTask, just stop the iteration if the user want to cancel.
- Parameters:
bufferSize- if > 0, the internal buffer size, else use the default. Typically 100k - 1M for best results.- Returns:
- Iterator over type PointObsDatatype, time order; or null if not available.
- Throws:
IOException
-
getFullRange
ucar.ma2.Range getFullRange()
Deprecated.Get the range for the entire trajectory.
-
getPointRange
ucar.ma2.Range getPointRange(int point) throws ucar.ma2.InvalidRangeExceptionDeprecated.Get a range for a single point in the trajectory.- Throws:
ucar.ma2.InvalidRangeException
-
getRange
ucar.ma2.Range getRange(int start, int end, int stride) throws ucar.ma2.InvalidRangeExceptionDeprecated.Get a range with the given start, end, and stride in the trajectory.- Throws:
ucar.ma2.InvalidRangeException
-
getTime
ucar.ma2.Array getTime(ucar.ma2.Range range) throws IOException, ucar.ma2.InvalidRangeExceptionDeprecated.Get the time values on the given Range of the trajectory.- Throws:
IOExceptionucar.ma2.InvalidRangeException
-
getLatitude
ucar.ma2.Array getLatitude(ucar.ma2.Range range) throws IOException, ucar.ma2.InvalidRangeExceptionDeprecated.Get the latitude values on the given Range of the trajectory.- Throws:
IOExceptionucar.ma2.InvalidRangeException
-
getLongitude
ucar.ma2.Array getLongitude(ucar.ma2.Range range) throws IOException, ucar.ma2.InvalidRangeExceptionDeprecated.Get the longitude values on the given Range of the trajectory.- Throws:
IOExceptionucar.ma2.InvalidRangeException
-
getElevation
ucar.ma2.Array getElevation(ucar.ma2.Range range) throws IOException, ucar.ma2.InvalidRangeExceptionDeprecated.Get the elevation values on the given Range of the trajectory.- Throws:
IOExceptionucar.ma2.InvalidRangeException
-
getData
ucar.ma2.Array getData(ucar.ma2.Range range, String parameterName) throws IOException, ucar.ma2.InvalidRangeExceptionDeprecated.Get the values of the requested parameter on the given Range of the trajectory.- Throws:
IOExceptionucar.ma2.InvalidRangeException
-
-