IO::Output Class Reference

#include <Output.h>

List of all members.

Public Member Functions
	Output (string resultsDirectory)
	~Output (void)
void	writeResultsStart (string description, string date, vector< float > &rLambda)
void	writeFloatList (std::vector< float > &rList, std::string listName, int upTo)
void	writeResultsEnd ()
void	writeImageResults (int resX, int resY, int nrLambda, double pixelSizeX, double pixelSizeY, double *pRefl, double *pReflP, double *pReflS)
void	writeARSResults (int nrTheta, int nrPhi, int nrLambda, double *pRefl, double *pReflP, double *pReflS, double *pReflSurf, double *pReflSurfP, double *pReflSurfS)
void	writeElrephoResults (const std::vector< float > &rLambdas, double *pReflTot)
void	writeARSGlobeResults (int nrTheta, int nrPhi, int nrLambda, double *pRefl)
void	writePLRResults (int nrDistances, double distance, int nrLambda, int *pReflectance)
void	writeScatEventResults (int nrDistances, double distance, int nrLambda, int *pReflectance)

---

Detailed Description

This class is responsible for formatting output. If the macro ENABLEHDF is defined HDF will be used as output for detector results, if not defined output will be binary.

Author:

Mikael Lindquister

Version:

2009-01-09

---

Constructor & Destructor Documentation

Output::Output

(

string

resultsDirectory

)

Constructor.

Parameters:

resultsDirectory

the directory where all results will be placed. If it does not exist it will be created.

Output::~Output

(

void

)

---

Member Function Documentation

void Output::writeARSGlobeResults	(	int	nrTheta,
		int	nrPhi,
		int	nrLambda,
		double *	pRefl
	)

This function writes ARS Globe detector results to XML file and a binary or HDF file.

Parameters:

nrTheta	number of theta angles.
nrPhi	number of phi angles.
pReflectance	pointer to an array containing reflectance results.

Here is the caller graph for this function:

void Output::writeARSResults	(	int	nrTheta,
		int	nrPhi,
		int	nrLambda,
		double *	pRefl,
		double *	pReflP,
		double *	pReflS,
		double *	pReflSurf,
		double *	pReflSurfP,
		double *	pReflSurfS
	)

This function writes ARS detector results to the results XML file and a binary or HDF file.

Parameters:

nrTheta	number of theta angles.
nrPhi	number of phi angles.
pRefl	pointer to an array containing reflectance values.
pReflP	pointer to an array containing reflectance values for p-polarized light.
pReflS	pointer to an array containing reflectance values for s-polarized light.
pReflSurf	pointer to an array containing reflectance values for reflection from first surface.
pReflSurfP	pointer to an array containing reflectance values for reflection from first surface for p-polarized light.
pReflSurfS	pointer to an array containing reflectance values for reflection from first surface for p-polarized light.

Here is the caller graph for this function:

void Output::writeElrephoResults	(	const std::vector< float > &	rLambdas,
		double *	pReflTot
	)

This function writes elrepho detector results to the XML results file and to either a binary or HDF file.

Parameters:

rLambdas	reference to an array containing the simulation wavelengths.
pReflTot	pointer to an array containing the reflectance values.

Here is the caller graph for this function:

void Output::writeFloatList	(	std::vector< float > &	rList,
		std::string	listName,
		int	upTo
	)

Writes a list XML element to the results XML file.

Parameters:

rList	the list of values that should be used.
listName	name of the list.
upTo	values up to index upTo will be printed.

Here is the caller graph for this function:

void Output::writeImageResults	(	int	resX,
		int	resY,
		int	nrLambda,
		double	pixelSizeX,
		double	pixelSizeY,
		double *	pRefl,
		double *	pReflP,
		double *	pReflS
	)

This function writes image detector results, XML part of the results will be written to the results XML file. The actual image data will be written to either a binary file or a HDF file.

Parameters:

resX	resolution of the image in the x direction.
resY	resolution of the image in the y direction.
nrLambda	number of simulation wavelengths.
pixelSizeX	size of a pixel in the x direction (microns).
pixelSizeY	size of a pixel in the y direction (microns).
pRefl	pointer to an array containing the reflectance values.
pReflP	pointer to an array containing the reflectance values for p-polarized light.
pReflS	pointer to an array containing the reflectance values for s-polarized light.

Here is the caller graph for this function:

void Output::writePLRResults	(	int	nrDistances,
		double	distance,
		int	nrLambda,
		int *	pReflectance
	)

This function writes PLR Detector results to the results XML file and data to a binary or HDF file.

Parameters:

nrDistances	number of path lengths the detector measures.
nrLambda	number of simulation wavelengths.
distance	distance of path lengths.
pReflectance	array containing reflectance values. Is size nrLambda*nrDistances

Here is the caller graph for this function:

void Output::writeResultsEnd

(

)

Writes the ending of the results XML file should be called after all the detectors have been processed.

Here is the caller graph for this function:

void Output::writeResultsStart	(	string	description,
		string	date,
		vector< float > &	rLambda
	)

Writes the first part of the results XML file, should be called first.

Parameters:

description	the simulation description.
date	date of the simulation.

Here is the caller graph for this function:

void Output::writeScatEventResults	(	int	nrDistances,
		double	distance,
		int	nrLambda,
		int *	pReflectance
	)

Here is the caller graph for this function:

---

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

• OpenPaperOpt/Output.h
• OpenPaperOpt/Output.cpp