ucar.nc2.dt.radial

Class RadialCoordSys

java.lang.Object

ucar.nc2.dt.radial.RadialCoordSys

public class RadialCoordSys
extends java.lang.Object

A radial CoordinateSystem has azimuth, elevation and radial axes.

Constructor Summary

Constructors

Constructor and Description
RadialCoordSys(CoordinateSystem cs) Create a RadialCoordSys from an existing Coordinate System.

Method Summary

Modifier and Type	Method and Description
CoordinateAxis	getAzimuthAxis() get the Azimuth axis
Array	getAzimuthAxisDataCached() get the Azimuth axis data.
LatLonRect	getBoundingBox()
java.util.List	getCoordAxes()
CoordinateAxis	getElevationAxis() get the Elevation axis
Array	getElevationAxisDataCached() get the Elevation axis data.
double	getMaximumRadial() Get the maximum radial distance, in km.
java.lang.String	getName()
EarthLocation	getOrigin() Origin of the coordinate system
CoordinateAxis	getRadialAxis() get the Radial axis
Array	getRadialAxisDataCached() get the Radial axis data.
CoordinateAxis	getTimeAxis() get the Time axis
Array	getTimeAxisDataCached() get the Time axis data.
DateUnit	getTimeUnits() Get the units of Calendar time.
static boolean	isRadialCoordSys(java.util.Formatter parseInfo, CoordinateSystem cs) Determine if this CoordinateSystem can be made into a RadialCoordSys.
static RadialCoordSys	makeRadialCoordSys(java.util.Formatter parseInfo, CoordinateSystem cs, Variable v) Determine if the CoordinateSystem cs can be made into a GridCoordSys for the Variable v.
void	setOrigin(EarthLocation origin)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RadialCoordSys

public RadialCoordSys(CoordinateSystem cs)

Create a RadialCoordSys from an existing Coordinate System.

Method Detail

isRadialCoordSys

public static boolean isRadialCoordSys(java.util.Formatter parseInfo,
                                       CoordinateSystem cs)

Determine if this CoordinateSystem can be made into a RadialCoordSys.

Parameters:

parseInfo - put debug information into this Formatter; may be null.

cs - the CoordinateSystem to test

Returns:

true if it can be made into a RadialCoordSys.

makeRadialCoordSys

public static RadialCoordSys makeRadialCoordSys(java.util.Formatter parseInfo,
                                                CoordinateSystem cs,
                                                Variable v)

Determine if the CoordinateSystem cs can be made into a GridCoordSys for the Variable v.

Parameters:

parseInfo - put debug information into this StringBuffer; may be null.

cs - CoordinateSystem to check.

v - Variable to check.

Returns:

the RadialCoordSys made from cs, else null.

getName

public java.lang.String getName()

getCoordAxes

public java.util.List getCoordAxes()

getAzimuthAxis

public CoordinateAxis getAzimuthAxis()

get the Azimuth axis

getElevationAxis

public CoordinateAxis getElevationAxis()

get the Elevation axis

getRadialAxis

public CoordinateAxis getRadialAxis()

get the Radial axis

getTimeAxis

public CoordinateAxis getTimeAxis()

get the Time axis

getAzimuthAxisDataCached

public Array getAzimuthAxisDataCached()
                               throws java.io.IOException

get the Azimuth axis data. Calling this will force the data to be cached.

Throws:

java.io.IOException

getElevationAxisDataCached

public Array getElevationAxisDataCached()
                                 throws java.io.IOException

get the Elevation axis data. Calling this will force the data to be cached.

Throws:

java.io.IOException

getRadialAxisDataCached

public Array getRadialAxisDataCached()
                              throws java.io.IOException

get the Radial axis data. Calling this will force the data to be cached.

Throws:

java.io.IOException

getTimeAxisDataCached

public Array getTimeAxisDataCached()
                            throws java.io.IOException

get the Time axis data. Calling this will force the data to be cached.

Throws:

java.io.IOException

getOrigin

public EarthLocation getOrigin()

Origin of the coordinate system

setOrigin

public void setOrigin(EarthLocation origin)

getMaximumRadial

public double getMaximumRadial()

Get the maximum radial distance, in km.

getBoundingBox

public LatLonRect getBoundingBox()

getTimeUnits

public DateUnit getTimeUnits()
                      throws java.lang.Exception

Get the units of Calendar time. To get a Date, from a time value, call DateUnit.getStandardDate(double value). To get units as a String, call DateUnit.getUnitsString().

Throws:

java.lang.Exception