cWB: wavecluster Class Reference

Definition at line 69 of file cluster.hh.

Public Member Functions
	wavecluster ()

	wavecluster (WSeries< double > &, bool=false)
	param: input WSeries param: true if halo, false if no halo included More...

	wavecluster (const wavecluster &)
	param: value - object to copy from More...

virtual	~wavecluster ()

virtual size_t	append (wavecluster &)
	param: input cluster list return size of appended list More...

virtual size_t	apush (WSeries< double > &a, double=0.)
	param: this and WSeries objects should have the same tree type and the approximation level size param: start time offset: start-a.start, illegal if negative return size of amplitude vector More...

int	asize ()

virtual size_t	cleanhalo (bool=false)
	param: if true - de-cluster pixels return size of the list More...

virtual size_t	cluster ()
	return number of clusters More...

virtual size_t	cluster (wavepixel *)
	param: pixel index in pList vector return cluster volume (total number of pixels) More...

virtual size_t	coincidence (wavecluster &, double=1.)
	param: input cluster list return size of the coincidence list More...

wavearray< float >	get (char *, int=0, size_t=0)
	param: string with parameter name param: amplitude field index param: rate index, if 0 ignore rate for calculation of cluster parameters return wavearray object with parameter values for clusters More...

double	getbpp ()

double	gethigh ()

double	getlow ()

double	getNoiseRMS (double, double, double)
	param: pixel time, sec param: pixel low frequency param: pixel high frequency More...

void	ignore (size_t i=0)
	param: cluster ID number return void More...

virtual size_t	init (WSeries< double > &, bool=false)
	param: false - core only, true - core + halo return cluster list size More...

virtual size_t	merge (double=0.)
	param: non return size of merged list More...

wavecluster &	operator= (const wavecluster &)

void	set (WSeries< double > &n)

void	set (wavearray< float > &v)

void	setbpp (double P)

void	sethigh (double f)

void	setlow (double f)

virtual double	setMask (WSeries< double > &, int=1, bool=false)
	param: max number of pixels in clusters to be cleaned (<4); param: false - core only, true - core + halo return pixel occupancy More...

void	setrms (WSeries< double > &, double=-1., double=-1.)

void	setvar (wavearray< float > &, double=-1., double=-1.)

size_t	size ()

Public Attributes
double	bpp

std::list< vector_int >	cList

std::vector< vector_int >	cRate

double	high

int	ifo

double	low

WSeries< double >	nRMS

wavearray< float >	nVAR

std::vector< wavepixel >	pList

int	run

std::vector< bool >	sCuts

double	shift

double	start

double	stop

#include <cluster.hh>

Constructor & Destructor Documentation

◆ wavecluster() [1/3]

wavecluster::wavecluster ( )

Definition at line 44 of file cluster.cc.

◆ wavecluster() [2/3]

wavecluster::wavecluster	(	WSeries< double > &	w,
		bool	halo = `false`
	)

param: input WSeries param: true if halo, false if no halo included

Definition at line 66 of file cluster.cc.

◆ wavecluster() [3/3]

wavecluster::wavecluster ( const wavecluster & value )

param: value - object to copy from

Definition at line 60 of file cluster.cc.

◆ ~wavecluster()

wavecluster::~wavecluster ( )

virtual

Definition at line 73 of file cluster.cc.

Member Function Documentation

◆ append()

size_t wavecluster::append ( wavecluster & w )

virtual

param: input cluster list return size of appended list

Definition at line 422 of file cluster.cc.

◆ apush()

size_t wavecluster::apush	(	WSeries< double > &	a,
		double	offset = `0.`
	)

virtual

param: this and WSeries objects should have the same tree type and the approximation level size param: start time offset: start-a.start, illegal if negative return size of amplitude vector

Definition at line 369 of file cluster.cc.

◆ asize()

int wavecluster::asize ( )

inline

Definition at line 238 of file cluster.hh.

◆ cleanhalo()

size_t wavecluster::cleanhalo ( bool keepid = false )

virtual

param: if true - de-cluster pixels return size of the list

Definition at line 311 of file cluster.cc.

◆ cluster() [1/2]

size_t wavecluster::cluster ( )

virtual

return number of clusters

Definition at line 242 of file cluster.cc.

◆ cluster() [2/2]

size_t wavecluster::cluster ( wavepixel * p )

virtual

param: pixel index in pList vector return cluster volume (total number of pixels)

Definition at line 291 of file cluster.cc.

◆ coincidence()

size_t wavecluster::coincidence	(	wavecluster &	w,
		double	T = `1.`
	)

virtual

param: input cluster list return size of the coincidence list

Definition at line 675 of file cluster.cc.

◆ get()

wavearray< float > wavecluster::get	(	char *	name,
		int	index = `0`,
		size_t	type = `0`
	)

param: string with parameter name param: amplitude field index param: rate index, if 0 ignore rate for calculation of cluster parameters return wavearray object with parameter values for clusters

Definition at line 854 of file cluster.cc.

◆ getbpp()

double wavecluster::getbpp ( )

inline

Definition at line 113 of file cluster.hh.

◆ gethigh()

double wavecluster::gethigh ( )

inline

Definition at line 123 of file cluster.hh.

◆ getlow()

double wavecluster::getlow ( )

inline

Definition at line 118 of file cluster.hh.

◆ getNoiseRMS()

double wavecluster::getNoiseRMS	(	double	t,
		double	fl,
		double	fh
	)

param: pixel time, sec param: pixel low frequency param: pixel high frequency

Definition at line 811 of file cluster.cc.

◆ ignore()

void wavecluster::ignore ( size_t i = 0 )

inline

param: cluster ID number return void

Definition at line 154 of file cluster.hh.

◆ init()

size_t wavecluster::init	(	WSeries< double > &	w,
		bool	halo = `false`
	)

virtual

param: false - core only, true - core + halo return cluster list size

Definition at line 104 of file cluster.cc.

◆ merge()

size_t wavecluster::merge ( double S = 0. )

virtual

param: non return size of merged list

Definition at line 483 of file cluster.cc.

◆ operator=()

wavecluster & wavecluster::operator= ( const wavecluster & value )

Definition at line 77 of file cluster.cc.

◆ set() [1/2]

void wavecluster::set ( WSeries< double > & n )

inline

Definition at line 126 of file cluster.hh.

◆ set() [2/2]

void wavecluster::set ( wavearray< float > & v )

inline

Definition at line 128 of file cluster.hh.

◆ setbpp()

void wavecluster::setbpp ( double P )

inline

Definition at line 111 of file cluster.hh.

◆ sethigh()

void wavecluster::sethigh ( double f )

inline

Definition at line 121 of file cluster.hh.

◆ setlow()

void wavecluster::setlow ( double f )

inline

Definition at line 116 of file cluster.hh.

◆ setMask()

double wavecluster::setMask	(	WSeries< double > &	w,
		int	nc = `1`,
		bool	halo = `false`
	)

virtual

param: max number of pixels in clusters to be cleaned (<4); param: false - core only, true - core + halo return pixel occupancy

Definition at line 1135 of file cluster.cc.

◆ setrms()

void wavecluster::setrms	(	WSeries< double > &	w,
		double	fl = `-1.`,
		double	fh = `-1.`
	)

Definition at line 716 of file cluster.cc.

◆ setvar()

void wavecluster::setvar	(	wavearray< float > &	w,
		double	fl = `-1.`,
		double	fh = `-1.`
	)

Definition at line 774 of file cluster.cc.

◆ size()

size_t wavecluster::size ( )

inline

Definition at line 108 of file cluster.hh.

Member Data Documentation

◆ bpp

double wavecluster::bpp

Definition at line 215 of file cluster.hh.

◆ cList

std::list<vector_int> wavecluster::cList

Definition at line 225 of file cluster.hh.

◆ cRate

std::vector<vector_int> wavecluster::cRate

Definition at line 227 of file cluster.hh.

◆ high

double wavecluster::high

Definition at line 214 of file cluster.hh.

◆ ifo

int wavecluster::ifo

Definition at line 217 of file cluster.hh.

◆ low

double wavecluster::low

Definition at line 213 of file cluster.hh.

◆ nRMS

WSeries<double> wavecluster::nRMS

Definition at line 229 of file cluster.hh.

◆ nVAR

wavearray<float> wavecluster::nVAR

Definition at line 231 of file cluster.hh.

◆ pList

std::vector<wavepixel> wavecluster::pList

Definition at line 221 of file cluster.hh.

◆ run

int wavecluster::run

Definition at line 218 of file cluster.hh.

◆ sCuts

std::vector<bool> wavecluster::sCuts

Definition at line 223 of file cluster.hh.

◆ shift

double wavecluster::shift

Definition at line 216 of file cluster.hh.

◆ start

double wavecluster::start

Definition at line 211 of file cluster.hh.

◆ stop

double wavecluster::stop

Definition at line 212 of file cluster.hh.

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

/home/cWB_docker/git/cWB/library/wat/cluster.hh
/home/cWB_docker/git/cWB/library/wat/cluster.cc

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ wavecluster() [1/3]

◆ wavecluster() [2/3]

◆ wavecluster() [3/3]

◆ ~wavecluster()

Member Function Documentation

◆ append()

◆ apush()

◆ asize()

◆ cleanhalo()

◆ cluster() [1/2]

◆ cluster() [2/2]

◆ coincidence()

◆ get()

◆ getbpp()

◆ gethigh()

◆ getlow()

◆ getNoiseRMS()

◆ ignore()

◆ init()

◆ merge()

◆ operator=()

◆ set() [1/2]

◆ set() [2/2]

◆ setbpp()

◆ sethigh()

◆ setlow()

◆ setMask()

◆ setrms()

◆ setvar()

◆ size()

Member Data Documentation

◆ bpp

◆ cList

◆ cRate

◆ high

◆ ifo

◆ low

◆ nRMS

◆ nVAR

◆ pList

◆ run

◆ sCuts

◆ shift

◆ start

◆ stop