WXP::NidsImage Class Reference

This class converts and merges NIDS data into an Image. More...

#include "../include/NidsImage.h"

Public Types
enum	Type { BREF , RALA }
enum	ScanType { RADIAL , RASTOR }

Public Member Functions
	NidsImage ()
	NidsImage (const char *str)
int	init ()
int	setParam (const char *str)
int	setClutterRad (int crad)
int	setRamp (int cut, int len)
int	getRampCut ()
int	getRampLen ()
int	setThres (FloatArray &array)
int	setThres (const char *str)
int	setClearAirUse (int val)
int	getClearAirUse ()
int	getMode ()
int	getIndex (float val)
int	setup (Image &image)
int	readSite (Filename &filename)
int	addSite (Image &image)
int	addSite (Filename &filename, Image &image)
int	setImage (Filename &filename, Image &image)
int	applyMask (Image &image, Grid &mask)
int	print ()
int	printSite ()

Detailed Description

This class converts and merges NIDS data into an Image.

Author

Dan Vietor

Constructor & Destructor Documentation

NidsImage() [1/2]

NidsImage::NidsImage

(

)

Constructor

References init().

NidsImage() [2/2]

NidsImage::NidsImage

(

const char *

str

)

Constructor. Sets up parameters

Parameters

str	Parameters

References init(), and setParam().

Member Function Documentation

addSite() [1/2]

int NidsImage::addSite	(	Filename &	filename,
		Image &	image
	)

Reads in and adds the site to the image

Parameters

filename	The input NIDS image
image	The output image

References addSite(), and readSite().

addSite() [2/2]

int NidsImage::addSite

(

Image &

image

)

Adds the site data from the readSite call to the image

Parameters

image

The image

References WXP::Domain::adjustDir(), WXP::Image::allocData(), WXP::DateTool::createLabel(), WXP::Const::DRC, WXP::Image::getDx(), getIndex(), WXP::Domain::getNx(), WXP::Domain::getNy(), WXP::Image::getPixel(), WXP::Wxp::isDebug(), WXP::NidsInfo::lat, WXP::NidsInfo::lon, WXP::Const::MISS, WXP::NidsData::mode, WXP::Domain::print(), WXP::GridPoint::set(), WXP::EarthPoint::set(), WXP::Point::set(), WXP::Image::set(), WXP::Image::setPixel(), WXP::Domain::tran(), WXP::Image::tran(), WXP::NidsData::type, WXP::Point::x, and WXP::Point::y.

Referenced by addSite().

applyMask()

int NidsImage::applyMask	(	Image &	image,
		Grid &	mask
	)

Applies the winter mask grid

Parameters

image	The input image
mask	The winter mask (0=rain, 1=freezing rain, 2=snow)

References WXP::Image::getVal(), WXP::Grid::getValue(), WXP::GridPoint::set(), WXP::Image::setPixel(), WXP::Grid::tran(), and WXP::Image::tran().

getIndex()

int NidsImage::getIndex

(

float

val

)

Returns pixel index based on NIDS value

Parameters

val

Value

Returns

Pixel index

Referenced by addSite(), and setImage().

getMode()

int NidsImage::getMode

(

)

Returns the mode of the current site

Returns

The radar mode

References WXP::NidsInfo::mode.

init()

int NidsImage::init

(

)

Initializes the class

References WXP::Const::MISS, setParam(), and setThres().

Referenced by NidsImage(), and NidsImage().

print()

int NidsImage::print

(

)

Prints the object parameters

printSite()

int NidsImage::printSite

(

)

Prints the current site information

References WXP::NidsInfo::print().

readSite()

int NidsImage::readSite

(

Filename &

filename

)

Reads in NIDS data from a specific file and stores it for processing

Parameters

filename

File to read in and store

References WXP::NidsInfo::code, WXP::Filename::getName(), WXP::NidsFile::isOpen(), WXP::NidsInfo::mode, WXP::Wxp::outMessage(), and WXP::Wxp::outWarning().

Referenced by addSite().

setClearAirUse()

int NidsImage::setClearAirUse

(

int

val

)

Specifies whether a site in clear air mode is to be added to the image

Parameters

val	1=use clear air sites

setImage()

int NidsImage::setImage	(	Filename &	filename,
		Image &	image
	)

Converts a single NIDS product to an image

Parameters

filename

The NIDS file as input

Return values

image

The output image

References WXP::Domain::adjustDir(), WXP::Image::allocData(), WXP::NidsRadial::ang0, WXP::NidsInfo::code, WXP::DateTool::createLabel(), WXP::Const::DRC, WXP::Image::getDx(), getIndex(), WXP::Filename::getName(), WXP::Domain::getNx(), WXP::Domain::getNy(), WXP::Image::getPixel(), WXP::NidsFile::isOpen(), WXP::NidsInfo::lat, WXP::NidsInfo::lon, WXP::Const::MISS, WXP::NidsInfo::mode, WXP::Wxp::outMessage(), WXP::Wxp::outWarning(), WXP::NidsFile::readRadial(), WXP::NidsFile::readRun(), WXP::NidsRun::run, WXP::Domain::set(), WXP::GridPoint::set(), WXP::EarthPoint::set(), WXP::Point::set(), WXP::Image::set(), WXP::Image::setPixel(), WXP::Domain::tran(), WXP::Image::tran(), WXP::NidsRun::val, WXP::Point::x, and WXP::Point::y.

setParam()

int NidsImage::setParam

(

const char *

str

)

Specifies parameters

Parameters

str	Parameters

References WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::iequal(), and WXP::Strings::scanf().

Referenced by init(), and NidsImage().

setRamp()

int NidsImage::setRamp	(	int	cut,
		int	len
	)

Sets up ramp values. This is a linear ramp to remove values that are less than the ramp.

Parameters

cut	Maximum cutoff value which is at radar site
len	Distance from site when cutoff becomes 0

setThres() [1/2]

int NidsImage::setThres

(

const char *

str

)

Sets the threshold values for the image

Parameters

str	The threshold values

References WXP::FloatArray::set(), and setThres().

setThres() [2/2]

int NidsImage::setThres

(

FloatArray &

array

)

Sets the threshold values for the image

Parameters

str	The threshold values

References WXP::FloatArray::get(), WXP::FloatArray::getNum(), WXP::Wxp::outDebug(), and WXP::Wxp::outWarning().

Referenced by init(), and setThres().

---

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

• NidsImage.h
• NidsImage.cc