ucar.nc2.dt

Interface RadialDatasetSweep.Sweep

Enclosing interface:

RadialDatasetSweep

public static interface RadialDatasetSweep.Sweep

A sweep is 2D data using radial coordinate system (elevation, azimuth, radial distance)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearSweepMemory() deallocated memory of sweep
float[]	getAzimuth()
float	getAzimuth(int radial)
float	getBeamWidth()
float[]	getElevation()
float	getElevation(int radial)
java.util.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.
java.util.Date	getStartingTime()
int	getSweepIndex()
Variable	getsweepVar()
float	getTime(int radial)
RadialDatasetSweep.Type	getType()
float[]	readData()
float[]	readData(int radial)

Method Detail

getType

RadialDatasetSweep.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 java.io.IOException

Returns:

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

Throws:

java.io.IOException - on io error

readData

float[] readData(int radial)
                 throws java.io.IOException

Parameters:

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

Returns:

the actual data, of length getNumGates()

Throws:

java.io.IOException - on io error

getElevation

float getElevation(int radial)
                   throws java.io.IOException

Parameters:

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

Returns:

the elevation of the ith radial, in degrees

Throws:

java.io.IOException - on io error

getElevation

float[] getElevation()
                     throws java.io.IOException

Returns:

all elevation in the sweep

Throws:

java.io.IOException - on io error

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 java.io.IOException

Parameters:

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

Returns:

the azimuth of the ith radial, in degrees

Throws:

java.io.IOException - on io error

getAzimuth

float[] getAzimuth()
                   throws java.io.IOException

Returns:

all azimuth in the sweep

Throws:

java.io.IOException - on io error

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 java.io.IOException

Parameters:

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

Returns:

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

Throws:

java.io.IOException - on io error

getStartingTime

java.util.Date getStartingTime()

Returns:

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

getEndingTime

java.util.Date getEndingTime()

Returns:

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

getSweepIndex

int getSweepIndex()

Returns:

the index of sweep

clearSweepMemory

void clearSweepMemory()

deallocated memory of sweep