Package ucar.nc2.ft.radial

Interface RadialSweepFeature

public interface RadialSweepFeature

Since:

Feb 18, 2008

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RadialSweepFeature.Type

Method Summary

Modifier and Type	Method	Description
void	clearSweepMemory()	deallocate memory of sweep
float[]	getAzimuth()
float	getAzimuth(int radial)
float	getBeamWidth()
float[]	getElevation()
float	getElevation(int radial)
Date	getEndingTime()
int	getGateNumber()
float	getGateSize()	Get the radial length of each data gate.
float	getMeanAzimuth()
float	getMeanElevation()
float	getNyquistFrequency()
EarthLocation	getOrigin(int radial)
int	getRadialNumber()
float	getRangeToFirstGate()	Get the radial distance from origin to the start of the first data gate.
Date	getStartingTime()
int	getSweepIndex()
Variable	getSweepVar()
float	getTime(int radial)
RadialSweepFeature.Type	getType()
float[]	readData()
float[]	readData(int radial)

Method Detail

getType

RadialSweepFeature.Type getType()

Returns:

the type of the Sweep

getSweepVar

Variable getSweepVar()

getRadialNumber

int getRadialNumber()

Returns:

the number of radials for this Sweep

getGateNumber

int getGateNumber()

Returns:

the number of gates for all radials

getBeamWidth

float getBeamWidth()

Returns:

the beam width for all radials, in degrees

getNyquistFrequency

float getNyquistFrequency()

Returns:

the Nyquist Frequency for all radials

getRangeToFirstGate

float getRangeToFirstGate()

Get the radial distance from origin to the start of the first data gate. The radial distance to the ith gate = getRangeToFirstGate() + getGateSize() * i

Returns:

distance to first gate in meters, for all radials

getGateSize

float getGateSize()

Get the radial length of each data gate. The radial distance to the ith gate = getRangeToFirstGate() + getGateSize() * i

Returns:

gate size in meters, for all radials

readData

float[] readData()
          throws IOException

Returns:

all the sweep data, of length getNumRadials() by getNumGates()

Throws:

IOException

readData

float[] readData(int radial)
          throws IOException

Parameters:

radial - which radial, must in interval [0,getRadialNumber())

Returns:

the actual data, of length getNumGates()

Throws:

IOException

getElevation

float getElevation(int radial)
            throws IOException

Parameters:

radial - which radial, must in interval [0,getRadialNumber())

Returns:

the elevation of the ith radial, in degrees

Throws:

IOException

getElevation

float[] getElevation()
              throws IOException

Returns:

all elevation in the sweep

Throws:

IOException

getMeanElevation

float getMeanElevation()

Returns:

the average elevation of all the radials in the sweep, in degrees. Only valid if getType() == TYPE_

getAzimuth

float getAzimuth(int radial)
          throws IOException

Parameters:

radial - which radial, must in interval [0,getRadialNumber())

Returns:

the azimuth of the ith radial, in degrees

Throws:

IOException

getAzimuth

float[] getAzimuth()
            throws IOException

Returns:

all azimuth in the sweep

Throws:

IOException

getMeanAzimuth

float getMeanAzimuth()

Returns:

the average azimuth of all the radials in the sweep, in degrees. Only valid if getType() == TYPE_

getOrigin

EarthLocation getOrigin(int radial)

Parameters:

radial - which radial, must in interval [0,getRadialNumber())

Returns:

the location of the origin of the ith radial.

getTime

float getTime(int radial)
       throws IOException

Parameters:

radial - which radial, must in interval [0,getRadialNumber())

Returns:

the time of the ith radial, in units of getTimeUnits().

Throws:

IOException

getStartingTime

Date getStartingTime()

Returns:

the starting time of the sweep, in units of getTimeUnits().

getEndingTime

Date getEndingTime()

Returns:

the ending time of the sweep, in units of getTimeUnits().

getSweepIndex

int getSweepIndex()

Returns:

the index of sweep

clearSweepMemory

void clearSweepMemory()

deallocate memory of sweep