This class reads in and decodes GRIB data. More...

#include "../include/GribFile.h"

Public Types
enum	Type { NONE , WXP , WMO , WXP_OLD , NCEP , RAW , RAW_NS }

Public Member Functions
	GribFile ()

	GribFile (const char *filename)

	GribFile (Filename &filename)

	~GribFile ()

int	init ()

bool	isOpen ()

int	setParam (const char *str)

int	useHdrFile (bool val)

int	setMaxBad (int val)

int	setMissValue (float rmiss)

int	setValueBits (int val)

int	setWrap (int val)

int	open (const char *filename, int raccess)

int	open (const char *filename)

int	open (Filename &filename)

int	close ()

int	rewind ()

int	getVersion ()

const char *	getWmoHdr ()

int	getHeader (Grid &grid)

int	read (Grid &grid)

int	read (const char *spec, Grid &grid)

int	read (GridSpec &spec, Grid &grid)

int	read (Grids &grids)

int	makeInfo (GribPDB &pdb, Grid &grid)

int	makeDatim (Grid &grid)

int	peek (Grid &grid)

int	next ()

int	readHeader ()

int	searchGRIB ()

int	readData (int bytes)

int	readBits ()

unsigned char	getByte (int loc)

int	seekData (int val)

int	tellData ()

GribParam	getVer1Param (int ver, int src, int table, int param)

int	readPDB (GribPDB &pdb)

int	setPDB (GribPDB &pdb, Grid &grid)

int	readGDB (DomainVal &dv)

int	readBMB ()

bool	checkBMB ()

int	readBDB (Grid &grid)

int	readSection ()

int	skipSection ()

GribParam	getVer2Param (int src, int disc, int cat, int param)

int	readIDS (GribPDB &pdb)

int	readGDS (DomainVal &dv)

int	readPDS (GribPDB &pdb)

int	readDRS ()

int	readBMS ()

int	readDS (Grid &grid)

int	writeBits (int val)

int	write (Grid &grid)

Static Public Member Functions
static int	checkType (const char *filename)

static float	convIBMFloat (const unsigned char *pc)

static int	convIBMFloat (float val, unsigned char *pc)

static float	convIEEEFloat (const unsigned char *pc)

static float	convScale (const unsigned char *pc)

static int	convScale (float scale)

static int	setDomain (int type, DomainVal &dv)

Static Public Attributes
static const int	LIMIT = 300000

Detailed Description

This class reads in and decodes GRIB data.

Author: Dan Vietor

Constructor & Destructor Documentation

◆ GribFile() [1/3]

GribFile::GribFile ( )

Constructor. Initializes class values.

References init().

◆ GribFile() [2/3]

GribFile::GribFile ( const char * filename )

Constructor. Opens file for reading.

Parameters

filename Name of GRIB file to read from

References init().

◆ GribFile() [3/3]

GribFile::GribFile ( Filename & filename )

Constructor. Opens a file for reading (uses header file if available)

Parameters

filename Filename class containing filename info

References init().

◆ ~GribFile()

GribFile::~GribFile ( )

Destructor.

References close().

Member Function Documentation

◆ checkBMB()

bool GribFile::checkBMB ( )

Checks the Bit Map Block. If the gridpoint is valid, it returns true.

Returns: True if valid

Referenced by readBDB(), and readDS().

◆ checkType()

int GribFile::checkType ( const char * filename )

static

Attempts to determine the file type by parsing start of file.

Parameters

filename The filename to check

Returns: The type of file (WXP, WMO, RAW)

References WXP::File::close(), WXP::StrLib::equal(), WXP::File::isOpen(), WXP::File::open(), and WXP::File::read().

Referenced by open().

◆ close()

int GribFile::close ( )

Closes the file

References WXP::File::close(), and WXP::File::isOpen().

Referenced by WXP::GridFile::close(), open(), ~GribFile(), and WXP::GridFile::~GridFile().

◆ convIBMFloat() [1/2]

float GribFile::convIBMFloat ( const unsigned char * dat )

static

Decodes the IBM 370 floating point format. IBM format is: seee eeee mmmm mmmm mmmm mmmm mmmm mmmm x = (-1^s) * mmm.../s^24 * 16^(eeee-64)

Parameters

dat	IBM 370 float value to convert.

Returns: Actual floating point number

Referenced by readBDB(), and readPDB().

◆ convIBMFloat() [2/2]

int GribFile::convIBMFloat	(	float	val,
		unsigned char *	dat
	)

static

Converts val to IBM 370 floating point format. IBM format is: seee eeee mmmm mmmm mmmm mmmm mmmm mmmm x = (-1^s) * mmm.../s^24 * 16^(eeee-64)

Parameters

val	Data value to convert.
dat	IBM 370 float data

◆ convIEEEFloat()

float GribFile::convIEEEFloat ( const unsigned char * dat )

static

Converts the IEEE floating point format. IBM format is: seee eeee emmm mmmm mmmm mmmm mmmm mmmm x = (-1^s) * mmm.../s^24 * 2^(eeee-127)

Parameters

dat	Data value to convert.

Returns: Actual floating point number

Referenced by readDRS().

◆ convScale()

float GribFile::convScale ( const unsigned char * dat )

static

Decodes the scale factor from GRIB. The scale factor is encoded as follows: seee eeee x = 2^((-1^s)*eeee)

Parameters

dat	Data values to convert

Returns: Scale factor.

Referenced by readBDB(), and readDRS().

◆ getByte()

unsigned char GribFile::getByte ( int loc )

Gets a byte from the data buffer.

Parameters

loc	Location in buffer to retrieve byte.

Referenced by readBDB(), readBMB(), readBMS(), readDRS(), readGDB(), readGDS(), readIDS(), readPDB(), readPDS(), readSection(), and searchGRIB().

◆ getHeader()

int GribFile::getHeader ( Grid & grid )

Reads in a single grid from the file (header data only).

Return values

grid	Grid object to put data into

Returns: 1=more data, 0=end of file

References WXP::File::getLine(), WXP::Grid::init(), next(), WXP::Wxp::outDebug(), readGDB(), readHeader(), readPDB(), WXP::File::seek(), WXP::Grid::setDomain(), and setPDB().

◆ getVersion()

int WXP::GribFile::getVersion ( )

inline

Get GRIB version number

◆ getWmoHdr()

const char * WXP::GribFile::getWmoHdr ( )

inline

Get WMO header

◆ init()

int GribFile::init ( )

Initializes the class

Referenced by GribFile(), and open().

◆ isOpen()

bool GribFile::isOpen ( )

Determines if file is open

Returns: True if opened

Referenced by WXP::ImagePlot::draw(), WXP::RadPlot::draw(), WXP::RadMask::getGrids(), and WXP::GridFile::open().

◆ makeDatim()

int GribFile::makeDatim ( Grid & grid )

Creates date/time string in Grid object from data in GRIB.

Parameters

grid	The Grid object to update

References WXP::ForeTime::ACC, WXP::Date::addSeconds(), WXP::ForeTime::ANAL, WXP::StrLib::append(), WXP::StrLib::aprintf(), WXP::ForeTime::AVG, WXP::StrLib::clear(), WXP::StrLib::copy(), WXP::ForeTime::FORE, WXP::String::get(), WXP::Grid::getDateVal(), WXP::Grid::getForeTime(), WXP::Date::getMinute(), WXP::ForeTime::getSeconds(), WXP::DateVal::hour, WXP::Const::MISS, WXP::Date::set(), WXP::ForeTime::set(), WXP::Grid::setDatim(), WXP::Date::toText(), WXP::ForeTime::toTimeLabel(), WXP::ForeTime::toTimeLabelDay(), and WXP::StrLib::valid().

Referenced by setPDB().

◆ makeInfo()

int GribFile::makeInfo	(	GribPDB &	pdb,
		Grid &	grid
	)

Creates the info string in the Grid object from information in the GRIB

Parameters

grid	Grid object to update

References WXP::StrLib::append(), WXP::StrLib::clear(), WXP::String::get(), WXP::Grid::getForeTime(), WXP::Grid::getLevel(), WXP::Grid::setInfo(), WXP::Level::toLabel(), WXP::Variable::toLabel(), WXP::ForeTime::toVarLabel(), and WXP::String::valid().

Referenced by setPDB().

◆ next()

int GribFile::next ( )

Move to the next GRIB product in file.

References WXP::Wxp::outDebug(), and WXP::File::seek().

Referenced by getHeader(), and read().

◆ open() [1/2]

int GribFile::open ( const char * filename )

Opens the file.

Parameters

filename Filename to open

References checkType(), close(), init(), WXP::File::isOpen(), WXP::File::open(), and WXP::FileAttr::READ.

◆ open() [2/2]

int GribFile::open ( Filename & filename )

Opens a file using a Filename object. Will use header file if available.

Parameters

filename The Filename object to get filename from

References checkType(), close(), WXP::Filename::getDateval(), WXP::Filename::getHeader(), WXP::Filename::getName(), init(), WXP::File::isOpen(), WXP::DateVal::min, WXP::File::open(), WXP::FileAttr::READ, WXP::DateVal::sec, WXP::Date::set(), and WXP::Filename::validHeader().

◆ read()

int GribFile::read ( Grid & grid )

Reads in a single grid from the file.

Return values

grid	Grid object to put data into

Returns: 1=more data, 0=end of file

References WXP::File::getLine(), WXP::Grid::init(), WXP::Wxp::isDebug(), next(), WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), readBDB(), readBMB(), readBMS(), readDRS(), readDS(), readGDB(), readGDS(), readHeader(), readIDS(), readPDB(), readPDS(), readSection(), WXP::File::seek(), seekData(), WXP::Grid::setDomain(), setDomain(), setPDB(), and skipSection().

Referenced by WXP::ImagePlot::draw(), WXP::RadPlot::draw(), WXP::RadMask::getGrids(), and WXP::GridFile::read().

◆ readBDB()

int GribFile::readBDB ( Grid & grid )

Processes the Binary Data Block. This block contains the actual gridpoint data.

Return values

grid	Grid to put data into

References WXP::Grid::allocData(), checkBMB(), convIBMFloat(), convScale(), WXP::DomainVal::dy, getByte(), WXP::Grid::getDomainVal(), WXP::Grid::getValue(), WXP::Const::MISS, WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::Wxp::outDebug(), readBits(), readData(), and WXP::Grid::setValue().

Referenced by read().

◆ readBits()

int GribFile::readBits ( )

Reads in a set number of bits from a datafile and returns a integer.

Returns: Integer value from data buffer.

References WXP::File::read().

Referenced by readBDB(), and readDS().

◆ readBMB()

int GribFile::readBMB ( )

Reads in the GRIB Bit Map Block and puts it into a BMB data buffer. The BMB tells which gridpoints contain valid data and which don't (MISS).

References getByte(), WXP::Wxp::outDebug(), WXP::File::read(), and readData().

Referenced by read().

◆ readBMS()

int GribFile::readBMS ( )

Reads in the GRIB2 Bit Map Section

References getByte(), WXP::Wxp::outDebug(), WXP::File::read(), readData(), and seekData().

Referenced by read().

◆ readData()

int GribFile::readData ( int bytes )

Reads in a set number of bytes from the data file into a data buffer.

Parameters

bytes The number of bytes to read in.

References WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), WXP::File::read(), and WXP::File::tell().

Referenced by readBDB(), readBMB(), readBMS(), readDRS(), readGDB(), readGDS(), readIDS(), readPDB(), readPDS(), readSection(), and searchGRIB().

◆ readDRS()

int GribFile::readDRS ( )

Reads in the GRIB2 Data Representation Section

References convIEEEFloat(), convScale(), getByte(), WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), readData(), and seekData().

Referenced by read().

◆ readDS()

int GribFile::readDS ( Grid & grid )

Reads in the GRIB2 Data Section

References WXP::Grid::allocData(), checkBMB(), WXP::Grid::getNx(), WXP::Grid::getNy(), WXP::Grid::getValue(), WXP::Const::MISS, WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), WXP::File::read(), readBits(), and WXP::Grid::setValue().

Referenced by read().

◆ readGDB()

int GribFile::readGDB ( DomainVal & dv )

Reads in the GRIB Grid Definition Block

Return values

dv	DomainVal structure to put GDB data

References WXP::DomainVal::clat, WXP::DomainVal::clon, WXP::DomainVal::dx, WXP::DomainVal::dy, getByte(), WXP::DomainVal::init(), WXP::Domain::LAMB, WXP::EarthPoint::lat, WXP::Domain::LATLON, WXP::EarthPoint::lon, WXP::Domain::MERC, WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), WXP::DomainVal::param, WXP::DomainVal::plat, WXP::DomainVal::plon, WXP::DomainVal::proj, WXP::Domain::PSTEREO, readData(), seekData(), WXP::Domain::set(), WXP::Domain::tran(), WXP::Point::x, and WXP::Point::y.

Referenced by getHeader(), and read().

◆ readGDS()

int GribFile::readGDS ( DomainVal & dv )

Reads in the GRIB2 Grid Definition Section

Return values

dv	DomainVal structure to put GDB data

References WXP::DomainVal::clat, WXP::DomainVal::clon, WXP::DomainVal::dx, WXP::DomainVal::dy, getByte(), WXP::DomainVal::init(), WXP::Domain::LAMB, WXP::EarthPoint::lat, WXP::Domain::LATLON, WXP::EarthPoint::lon, WXP::Domain::MERC, WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), WXP::DomainVal::param, WXP::DomainVal::plat, WXP::DomainVal::plon, WXP::DomainVal::proj, WXP::Domain::PSTEREO, readData(), seekData(), WXP::Domain::set(), WXP::Domain::tran(), WXP::Point::x, and WXP::Point::y.

Referenced by read().

◆ readHeader()

int GribFile::readHeader ( )

Reads in the grid header and position at the front of the GRIB data. This is dependent on the type of datafile and how the GRIB data is encapulated.

References WXP::StrLib::copy(), WXP::StrLib::equal(), WXP::File::getLine(), WXP::Wxp::outDebug(), searchGRIB(), WXP::File::skipLine(), and WXP::File::tell().

Referenced by getHeader(), and read().

◆ readIDS()

int GribFile::readIDS ( GribPDB & pdb )

Reads in the GRIB2 Identification Section

Parameters

pdb	GribPDB object to put data

References WXP::DateVal::day, getByte(), WXP::DateVal::hour, WXP::DateVal::min, WXP::DateVal::month, WXP::Wxp::outDebug(), readData(), WXP::DateVal::sec, seekData(), and WXP::DateVal::year.

Referenced by read().

◆ readPDB()

int GribFile::readPDB ( GribPDB & pdb )

Reads in the GRIB Product Definition Block

Return values

pdb	GribPDB object to put data

References WXP::ForeTime::ACC, WXP::ForeTime::ANAL, WXP::ForeTime::AVG, convIBMFloat(), WXP::DateVal::day, WXP::ForeTime::DAY, WXP::ForeTime::DIFF, WXP::ForeTime::FORE, getByte(), WXP::Variable::getInd(), WXP::Variable::getType(), WXP::Variable::getVal1(), WXP::Variable::getVal2(), WXP::Level::HAG, WXP::Level::HBG, WXP::DateVal::hour, WXP::ForeTime::HOUR, WXP::Level::HT, WXP::DateVal::min, WXP::ForeTime::MINUTE, WXP::Const::MISS, WXP::DateVal::month, WXP::ForeTime::MONTH, WXP::Level::MSL, WXP::Wxp::outDebug(), WXP::Level::PAG, WXP::Level::POT, WXP::Level::PR, readData(), WXP::ForeTime::RNG, WXP::DateVal::sec, seekData(), WXP::ForeTime::set(), WXP::Level::set(), WXP::Variable::setAbbr(), WXP::Variable::setInd(), WXP::Variable::setName(), WXP::Variable::setType(), WXP::Variable::setUnits(), WXP::Variable::setVal1(), WXP::Variable::setVal2(), WXP::Level::SIG, WXP::Level::toTypeCode(), and WXP::DateVal::year.

Referenced by getHeader(), and read().

◆ readPDS()

int GribFile::readPDS ( GribPDB & pdb )

Reads in the GRIB2 Product Definition Section

Return values

pdb	GribPDB object to put data

References WXP::ForeTime::ACC, WXP::ForeTime::ANAL, WXP::ForeTime::AVG, WXP::DateVal::computeSecs(), WXP::DateVal::day, WXP::ForeTime::DIFF, WXP::ForeTime::FORE, getByte(), WXP::Variable::getInd(), WXP::Variable::getType(), WXP::Variable::getVal1(), WXP::Variable::getVal2(), WXP::Level::HBG, WXP::DateVal::hour, WXP::Wxp::isDebug(), WXP::ForeTime::MAX, WXP::DateVal::min, WXP::ForeTime::MIN, WXP::Const::MISS, WXP::DateVal::month, WXP::Level::NONE, WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), WXP::Level::PAG, WXP::Level::POT_VORT, WXP::Level::PR, readData(), WXP::ForeTime::RNG, WXP::DateVal::sec, seekData(), WXP::ForeTime::set(), WXP::Level::set(), WXP::Variable::setAbbr(), WXP::Variable::setInd(), WXP::Variable::setName(), WXP::Variable::setType(), WXP::Variable::setUnits(), WXP::Variable::setVal1(), WXP::Variable::setVal2(), WXP::Level::SFC, and WXP::DateVal::year.

Referenced by read().

◆ readSection()

int GribFile::readSection ( )

Reads in the GRIB2 Section header

References getByte(), WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), and readData().

Referenced by read().

◆ searchGRIB()

int GribFile::searchGRIB ( )

Searches for the keyword GRIB.

References WXP::StrLib::equal(), getByte(), WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), readData(), and seekData().

Referenced by readHeader().

◆ seekData()

int GribFile::seekData ( int val )

Seeks to a specific location in the data buffer.

Parameters

val	Location to seek to.

References WXP::Wxp::outDebug().

Referenced by read(), readBMS(), readDRS(), readGDB(), readGDS(), readIDS(), readPDB(), readPDS(), and searchGRIB().

◆ setDomain()

int GribFile::setDomain	(	int	type,
		DomainVal &	dv
	)

static

Determines grid domain values from grid type

Parameters

type	The model type

Return values

dv	The domain values

References WXP::DomainVal::clat, WXP::DomainVal::clon, WXP::DomainVal::dx, WXP::DomainVal::dy, WXP::DomainVal::init(), WXP::Domain::LAMB, WXP::Domain::LATLON, WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::DomainVal::param, WXP::DomainVal::plon, and WXP::DomainVal::proj.

Referenced by read().

◆ setMaxBad()

int GribFile::setMaxBad ( int val )

Sets the maximum bad limit. This is used to determine how many values that vary wildly from the previous value to let go before the rest of the grid is determined to be bad. If the binary data are corrupt, the values from one gridpoint to another will start varying wildly. This is used to prevent coorrupted data from being used.

Parameters

val	Maximum number of suspected bad values to let go.

◆ setPDB()

int GribFile::setPDB	(	GribPDB &	pdb,
		Grid &	grid
	)

Puts PDB information into the grid

Parameters

pdb	Product definition information

Return values

grid	Grid object to put data

References WXP::ModelName::get(), WXP::Grid::getSource(), makeDatim(), makeInfo(), WXP::Grid::setDate(), WXP::Grid::setForeTime(), WXP::Grid::setGenName(), WXP::Grid::setLevel(), WXP::Grid::setSource(), and WXP::Grid::setVersion().

Referenced by getHeader(), and read().

◆ skipSection()

int GribFile::skipSection ( )

Skips over current GRIB2 Section

References WXP::File::seek().

Referenced by read().

◆ useHdrFile()

int GribFile::useHdrFile ( bool val )

Sets whether to use header files

Parameters

val	Boolean setting whether to use header file or not

Referenced by WXP::RadMask::getGrids(), WXP::GridFile::open(), and WXP::GridFile::useHdrFile().

◆ writeBits()

int GribFile::writeBits ( int val )

Reads in a set number of bits from a datafile and returns a integer.

Returns: Integer value from data buffer.

References WXP::File::write().

The documentation for this class was generated from the following files:

GribFile.h
GribFile.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GribFile() [1/3]

◆ GribFile() [2/3]

◆ GribFile() [3/3]

◆ ~GribFile()

Member Function Documentation

◆ checkBMB()

◆ checkType()

◆ close()

◆ convIBMFloat() [1/2]

◆ convIBMFloat() [2/2]

◆ convIEEEFloat()

◆ convScale()

◆ getByte()

◆ getHeader()

◆ getVersion()

◆ getWmoHdr()

◆ init()

◆ isOpen()

◆ makeDatim()

◆ makeInfo()

◆ next()

◆ open() [1/2]

◆ open() [2/2]

◆ read()

◆ readBDB()

◆ readBits()

◆ readBMB()

◆ readBMS()

◆ readData()

◆ readDRS()

◆ readDS()

◆ readGDB()

◆ readGDS()

◆ readHeader()

◆ readIDS()

◆ readPDB()

◆ readPDS()

◆ readSection()

◆ searchGRIB()

◆ seekData()

◆ setDomain()

◆ setMaxBad()

◆ setPDB()

◆ skipSection()

◆ useHdrFile()

◆ writeBits()