ParticleFactory Class Reference

Generates the particles. More...

#include <ParticleFactory.h>

List of all members.

Public Member Functions
	ParticleFactory (vl::ref< vl::Image > volume, vl::ref< vl::Image > gradient, vl::ref< vl::Image > curvature, float depth, float magThresh, int radius, int maxParticles)
	~ParticleFactory (void)
void	setDepth (float d)
void	setMagnitudeThreshold (float t)
void	setRadius (int r)
void	setMaxParticles (int p)
float	getDepth () const
float	getMagnitudeThreshold () const
int	getRadius () const
int	getMaxParticles () const
void	build ()
	Builds the particles.
std::vector< std::shared_ptr < Particle > >	getParticleList () const
	Getters for the particles.

Private Member Functions
bool	containsParticle (int x, int y, int z) const

Private Attributes
vl::ref< vl::Image >	_volume
	Stores the volume.
vl::ref< vl::Image >	_gradient
	Stores the gradients.
vl::ref< vl::Image >	_curvature
	Stores the curvatures.
float	_depth
	Stores the depth level.
float	_magnitudeThreshold
	Stores the magnitude threshold.
int	_radius
	Stores the radius.
int	_maxParticles
	Stores the maximum number of particles.
std::vector< std::shared_ptr < Particle > >	_particles
	Stores the list of particles generated.
vl::ref< vl::Image >	_particleImage
	3D array bitmap

---

Detailed Description

Generates the particles.

---

Constructor & Destructor Documentation

ParticleFactory::ParticleFactory	(	vl::ref< vl::Image >	volume,
		vl::ref< vl::Image >	gradient,
		vl::ref< vl::Image >	curvature,
		float	depth,
		float	magThresh,
		int	radius,
		int	maxParticles
	)

  Initializes the factory

Parameters:

volume	is the volume-image
gradient	is the gradient image
curvature	is the curvature image
depth	is the depth level on which the particles should be spawned
magThresh	is a threshold on the gradient magnitude. Only if the gradient is above this threshold particles will be spawned.
radius	is the neighbor-radius in which no other particle should be initialized
maxParticles	is the maximum number of particles which should be generated

ParticleFactory::~ParticleFactory

(

void

)

---

Member Function Documentation

void ParticleFactory::build

(

)

Builds the particles.

bool ParticleFactory::containsParticle ( int  x, int  y, int  z  ) const

private

float ParticleFactory::getDepth ( ) const

inline

float ParticleFactory::getMagnitudeThreshold ( ) const

inline

int ParticleFactory::getMaxParticles ( ) const

inline

std::vector<std::shared_ptr<Particle> > ParticleFactory::getParticleList ( ) const

inline

Getters for the particles.

int ParticleFactory::getRadius ( ) const

inline

void ParticleFactory::setDepth ( float  d )

inline

void ParticleFactory::setMagnitudeThreshold ( float  t )

inline

void ParticleFactory::setMaxParticles ( int  p )

inline

void ParticleFactory::setRadius ( int  r )

inline

---

Member Data Documentation

vl::ref<vl::Image> ParticleFactory::_curvature

private

Stores the curvatures.

float ParticleFactory::_depth

private

Stores the depth level.

vl::ref<vl::Image> ParticleFactory::_gradient

private

Stores the gradients.

float ParticleFactory::_magnitudeThreshold

private

Stores the magnitude threshold.

int ParticleFactory::_maxParticles

private

Stores the maximum number of particles.

vl::ref<vl::Image> ParticleFactory::_particleImage

private

3D array bitmap

std::vector<std::shared_ptr<Particle> > ParticleFactory::_particles

private

Stores the list of particles generated.

int ParticleFactory::_radius

private

Stores the radius.

See also:

ParticleFactory::PraticleFactory

vl::ref<vl::Image> ParticleFactory::_volume

private

Stores the volume.

---

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

• ParticleFactory.h
• ParticleFactory.cpp