WXP C++ Library Version 6.74.9
Loading...
Searching...
No Matches
Public Member Functions | List of all members
WXP::RadMask Class Reference

This class sets up various masks for radar data based on model data. More...

#include "../include/RadMask.h"

Public Member Functions

 RadMask ()
 
 ~RadMask ()
 
int init ()
 
int setModel (const char *mod)
 
int setForeHour (int val)
 
int useHdrFile (bool val)
 
int getDate (Date &rdate)
 
int setDomain (DomainVal &dv)
 
int setDomain (Domain &dom)
 
int getGrids (Filename &filename)
 
int getGrids (Date &date)
 
int getGrids (const char *file)
 
int getGrids ()
 
float getTSfc (EarthPoint &ept)
 
float getRSfc (EarthPoint &ept)
 
float getT0 (EarthPoint &ept)
 
float getT60 (EarthPoint &ept)
 
float getT150 (EarthPoint &ept)
 
float getR150 (EarthPoint &ept)
 
float getTSfc (int i, int j)
 
float getRSfc (int i, int j)
 
float getT0 (int i, int j)
 
float getT60 (int i, int j)
 
float getT150 (int i, int j)
 
float getR150 (int i, int j)
 
int getWinterFlag (float tsfc, float t60, float t150)
 
int getWinterFlag (int i, int j)
 
int getWinterFlag (EarthPoint &ept)
 
int getWinter (Grid &mask_grid)
 
int getSiteFilter (EarthPoint &ept)
 
int print ()
 

Detailed Description

This class sets up various masks for radar data based on model data.

Author
Dan Vietor

Constructor & Destructor Documentation

◆ RadMask()

RadMask::RadMask ( )

Constructor. Sets up hash table.

References init().

◆ ~RadMask()

RadMask::~RadMask ( )

Destructor

Member Function Documentation

◆ getDate()

int RadMask::getDate ( Date rdate)

Gets the file date \retal date Date

◆ getGrids() [1/4]

int RadMask::getGrids ( )

Gets the model data for latest available model run

References getGrids(), and WXP::ModelSpec::getName().

Referenced by getGrids(), getGrids(), getGrids(), and getWinter().

◆ getGrids() [2/4]

int RadMask::getGrids ( const char *  file)

Gets the model data

Parameters
fileThe file name

References getGrids(), and WXP::ModelSpec::getName().

◆ getGrids() [3/4]

int RadMask::getGrids ( Date date)

Gets the model data for a specific date. Uses model specification to determine filename.

Parameters
dateThe GRIB file date

References getGrids(), WXP::Filename::getName(), WXP::ModelSpec::getName(), WXP::Wxp::outMessage(), WXP::Filename::setFile(), and WXP::Filename::setNameConv().

◆ getGrids() [4/4]

int RadMask::getGrids ( Filename filename)

◆ getR150() [1/2]

float WXP::RadMask::getR150 ( EarthPoint ept)
inline

Returns 150mb AG humidity for a location

References WXP::Grid::getValue().

◆ getR150() [2/2]

float WXP::RadMask::getR150 ( int  i,
int  j 
)
inline

Returns 150mb AG humidity for a gridpoint

References WXP::Grid::getValue().

◆ getRSfc() [1/2]

float WXP::RadMask::getRSfc ( EarthPoint ept)
inline

Returns surface humidity for a location

References WXP::Grid::getValue().

◆ getRSfc() [2/2]

float WXP::RadMask::getRSfc ( int  i,
int  j 
)
inline

Returns surface humidity for a gridpoint

References WXP::Grid::getValue().

◆ getSiteFilter()

int RadMask::getSiteFilter ( EarthPoint ept)

Computes level of filtering to do to eliminate AP

Parameters
eptLocation to compute
Returns
A number from 0 (least) to 6 (most) to filter

References WXP::Convert::CtoK(), WXP::Calc::dewTemp(), WXP::Grid::getValue(), WXP::Convert::KtoC(), WXP::EarthPoint::lat, WXP::EarthPoint::lon, and WXP::Wxp::outDebug().

◆ getT0() [1/2]

float WXP::RadMask::getT0 ( EarthPoint ept)
inline

Returns 0mb AG temperature for a location

References WXP::Grid::getValue().

◆ getT0() [2/2]

float WXP::RadMask::getT0 ( int  i,
int  j 
)
inline

Returns 0mb AG temperature for a gridpoint

References WXP::Grid::getValue().

◆ getT150() [1/2]

float WXP::RadMask::getT150 ( EarthPoint ept)
inline

Returns 150mb AG temperature for a location

References WXP::Grid::getValue().

◆ getT150() [2/2]

float WXP::RadMask::getT150 ( int  i,
int  j 
)
inline

Returns 150mb AG temperature for a gridpoint

References WXP::Grid::getValue().

◆ getT60() [1/2]

float WXP::RadMask::getT60 ( EarthPoint ept)
inline

Returns 60mb AG temperature for a location

References WXP::Grid::getValue().

◆ getT60() [2/2]

float WXP::RadMask::getT60 ( int  i,
int  j 
)
inline

Returns 60mb AG temperature for a gridpoint

References WXP::Grid::getValue().

◆ getTSfc() [1/2]

float WXP::RadMask::getTSfc ( EarthPoint ept)
inline

Returns surface temperature for a location

References WXP::Grid::getValue().

◆ getTSfc() [2/2]

float WXP::RadMask::getTSfc ( int  i,
int  j 
)
inline

Returns surface temperature for a gridpoint

References WXP::Grid::getValue().

◆ getWinter()

int RadMask::getWinter ( Grid mgrid)

◆ getWinterFlag() [1/3]

int RadMask::getWinterFlag ( EarthPoint ept)

Computes the winter mask flag

Parameters
eptThe location
Returns
0=rain, 1=mixed, 2=snow

References WXP::Grid::getValue(), and getWinterFlag().

◆ getWinterFlag() [2/3]

int RadMask::getWinterFlag ( float  tsfc,
float  t60,
float  t150 
)

Computes the winter mask flag

Parameters
tsfcSurface temperature
t60Temperature 60 mb above surface
t150Temperature 150 mb above surface
Returns
0=rain, 1=mixed, 2=snow

References WXP::Const::MISS.

Referenced by getWinter(), getWinterFlag(), and getWinterFlag().

◆ getWinterFlag() [3/3]

int RadMask::getWinterFlag ( int  i,
int  j 
)

Computes the winter mask flag

Parameters
iI grid location
jJ grid location
Returns
0=rain, 1=mixed, 2=snow

References WXP::Grid::getValue(), and getWinterFlag().

◆ init()

int RadMask::init ( )

Initializes the object

References WXP::StrLib::copy(), WXP::DomainTool::decode(), WXP::Const::MISS, and WXP::Domain::set().

Referenced by RadMask().

◆ print()

int RadMask::print ( )

Prints the model grids

References WXP::Grid::print().

◆ setDomain() [1/2]

int RadMask::setDomain ( Domain dom)

Sets the domain that the model data is fit to. It is the domain of the mask grid

Parameters
domDomain values

◆ setDomain() [2/2]

int RadMask::setDomain ( DomainVal dv)

Sets the domain that the model data is fit to. It is the domain of the mask grid

Parameters
dvDomain values

References WXP::Domain::set().

◆ setForeHour()

int WXP::RadMask::setForeHour ( int  val)
inline

Sets the forecast hour used to read in grids

Referenced by WXP::RcmDecode::decode().

◆ setModel()

int RadMask::setModel ( const char *  str)

Sets the model name

Parameters
strModel name

References WXP::StrLib::copy().

◆ useHdrFile()

int WXP::RadMask::useHdrFile ( bool  val)
inline

Sets the forecast hour used to read in grids


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