ImageArithmaticCube Class Reference

#include <ImageArithmaticCube.h>

Inheritance diagram for ImageArithmaticCube:

Detailed Description

Definition at line 13 of file ImageArithmaticCube.h.


Public Member Functions
	ImageArithmaticCube (int x1, int y1, int w1, int h1)
	ImageArithmaticCube is a specialized ImageCube that handles arithmatic between layers.
	~ImageArithmaticCube ()
	~ImageArithmaticCube() Destroys the ImageArithmaticCube
void	setEquation (std::string eq)
	void setEquation(std::string eq) std::string eq - the equation to be executed on this cube Sets the equation that will be used for calculations.
std::vector< double > *	calculateLayer ()
	std::vector<double> calculateLayer() Preforms the specified calculation on the cube, and returns the resulting layer.
bool	calculate ()
	Performs the specified calculation on the cube, without returning the resulting layer.
std::vector< double > *	getCalculatedLayer ()
	std::vector<double> getCalculatedLayer() Returns the calculated layer, but does no calculations.
std::vector< double > *	getValuesOf (int z)
	int z - z index (band or layer) returns the value for layer (band) z
double	getValueAtLocal (int x, int y, int z)
	Uses a local reference (i.e.
double	getValueAtOverall (int x, int y, int z)
	Location is specified in terms of the original image.
ThreeDPoint	getLowestPoint ()
ThreeDPoint	getHighestPoint ()
bool	addBand (std::vector< double > *vals)
	adds a layer to the end of the current "stack" of layers
bool	addBand (std::vector< double > *vals, int layernum)
	add a layer in to a specific location
bool	addBands (std::vector< double > *vals)
	adds several layers in consecutive order.
Protected Attributes
Parser	parser
std::vector< double > *	calculatedLayer
	the results layer
bool	eqset
	true if the equation has been set for this Cube
ImageInterface *	image
int	width
	width of the cube
int	height
	height of the cube
int	layers
	number of layers in the cube
ThreeDPoint	lowestPoint
	where (0,0,0) falls in the original image
ThreeDPoint	highestPoint
	where the opposite corner falls in original image
std::vector< Layer >	theCube
	holds all the layers, effectivly the cube

Constructor & Destructor Documentation

ImageArithmaticCube::ImageArithmaticCube	(	int	x1,
		int	y1,
		int	w1,
		int	h1
	)

ImageArithmaticCube is a specialized ImageCube that handles arithmatic between layers.

It uses muParser to parse and deal with the equation. Info on muParser can be found in it's folder, or at http://muparser.sourceforge.net/.

Author:: Erica Liszewski 2006-04-20 ImageArithmaticCube(int x1, int y1, int w1, int h1) int x1 - the lowest x value this cube covers int y1 - the lowest y value this cube covers int w1 - the width (in pixels) of this cube int h1 - the height (in pixels) of this cube Creates an ImageArithmaticCube with the specified dimesions.

Definition at line 4 of file ImageArithmaticCube.cpp.

References calculatedLayer, and eqset.

ImageArithmaticCube::~ImageArithmaticCube ( )

~ImageArithmaticCube() Destroys the ImageArithmaticCube

Definition at line 11 of file ImageArithmaticCube.cpp.

Member Function Documentation

void ImageArithmaticCube::setEquation ( std::string eq )

void setEquation(std::string eq) std::string eq - the equation to be executed on this cube Sets the equation that will be used for calculations.

Definition at line 18 of file ImageArithmaticCube.cpp.

References eqset, and parser.

Referenced by ImageCalculator::testDriver().

std::vector< double > * ImageArithmaticCube::calculateLayer ( )

std::vector<double> calculateLayer() Preforms the specified calculation on the cube, and returns the resulting layer.

This pointer is creates using new, so it is your responsiblity to see that it's destroyed properly.

Definition at line 24 of file ImageArithmaticCube.cpp.

References calculate(), calculatedLayer, and eqset.

Referenced by ImageCalculator::testDriver().

Here is the call graph for this function:

bool ImageArithmaticCube::calculate ( )

Performs the specified calculation on the cube, without returning the resulting layer.

Returns:: boolean indicating success or failure of calculation

History:: 2006-07-29 dls added return to allow tool to shut down if something went wrong with calculation

Definition at line 36 of file ImageArithmaticCube.cpp.

References calculatedLayer, ImageCube::height, ImageCube::layers, parser, ImageCube::theCube, and ImageCube::width.

Referenced by calculateLayer().

std::vector< double > * ImageArithmaticCube::getCalculatedLayer ( )

std::vector<double> getCalculatedLayer() Returns the calculated layer, but does no calculations.

You must call calculate() first or this will not return anything useful. This is ment for getting the calculated layer if it is needed later in the program after calculate() has been called. If you want to do the calculations and get the resulting layer, use calculateLayer(). The returned pointer is created with new, so it is your responsiblity to see that it is destroyed properly.

Definition at line 76 of file ImageArithmaticCube.cpp.

References calculatedLayer.

std::vector< double > * ImageCube::getValuesOf ( int z ) [inherited]

int z - z index (band or layer) returns the value for layer (band) z

Definition at line 48 of file ImageCube.cpp.

References ImageCube::theCube.