This class plot satellite imagery. More...

#include "../include/ImagePlot.h"

Inheritance diagram for WXP::ImagePlot:

Public Types
enum	Type { UNK , IMAGE , GRIB , GRID }

Public Member Functions
	ImagePlot (const char *param)

int	init ()

int	setParam (const char *str)

int	setPath (const char *path)

int	setFile ()

int	setInput (const char *type)

int	setNameConv (const char *type)

int	setType (const char *type)

int	setFilename ()

int	setFilename (const char *file)

int	setFilename (Date &date)

int	setFilename (Date &date, const char *param)

int	setModel (const char *str)

int	setForeTime (const char *fore)

int	getDate (Date &date)

int	getNumFrames ()

int	getInitDate (Date &date)

int	getDateOffset ()

int	getLoopType ()

int	getDomain (Domain &domain)

int	setColorTable (const char *str)

int	setColorFill (const char *str)

int	setMap (bool val)

int	getSync ()

int	drawImage (Plot &plot, Image &rimage)

int	draw (Plot &plot)

int	draw (Plot &plot, const char *filename)

int	draw (Plot &plot, Image &rimage)

void	callback (const char ev_str, const char ev_data, const void *data)

int	print ()

virtual int	init ()=0

virtual int	getDomain (Domain &domain)=0

virtual int	setFile ()=0

virtual int	setInput (const char *type)=0

virtual int	setNameConv (const char *name)=0

virtual int	setFilename ()=0

virtual int	setFilename (const char *file)=0

virtual int	setFilename (Date &date)=0

virtual int	setFilename (Date &date, const char *param)=0

virtual int	setForeTime (const char *fore)=0

virtual int	setParam (const char *str)=0

virtual int	getDate (Date &date)=0

virtual int	getLoopType ()=0

virtual int	getInitDate (Date &date)=0

virtual int	getDateOffset ()=0

virtual int	getNumFrames ()=0

virtual int	getSync ()=0

virtual int	draw (Plot &plot)=0

virtual int	print ()=0

virtual void	callback (const char ev_str, const char ev_data, const void *data)=0

Additional Inherited Members
Static Public Attributes inherited from WXP::Drawing
static const int	LOOP_NONE = 0

static const int	LOOP_DATE = 1

static const int	LOOP_FORE = 2

Detailed Description

This class plot satellite imagery.

Author: Dan Vietor

Member Function Documentation

◆ callback()

void ImagePlot::callback	(	const char *	ev_str,
		const char *	ev_data,
		const void *	data
	)

virtual

The event callback

Parameters

ev_str	String containing description of event
ev_data	Event specific data
data	User specific data

Implements WXP::Listener.

References WXP::StrLib::equal(), WXP::Image::getPixel(), WXP::EarthPoint::set(), and WXP::Image::tran().

◆ draw()

int ImagePlot::draw ( Plot & plot )

virtual

Method for plotting the actual data

Parameters

plot	The plot class specifying window and parameters for plotting

Implements WXP::Drawing.

References WXP::FloatArray::add(), draw(), WXP::StrLib::equal(), WXP::String::get(), WXP::Range::getMin(), WXP::Filename::getName(), WXP::Range::getRange(), WXP::Grid::getRange(), WXP::Filename::getType(), WXP::GridWxpFile::isOpen(), WXP::ImageFile::isOpen(), WXP::Const::MISS, WXP::GridWxpFile::open(), WXP::ImageFile::open(), WXP::Wxp::outMessage(), WXP::Wxp::outWarning(), WXP::FileAttr::READ, WXP::GridWxpFile::read(), WXP::ImageFile::read(), WXP::GridSpec::set(), WXP::Filename::setFile(), WXP::Filename::setFixDate(), and WXP::String::valid().

Referenced by draw().

◆ drawImage()

int ImagePlot::drawImage	(	Plot &	plot,
		Image &	rimage
	)

Sets up and draws just the image to the window

Parameters

plot	The plot object
rimage	The image to display

References WXP::ImageTool::addColor(), WXP::ImageMath::clip(), WXP::String::get(), WXP::Plot::getColorMap(), WXP::Domain::getLimits(), WXP::Domain::getNx(), WXP::Domain::getNy(), WXP::Domain::getProj(), WXP::Const::MISS, WXP::ColorFile::read(), WXP::ImageMath::remap(), WXP::GeomBox::set(), WXP::Plot::setColorMap(), WXP::Image::setPixAve(), WXP::String::valid(), WXP::StrLib::valid(), WXP::Rect::xmin, and WXP::Rect::ymax.

◆ getDate()

int ImagePlot::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

References WXP::Filename::getDate().

◆ getDateOffset()

int ImagePlot::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

◆ getDomain()

int ImagePlot::getDomain ( Domain & domain )

virtual

A method for getting a default domain from the data. This is handy for data types that are for a specific domain like NIDS data.

Return values

domain Default domain

Implements WXP::Drawing.

References WXP::DomainTool::decode(), WXP::StrLib::equal(), WXP::Grid::getDomain(), WXP::Filename::getName(), WXP::Filename::getType(), WXP::GridFile::isOpen(), WXP::GridWxpFile::isOpen(), WXP::ImageFile::isOpen(), WXP::GridWxpFile::open(), WXP::ImageFile::open(), WXP::FileAttr::READ, WXP::GridFile::read(), WXP::GridWxpFile::read(), and WXP::ImageFile::read().

◆ getInitDate()

int ImagePlot::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

References WXP::Filename::getDate(), and WXP::Filename::setFile().

◆ getLoopType()

int ImagePlot::getLoopType ( )

virtual

Gets the available loop types

Returns: Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE, WXP::Drawing::LOOP_FORE, WXP::Drawing::LOOP_NONE, and WXP::String::occurs().

◆ getNumFrames()

int ImagePlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns: Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

◆ getSync()

int WXP::ImagePlot::getSync ( )

inlinevirtual

Tells whether an object should be used to sync other to it

Returns: Number of frames

Implements WXP::Drawing.

◆ init()

int ImagePlot::init ( )

virtual

Initializes object

Implements WXP::Drawing.

References WXP::Const::MISS, WXP::String::set(), WXP::Timezone::set(), setFile(), setForeTime(), setModel(), setParam(), and setType().

◆ print()

int ImagePlot::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColorFill()

int ImagePlot::setColorFill ( const char * str )

Sets the color fill parameters

Parameters

str	Color fill string

References WXP::String::set().

Referenced by WXP::MdrPlot::init(), WXP::RcmPlot::init(), WXP::RadPlot::setColorFill(), and setParam().

◆ setColorTable()

int ImagePlot::setColorTable ( const char * str )

Sets the color table parameters

Parameters

str	Color table parameter

References WXP::String::set().

Referenced by WXP::RadPlot::setColorTable(), and setParam().

◆ setFile()

int ImagePlot::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References WXP::ModelSpec::getName(), setInput(), setNameConv(), WXP::Filename::setNumFiles(), and WXP::Filename::setType().

Referenced by init().

◆ setFilename() [1/4]

int ImagePlot::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFile().

Referenced by setParam().

◆ setFilename() [2/4]

int ImagePlot::setFilename ( const char * str )

virtual

Sets the filename to be used.

Parameters

str	The filename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [3/4]

int ImagePlot::setFilename ( Date & date )

virtual

Sets the filename to use based on a specific date

Parameters

date	Date to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [4/4]

int ImagePlot::setFilename	(	Date &	date,
		const char *	param
	)

virtual

Sets the filename to be used.

Parameters

date	The initial date
param	The parameters to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setForeTime()

int ImagePlot::setForeTime ( const char * str )

virtual

Sets the forecast time to be used.

Parameters

str	The forecast time

Implements WXP::Drawing.

References WXP::String::append(), and WXP::String::set().

Referenced by init(), and setParam().

◆ setInput()

int ImagePlot::setInput ( const char * type )

virtual

Sets the input file type

Parameters

type	The optional file type

Implements WXP::Drawing.

References WXP::Filename::setType().

Referenced by setFile(), and setParam().

◆ setModel()

int ImagePlot::setModel ( const char * str )

Sets the model type to be used.

Parameters

str	The model name

References WXP::StrLib::copy(), WXP::ModelSpec::getName(), WXP::ModelSpec::set(), and WXP::Filename::setNameConv().

Referenced by init(), and setParam().

◆ setNameConv()

int ImagePlot::setNameConv ( const char * name )

virtual

Sets the file name convention

Parameters

name	The optional file type

Implements WXP::Drawing.

References WXP::ModelSpec::getName(), WXP::Filename::setNameConv(), and WXP::StrLib::valid().

Referenced by setFile(), and setParam().

◆ setParam()

int ImagePlot::setParam ( const char * str )

virtual

Sets specific parameters for the plot given a string

Parameters

str	String specifying parameters

Implements WXP::Drawing.

References WXP::StrLib::copy(), WXP::Strings::equal(), WXP::Strings::getFloat(), WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), WXP::String::set(), WXP::Timezone::set(), setColorFill(), setColorTable(), setFilename(), setForeTime(), setInput(), setModel(), and setNameConv().

Referenced by init(), WXP::MdrPlot::setParam(), WXP::RadPlot::setParam(), and WXP::RcmPlot::setParam().

◆ setType()

int ImagePlot::setType ( const char * str )

Sets the product type

Parameters

str	Product type

References WXP::StrLib::copy().

Referenced by init().

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

ImagePlot.h
ImagePlot.cc

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ callback()

◆ draw()

◆ drawImage()

◆ getDate()

◆ getDateOffset()

◆ getDomain()

◆ getInitDate()

◆ getLoopType()

◆ getNumFrames()

◆ getSync()

◆ init()

◆ print()

◆ setColorFill()

◆ setColorTable()

◆ setFile()

◆ setFilename() [1/4]

◆ setFilename() [2/4]

◆ setFilename() [3/4]

◆ setFilename() [4/4]

◆ setForeTime()

◆ setInput()

◆ setModel()

◆ setNameConv()

◆ setParam()

◆ setType()