code::LevelII::Message1Radial Struct Reference

Inheritance diagram for code::LevelII::Message1Radial:

code::LevelII::Radial List of all members.

Detailed Description

A radial transmitted as message 1.

Will not be super-resolution or contain polarimetric moments

Author:
lakshman


Public Member Functions

virtual ~Message1Radial ()
virtual short getRadialStatus () const
virtual bool endOfVolume () const
virtual bool endOfElev () const
virtual float getAzimuth () const
virtual int getSweepNo () const
virtual int getVCP () const
virtual float getNyquistVelocity () const
virtual float getElevation () const
virtual Time getTime () const
virtual float range_to_first_gate_ref () const
virtual float range_to_first_gate_vel () const
virtual float range_to_first_gate_spw () const
virtual float gate_width_ref () const
virtual float gate_width_vel () const
virtual float gate_width_spw () const
std::pair< unsigned char *,
size_t > 
ref () const
 Returns the reflectivity data in this radial.
std::pair< unsigned char *,
size_t > 
vel () const
 Returns the velocity data in this radial.
std::pair< unsigned char *,
size_t > 
spw () const
 Returns the spectrum-width data in this radial.
virtual SmartPtr< std::vector<
float > > 
ref_dbz () const
 returns the reflectivity data in dbz
virtual SmartPtr< std::vector<
float > > 
vel_ms () const
 returns the velocity data in m/s
virtual SmartPtr< std::vector<
float > > 
spw_ms () const
 returns the spw data in m/s
void setReflectivity (const std::vector< float > &dbz)
 pass in dbz
void setVelocity (const std::vector< float > &vel)
 pass in m/s
void setSpectrumWidth (const std::vector< float > &spw)
 pass in m/s

Static Public Member Functions

static size_t getBytesForHeader ()
 Get the number of bytes required to read the header.
static MessageHeader getMessageHeader (const Buffer &buf)
 Pass in a buffer containing at least the number of bytes in header.

Public Attributes

Message1RadialHeader radial_header
unsigned char moment_data [2300]
 This data contains: ref, vel, spw or garbage.
int frame_check_sequence
short transmission_header [6]
MessageHeader message_header

Friends

std::ostream & operator<< (std::ostream &, const Message1Radial &)
 outputs useful (human-readable) information about this radial.
BOIStream & operator>> (BOIStream &is, Message1Radial &) throw (std::string)
BOOStream & operator<< (BOOStream &os, const Message1Radial &)


Constructor & Destructor Documentation

virtual code::LevelII::Message1Radial::~Message1Radial (  )  [inline, virtual]


Member Function Documentation

virtual bool code::LevelII::Message1Radial::endOfElev (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual bool code::LevelII::Message1Radial::endOfVolume (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual float code::LevelII::Message1Radial::gate_width_ref (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual float code::LevelII::Message1Radial::gate_width_spw (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual float code::LevelII::Message1Radial::gate_width_vel (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual float code::LevelII::Message1Radial::getAzimuth (  )  const [inline, virtual]

Implements code::LevelII::Radial.

static size_t code::LevelII::Radial::getBytesForHeader (  )  [inline, static, inherited]

Get the number of bytes required to read the header.

See also:
getTotalBytesForRadial

virtual float code::LevelII::Message1Radial::getElevation (  )  const [inline, virtual]

Implements code::LevelII::Radial.

static MessageHeader code::LevelII::Radial::getMessageHeader ( const Buffer &  buf  )  [static, inherited]

Pass in a buffer containing at least the number of bytes in header.

See also:
getBytesForHeader

virtual float code::LevelII::Message1Radial::getNyquistVelocity (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual short code::LevelII::Message1Radial::getRadialStatus (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual int code::LevelII::Message1Radial::getSweepNo (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual Time code::LevelII::Message1Radial::getTime (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual int code::LevelII::Message1Radial::getVCP (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual float code::LevelII::Message1Radial::range_to_first_gate_ref (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual float code::LevelII::Message1Radial::range_to_first_gate_spw (  )  const [inline, virtual]

Implements code::LevelII::Radial.

virtual float code::LevelII::Message1Radial::range_to_first_gate_vel (  )  const [inline, virtual]

Implements code::LevelII::Radial.

std::pair<unsigned char*,size_t> code::LevelII::Message1Radial::ref (  )  const

Returns the reflectivity data in this radial.

first arg is the pointer to the ref data (0 if not present) second arg is the number of bytes of ref data.

Reflectivity data (0 - 460 gates) (coded: [((Value-2)/2.)-32. = dBZ], for Value of 0 or 1 see note below).

virtual SmartPtr< std::vector<float> > code::LevelII::Message1Radial::ref_dbz (  )  const [virtual]

returns the reflectivity data in dbz

Implements code::LevelII::Radial.

void code::LevelII::Message1Radial::setReflectivity ( const std::vector< float > &  dbz  ) 

pass in dbz

void code::LevelII::Message1Radial::setSpectrumWidth ( const std::vector< float > &  spw  ) 

pass in m/s

void code::LevelII::Message1Radial::setVelocity ( const std::vector< float > &  vel  ) 

pass in m/s

std::pair<unsigned char*,size_t> code::LevelII::Message1Radial::spw (  )  const

Returns the spectrum-width data in this radial.

first arg is the pointer to the spw data (0 if not present) second arg is the number of bytes of spw data.

Doppler spectrum width (coded: [((Value - 2)/2.)-63.5 = M/S], for Value of 0 or 1 see note below), (0 - 920 gates). Starting data location depends on length of the reflectivity and velocity fields, stop location depends on length of the spectrum width field. Spectrum width is range unambiguous out to 230 KM.

virtual SmartPtr< std::vector<float> > code::LevelII::Message1Radial::spw_ms (  )  const [virtual]

returns the spw data in m/s

Implements code::LevelII::Radial.

std::pair<unsigned char*,size_t> code::LevelII::Message1Radial::vel (  )  const

Returns the velocity data in this radial.

first arg is the pointer to the vel data (0 if not present) second arg is the number of bytes of vel data.

Doppler velocity data (coded: for doppler velocity resolution of 0.5 M/S, [((Value-2)/2.)-63.5 = M/S]; for doppler resolution of 1.0 M/S, [(Value-2)-127.] = M/S], for Value of 0 or 1 see note below), (0 - 92 gates). Starting data location depends on length of the reflectivity field, stop location depends on length of the velocity field. Velocity data is range unambiguous out to 230 KM.

virtual SmartPtr< std::vector<float> > code::LevelII::Message1Radial::vel_ms (  )  const [virtual]

returns the velocity data in m/s

Implements code::LevelII::Radial.


Friends And Related Function Documentation

BOOStream& operator<< ( BOOStream &  os,
const Message1Radial  
) [friend]

std::ostream& operator<< ( std::ostream &  ,
const Message1Radial  
) [friend]

outputs useful (human-readable) information about this radial.

BOIStream& operator>> ( BOIStream &  is,
Message1Radial  
) throw (std::string) [friend]


Member Data Documentation

int code::LevelII::Message1Radial::frame_check_sequence

MessageHeader code::LevelII::Radial::message_header [inherited]

unsigned char code::LevelII::Message1Radial::moment_data[2300]

This data contains: ref, vel, spw or garbage.

Use the ref, vel and swp methods to get the required data.

460+920+920 = 2300 in the case of message-1

Message1RadialHeader code::LevelII::Message1Radial::radial_header

short code::LevelII::Radial::transmission_header[6] [inherited]


Generated on Fri May 4 13:40:22 2012 for WDSS-IIw2algs by  doxygen 1.4.7