HomogeneousLayer Class Reference

#include <HomogeneousLayer.h>

Inheritance diagram for HomogeneousLayer:

Collaboration diagram for HomogeneousLayer:

List of all members.

Public Member Functions
	HomogeneousLayer ()
	~HomogeneousLayer ()
	HomogeneousLayer (ScatteringParameters *sp, float xmax, float ymax, StructureObject *prevStructureObject, std::vector< float > &rLambda, Fluorescence *fluor)
	HomogeneousLayer (StructureObject *prevStructureObject, float xmax, float ymax, complex_LC refrIndex, int nrLambda)
virtual int	Process (WavePacket &wp, int up_down, int internal) const
complex_LC	mGetRefrIndex (int nbr_lambda) const
Protected Attributes
HomogeneousScatteringMaterial *	mHomogeneousScatteringMaterial

---

Detailed Description

This class represents a homogenous turbid layer.

---

Constructor & Destructor Documentation

HomogeneousLayer::HomogeneousLayer

(

)

HomogeneousLayer::~HomogeneousLayer

(

)

HomogeneousLayer::HomogeneousLayer	(	ScatteringParameters *	sp,
		float	xmax,
		float	ymax,
		StructureObject *	prevStructureObject,
		std::vector< float > &	rLambda,
		Fluorescence *	fluor
	)

Constructor.

Parameters:

sp	pointer to the scattering parameters for this homogeneous layer, these are interpolated before being passed to constructor.
xmax	size of the simulation volume in the x direction.
ymax	size of the simulation volume in the y direction.
prevPO	pointer to the previous paper object.
rLambda	the simulation wavelengths.
fluor	pointer to a fluorescence object containing a preinterpolated fluorescence matrix.

Here is the call graph for this function:

HomogeneousLayer::HomogeneousLayer	(	StructureObject *	prevStructureObject,
		float	xmax,
		float	ymax,
		complex_LC	refrIndex,
		int	nrLambda
	)

Simple constructor for materials without scattering properties other than a refractive index. Typically media over and below simulation volume

Parameters:

refrIndex	the refractive index of the material.
nrLambda	the number of wavelengths to be simulated.
xmax	size of the simulation volume in the x direction.
ymax	size of the simulation volume in the y direction.
prevStructureObject	pointer to the previous paper object.

With this constructor, only the refractive index is set The s, k, and g are not initialised

---

Member Function Documentation

complex_LC HomogeneousLayer::mGetRefrIndex

(

int

nbr

)

const [virtual]

Fetch the effective refractive index of a layer

Parameters:

nbr	wavelength # of the simulated wave packet

See also:

Basesheet2::mGetRefrIndex

Reimplemented from StructureObject.

int HomogeneousLayer::Process	(	WavePacket &	wp,
		int	up_down,
		int	internal
	)		const [virtual]

Process the wp within the object overwritten by child objects

See also:

HomogeneousLayer::Process, Basesheet::Process

HomogeneousLayer is made of a single component Call its Process method

Implements StructureObject.

Here is the call graph for this function:

---

Member Data Documentation

HomogeneousScatteringMaterial* HomogeneousLayer::mHomogeneousScatteringMaterial [protected]

Pointer to the layer's only component

---

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

• OpenPaperOpt/HomogeneousLayer.h
• OpenPaperOpt/HomogeneousLayer.cpp