Logo Coherent WaveBurst  
Reference Guide
Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Member Functions | Public Attributes | List of all members
wavecluster Class Reference

Definition at line 51 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...
 
waveclusteroperator= (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_intcList
 
std::vector< vector_intcRate
 
double high
 
int ifo
 
double low
 
WSeries< double > nRMS
 
wavearray< float > nVAR
 
std::vector< wavepixelpList
 
int run
 
std::vector< bool > sCuts
 
double shift
 
double start
 
double stop
 

#include <cluster.hh>

Constructor & Destructor Documentation

wavecluster::wavecluster ( )

Definition at line 26 of file cluster.cc.

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

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

Definition at line 48 of file cluster.cc.

wavecluster::wavecluster ( const wavecluster value)

param: value - object to copy from

Definition at line 42 of file cluster.cc.

wavecluster::~wavecluster ( )
virtual

Definition at line 55 of file cluster.cc.

Member Function Documentation

size_t wavecluster::append ( wavecluster w)
virtual

param: input cluster list return size of appended list

Definition at line 404 of file cluster.cc.

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 351 of file cluster.cc.

int wavecluster::asize ( )
inline

Definition at line 220 of file cluster.hh.

size_t wavecluster::cleanhalo ( bool  keepid = false)
virtual

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

Definition at line 293 of file cluster.cc.

size_t wavecluster::cluster ( )
virtual

return number of clusters

Definition at line 224 of file cluster.cc.

size_t wavecluster::cluster ( wavepixel p)
virtual

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

Definition at line 273 of file cluster.cc.

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

param: input cluster list return size of the coincidence list

Definition at line 657 of file cluster.cc.

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 836 of file cluster.cc.

double wavecluster::getbpp ( )
inline

Definition at line 95 of file cluster.hh.

double wavecluster::gethigh ( )
inline

Definition at line 105 of file cluster.hh.

double wavecluster::getlow ( )
inline

Definition at line 100 of file cluster.hh.

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

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

Definition at line 793 of file cluster.cc.

void wavecluster::ignore ( size_t  i = 0)
inline

param: cluster ID number return void

Definition at line 136 of file cluster.hh.

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 86 of file cluster.cc.

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

param: non return size of merged list

Definition at line 465 of file cluster.cc.

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

Definition at line 59 of file cluster.cc.

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

Definition at line 108 of file cluster.hh.

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

Definition at line 110 of file cluster.hh.

void wavecluster::setbpp ( double  P)
inline

Definition at line 93 of file cluster.hh.

void wavecluster::sethigh ( double  f)
inline

Definition at line 103 of file cluster.hh.

void wavecluster::setlow ( double  f)
inline

Definition at line 98 of file cluster.hh.

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 1117 of file cluster.cc.

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

Definition at line 698 of file cluster.cc.

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

Definition at line 756 of file cluster.cc.

size_t wavecluster::size ( )
inline

Definition at line 90 of file cluster.hh.

Member Data Documentation

double wavecluster::bpp

Definition at line 197 of file cluster.hh.

std::list<vector_int> wavecluster::cList

Definition at line 207 of file cluster.hh.

std::vector<vector_int> wavecluster::cRate

Definition at line 209 of file cluster.hh.

double wavecluster::high

Definition at line 196 of file cluster.hh.

int wavecluster::ifo

Definition at line 199 of file cluster.hh.

double wavecluster::low

Definition at line 195 of file cluster.hh.

WSeries<double> wavecluster::nRMS

Definition at line 211 of file cluster.hh.

wavearray<float> wavecluster::nVAR

Definition at line 213 of file cluster.hh.

std::vector<wavepixel> wavecluster::pList

Definition at line 203 of file cluster.hh.

int wavecluster::run

Definition at line 200 of file cluster.hh.

std::vector<bool> wavecluster::sCuts

Definition at line 205 of file cluster.hh.

double wavecluster::shift

Definition at line 198 of file cluster.hh.

double wavecluster::start

Definition at line 193 of file cluster.hh.

double wavecluster::stop

Definition at line 194 of file cluster.hh.


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