PixCluster Class Reference

Cluster of camera pixels. More...

#include <Cluster.h>

Public Member Functions
void	AddCluster (PixCluster *aCluster)
	Adds the input cluster into this cluster. More...
void	AddPixel (const int aAmplitude, const int aPixIndexY, const int aPixIndexZ)
	Adds a pixel to the cluster. More...
int	GetSize (void)
	Returns the number of pixels in the cluster. More...
bool	TestCluster (PixCluster *aCluster)
	Tests whether a cluster is contiguous to this cluster. More...
bool	TestPixel (const int aPixIndexY, const int aPixIndexZ)
	Tests whether a pixel belongs to this cluster. More...
Constructors and destructors
	PixCluster (void)
	PixCluster class constuctor. More...
virtual	~PixCluster (void)
	PixCluster class destructor. More...

Private Attributes
vector< int >	pix_amplitude
	List of pixel amplitudes. More...
vector< int >	pix_index_y
	List of pixel Y indices. More...
vector< int >	pix_index_z
	List of pixel Z indices. More...

Detailed Description

Cluster of camera pixels.

This class describes a cluster of camera pixels. A cluster is a list of pixels.

Author

Florent Robinet

Constructor & Destructor Documentation

PixCluster()

PixCluster::PixCluster

(

void

)

PixCluster class constuctor.

~PixCluster()

PixCluster::~PixCluster ( void  )

virtual

PixCluster class destructor.

Member Function Documentation

AddCluster()

void PixCluster::AddCluster

(

PixCluster *

aCluster

)

Adds the input cluster into this cluster.

The pixels of the input cluster are added to this cluster.

Parameters

[in]

aCluster

Cluster to add.

AddPixel()

void PixCluster::AddPixel	(	const int	aAmplitude,
		const int	aPixIndexY,
		const int	aPixIndexZ
	)

Adds a pixel to the cluster.

Parameters

[in]	aAmplitude	Pixel amplitude.
[in]	aPixIndexY	Y pixel index.
[in]	aPixIndexZ	Z pixel index.

GetSize()

int PixCluster::GetSize ( void  )

inline

Returns the number of pixels in the cluster.

TestCluster()

bool PixCluster::TestCluster

(

PixCluster *

aCluster

)

Tests whether a cluster is contiguous to this cluster.

Returns

true if it is,false otherwise.

Parameters

[in]

aCluster

Cluster to test.

TestPixel()

bool PixCluster::TestPixel	(	const int	aPixIndexY,
		const int	aPixIndexZ
	)

Tests whether a pixel belongs to this cluster.

@detail The input pixel, defined by its coordinates, is tested against all the pixels in the cluster. If the pixel position is contiguous (8 surrounding pixels) to one of the pixel in the cluster, this function returns true. It returns false otherwise.

Parameters

[in]	aPixIndexY	Y pixel index.
[in]	aPixIndexZ	Z pixel index.

Member Data Documentation

pix_amplitude

vector<int> PixCluster::pix_amplitude

private

List of pixel amplitudes.

pix_index_y

vector<int> PixCluster::pix_index_y

private

List of pixel Y indices.

pix_index_z

vector<int> PixCluster::pix_index_z

private

List of pixel Z indices.

---

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

• src/Analysis/Cluster.h
• src/Analysis/Cluster.cc