cWB: detector Class Reference

Definition at line 67 of file detector.hh.

Public Member Functions
	detector ()

	detector (char *, double=0.)

	detector (detectorParams, double=0.)

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

virtual	~detector ()

void	addSTFmap (netcluster *pwc, double mTau=0.042)

wavecomplex	antenna (double, double, double=0.)
	param: source theta,phi, polarization angle psi in degrees More...

void	bandCut (double f1, double f2)

void	bandPass (double f1, double f2, double a=0.)

void	bandPass1G (double f1=0., double f2=0.)

virtual void	Browse (TBrowser *b)

void	clearFilter ()

void	delay (double, double)
	param: theta param: phi More...

void	delay (wavearray< double > &, double, double)
	param: input TS param: theta param: phi More...

void	delay (wavearray< double > &, double)
	param: input TS param: time delay T More...

void	delay (double, WSeries< double > &)
	param: time delay in seconds param: WSeries which should be delayed More...

double	get_NN ()

double	get_SS ()

double	get_XS ()

double	get_XX ()

detectorParams	getDetectorParams ()

wavearray< double > *	getHoT ()
	param: no parameters More...

double	getNoise (size_t, int=-1)
	param: wavelet layer index (frequency) param: wavelet time index if param 2 is specified - return noise rms for specified pixel location if param 2 is not specified - return rms averaged over the layer More...

POLARIZATION	getPolarization ()

int	getSTFind (double r)

SSeries< double > *	getSTFmap (size_t n)

double	getTau (double, double)
	param: source theta,phi angles in degrees More...

WSeries< double > *	getTFmap ()
	param: no parameters More...

double	getwave (int, netcluster &, char, size_t)
	param: no parameters More...

double	getWFfreq (char atype='S')

double	getWFtime (char atype='S')

void	highPass (double f2)

void	init ()
	param: Rx,Ry,Rz in ECEF frame More...

bool	isBuiltin ()

void	lowPass (double f1)

detector &	operator<< (detector &)

detector &	operator= (const detector &)

detector &	operator= (const WSeries< double > &)

detector &	operator>> (detector &)

void	print ()

void	readFilter (const char *)

void	rotate (double)

void	sclear ()

size_t	setFilter (size_t, double=0., size_t=0)
	param: filter length param: filter phase delay in degrees param: number of up-sample layers return filter size More...

size_t	setFilter (detector &)
	param: detector return filter size More...

void	setFpFx (double, double=0., double=180., double=0., double=360.)
	param - step on phi and theta param - theta begin param - theta end param - phi begin param - phi end More...

void	setFpFx (int)
	param - healpix order More...

void	setPolarization (POLARIZATION polarization=TENSOR)

bool	setrms (netcluster *, size_t=0)

size_t	setsim (WSeries< double > &, std::vector< double > *, double=5., double=8., bool saveWF=false)

size_t	setsnr (wavearray< double > &, std::vector< double > , std::vector< double > , double=5., double=8.)

void	setTau (double, double=0., double=180., double=0., double=360.)
	param - step on phi and theta param - theta begin param - theta end param - phi begin param - phi end More...

void	setTau (int)
	param - healpix order More...

void	shift (double s)

double	shift ()

size_t	ssize ()

int	wfsave ()

void	wfsave (int wfSAVE)

void	white (double dT=0, int wtype=1, double offset=0., double stride=0.)
	what it does: see algorithm description in wseries.hh More...

void	writeFilter (const char *)
	param: file name More...

Public Attributes
wavearray< double >	BAND

detectorParams	dP

double	DT [9]

double	ED [5]

double	ekXk

double	enrg

double	Ex [3]

double	Ey [3]

wavearray< double >	ffm

wavearray< double >	ffp

std::vector< delayFilter >	filter

wavearray< double >	fp

wavearray< double >	fpx

wavearray< double >	FREQ

wavearray< double >	fx

wavearray< double >	HoT

wavearray< double >	HRSS

size_t	ifoID

wavearray< short >	index

wavearray< double >	ISNR

std::vector< int >	IWFID

std::vector< wavearray< double > * >	IWFP

wavearray< double >	lagShift

skymap	mFp

skymap	mFx

char	Name [16]

size_t	nDFL

size_t	nDFS

WSeries< double >	nRMS

double	null

WSeries< float >	nVAR

POLARIZATION	polarization

double	rate

double	Rv [3]

std::vector< int >	RWFID

std::vector< wavearray< double > * >	RWFP

double	sHIFt

double	sSNR

skymap	tau

wavearray< double >	TDUR

WSeries< double >	TFmap

wavearray< double >	TIME

std::vector< SSeries< double > >	vSS

WSeries< double >	waveBand

WSeries< double >	waveForm

WSeries< double >	waveNull

int	wfSAVE

double	xSNR

#include <detector.hh>

Inheritance diagram for detector:

[legend]

Constructor & Destructor Documentation

◆ detector() [1/4]

detector::detector ( )

Definition at line 108 of file detector.cc.

◆ detector() [2/4]

detector::detector	(	char *	name,
		double	t = `0.`
	)

Definition at line 130 of file detector.cc.

◆ detector() [3/4]

detector::detector	(	detectorParams	dP,
		double	t = `0.`
	)

Definition at line 184 of file detector.cc.

◆ detector() [4/4]

detector::detector ( const detector & value )

param: value - object to copy from

Definition at line 336 of file detector.cc.

◆ ~detector()

detector::~detector ( )

virtual

Definition at line 343 of file detector.cc.

Member Function Documentation

◆ addSTFmap()

void detector::addSTFmap	(	netcluster *	pwc,
		double	mTau = `0.042`
	)

inline

Definition at line 391 of file detector.hh.

◆ antenna()

wavecomplex detector::antenna	(	double	theta,
		double	phi,
		double	psi = `0.`
	)

param: source theta,phi, polarization angle psi in degrees

Definition at line 490 of file detector.cc.

◆ bandCut()

void detector::bandCut	(	double	f1,
		double	f2
	)

inline

Definition at line 286 of file detector.hh.

◆ bandPass()

void detector::bandPass	(	double	f1,
		double	f2,
		double	a = `0.`
	)

inline

Definition at line 283 of file detector.hh.

◆ bandPass1G()

void detector::bandPass1G	(	double	f1 = `0.`,
		double	f2 = `0.`
	)

Definition at line 1310 of file detector.cc.

◆ Browse()

virtual void detector::Browse ( TBrowser * b )

inlinevirtual

Definition at line 302 of file detector.hh.

◆ clearFilter()

void detector::clearFilter ( )

inline

Definition at line 143 of file detector.hh.

◆ delay() [1/4]

void detector::delay	(	double	theta,
		double	phi
	)

param: theta param: phi

Definition at line 1711 of file detector.cc.

◆ delay() [2/4]

void detector::delay	(	wavearray< double > &	x,
		double	theta,
		double	phi
	)

param: input TS param: theta param: phi

Definition at line 1730 of file detector.cc.

◆ delay() [3/4]

void detector::delay	(	wavearray< double > &	x,
		double	T
	)

param: input TS param: time delay T

Definition at line 1749 of file detector.cc.

◆ delay() [4/4]

void detector::delay	(	double	t,
		WSeries< double > &	w
	)

param: time delay in seconds param: WSeries which should be delayed

Definition at line 1047 of file detector.cc.

◆ get_NN()

double detector::get_NN ( )

inline

Definition at line 311 of file detector.hh.

◆ get_SS()

double detector::get_SS ( )

inline

Definition at line 309 of file detector.hh.

◆ get_XS()

double detector::get_XS ( )

inline

Definition at line 312 of file detector.hh.

◆ get_XX()

double detector::get_XX ( )

inline

Definition at line 310 of file detector.hh.

◆ getDetectorParams()

detectorParams detector::getDetectorParams ( )

Definition at line 218 of file detector.cc.

◆ getHoT()

wavearray<double>* detector::getHoT ( )

inline

param: no parameters

Definition at line 175 of file detector.hh.

◆ getNoise()

double detector::getNoise	(	size_t	I,
		int	J = `-1`
	)

param: wavelet layer index (frequency) param: wavelet time index if param 2 is specified - return noise rms for specified pixel location if param 2 is not specified - return rms averaged over the layer

Definition at line 1129 of file detector.cc.

◆ getPolarization()

POLARIZATION detector::getPolarization ( )

inline

Definition at line 307 of file detector.hh.

◆ getSTFind()

int detector::getSTFind ( double r )

inline

Definition at line 182 of file detector.hh.

◆ getSTFmap()

SSeries<double>* detector::getSTFmap ( size_t n )

inline

Definition at line 187 of file detector.hh.

◆ getTau()

double detector::getTau	(	double	theta,
		double	phi
	)

param: source theta,phi angles in degrees

Definition at line 698 of file detector.cc.

◆ getTFmap()

WSeries<double>* detector::getTFmap ( )

inline

param: no parameters

Definition at line 179 of file detector.hh.

◆ getwave()

double detector::getwave	(	int	ID,
		netcluster &	wc,
		char	atype,
		size_t	index
	)

param: no parameters

param: input parameter is the cluster ID in the netcluster structure param: input netcluster structure param: amplitude type param: amplitude index return: cluster average noise rms

Definition at line 561 of file detector.cc.

◆ getWFfreq()

double detector::getWFfreq ( char atype = 'S' )

Definition at line 1779 of file detector.cc.

◆ getWFtime()

double detector::getWFtime ( char atype = 'S' )

Definition at line 1764 of file detector.cc.

◆ highPass()

void detector::highPass ( double f2 )

inline

Definition at line 288 of file detector.hh.

◆ init()

void detector::init ( )

param: Rx,Ry,Rz in ECEF frame

param: Ex,Ey,Ez in ECEF frame param: Ex,Ey,Ez in ECEF frame param: no parameters

Definition at line 468 of file detector.cc.

◆ isBuiltin()

bool detector::isBuiltin ( )

inline

Definition at line 304 of file detector.hh.

◆ lowPass()

void detector::lowPass ( double f1 )

inline

Definition at line 287 of file detector.hh.

◆ operator<<()

detector & detector::operator<< ( detector & value )

Definition at line 411 of file detector.cc.

◆ operator=() [1/2]

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

Definition at line 368 of file detector.cc.

◆ operator=() [2/2]

detector & detector::operator= ( const WSeries< double > & value )

Definition at line 400 of file detector.cc.

◆ operator>>()

detector & detector::operator>> ( detector & value )

Definition at line 438 of file detector.cc.

◆ print()

void detector::print ( )

Definition at line 1797 of file detector.cc.

◆ readFilter()

void detector::readFilter ( const char * fname )

Definition at line 986 of file detector.cc.

◆ rotate()

void detector::rotate ( double a )

Definition at line 291 of file detector.cc.

◆ sclear()

void detector::sclear ( )

inline

Definition at line 191 of file detector.hh.

◆ setFilter() [1/2]

size_t detector::setFilter	(	size_t	K,
		double	phase = `0.`,
		size_t	upL = `0`
	)

param: filter length param: filter phase delay in degrees param: number of up-sample layers return filter size

Definition at line 759 of file detector.cc.

◆ setFilter() [2/2]

size_t detector::setFilter ( detector & d )

param: detector return filter size

Definition at line 933 of file detector.cc.

◆ setFpFx() [1/2]

void detector::setFpFx	(	double	sms,
		double	t1 = `0.`,
		double	t2 = `180.`,
		double	p1 = `0.`,
		double	p2 = `360.`
	)

param - step on phi and theta param - theta begin param - theta end param - phi begin param - phi end

Definition at line 709 of file detector.cc.

◆ setFpFx() [2/2]

void detector::setFpFx ( int order )

param - healpix order

Definition at line 734 of file detector.cc.

◆ setPolarization()

void detector::setPolarization ( POLARIZATION polarization = TENSOR )

inline

Definition at line 306 of file detector.hh.

◆ setrms()

bool detector::setrms	(	netcluster *	wc,
		size_t	I = `0`
	)

Definition at line 1225 of file detector.cc.

◆ setsim()

size_t detector::setsim	(	WSeries< double > &	wi,
		std::vector< double > *	pT,
		double	dT = `5.`,
		double	offset = `8.`,
		bool	saveWF = `false`
	)

Definition at line 1377 of file detector.cc.

◆ setsnr()

size_t detector::setsnr	(	wavearray< double > &	wi,
		std::vector< double > *	pT,
		std::vector< double > *	pF,
		double	dT = `5.`,
		double	offset = `8.`
	)

Definition at line 1670 of file detector.cc.

◆ setTau() [1/2]

void detector::setTau	(	double	sms,
		double	t1 = `0.`,
		double	t2 = `180.`,
		double	p1 = `0.`,
		double	p2 = `360.`
	)

param - step on phi and theta param - theta begin param - theta end param - phi begin param - phi end

Definition at line 654 of file detector.cc.

◆ setTau() [2/2]

void detector::setTau ( int order )

param - healpix order

Definition at line 677 of file detector.cc.

◆ shift() [1/2]

void detector::shift ( double s )

inline

Definition at line 263 of file detector.hh.

◆ shift() [2/2]

double detector::shift ( )

inline

Definition at line 270 of file detector.hh.

◆ ssize()

size_t detector::ssize ( )

inline

Definition at line 190 of file detector.hh.

◆ wfsave() [1/2]

int detector::wfsave ( )

inline

Definition at line 316 of file detector.hh.

◆ wfsave() [2/2]

void detector::wfsave ( int wfSAVE )

inline

Definition at line 317 of file detector.hh.

◆ white()

void detector::white	(	double	dT = `0`,
		int	wtype = `1`,
		double	offset = `0.`,
		double	stride = `0.`
	)

inline

what it does: see algorithm description in wseries.hh

Definition at line 258 of file detector.hh.

◆ writeFilter()

void detector::writeFilter ( const char * fname )

param: file name

Definition at line 947 of file detector.cc.

Member Data Documentation

◆ BAND

wavearray<double> detector::BAND

Definition at line 374 of file detector.hh.

◆ dP

detectorParams detector::dP

Definition at line 329 of file detector.hh.

◆ DT

double detector::DT[9]

Definition at line 333 of file detector.hh.

◆ ED

double detector::ED[5]

Definition at line 334 of file detector.hh.

◆ ekXk

double detector::ekXk

Definition at line 340 of file detector.hh.

◆ enrg

double detector::enrg

Definition at line 337 of file detector.hh.

◆ Ex

double detector::Ex[3]

Definition at line 331 of file detector.hh.

◆ Ey

double detector::Ey[3]

Definition at line 332 of file detector.hh.

◆ ffm

wavearray<double> detector::ffm

Definition at line 366 of file detector.hh.

◆ ffp

wavearray<double> detector::ffp

Definition at line 365 of file detector.hh.

◆ filter

std::vector<delayFilter> detector::filter

Definition at line 361 of file detector.hh.

◆ fp

wavearray<double> detector::fp

Definition at line 363 of file detector.hh.

◆ fpx

wavearray<double> detector::fpx

Definition at line 367 of file detector.hh.

◆ FREQ

wavearray<double> detector::FREQ

Definition at line 373 of file detector.hh.

◆ fx

wavearray<double> detector::fx

Definition at line 364 of file detector.hh.

◆ HoT

wavearray<double> detector::HoT

Definition at line 350 of file detector.hh.

◆ HRSS

wavearray<double> detector::HRSS

Definition at line 371 of file detector.hh.

◆ ifoID

size_t detector::ifoID

Definition at line 328 of file detector.hh.

◆ index

wavearray<short> detector::index

Definition at line 368 of file detector.hh.

◆ ISNR

wavearray<double> detector::ISNR

Definition at line 372 of file detector.hh.

◆ IWFID

std::vector<int> detector::IWFID

Definition at line 378 of file detector.hh.

◆ IWFP

std::vector<wavearray<double>*> detector::IWFP

Definition at line 379 of file detector.hh.

◆ lagShift

wavearray<double> detector::lagShift

Definition at line 369 of file detector.hh.

◆ mFp

skymap detector::mFp

Definition at line 347 of file detector.hh.

◆ mFx

skymap detector::mFx

Definition at line 348 of file detector.hh.

◆ Name

char detector::Name[16]

Definition at line 327 of file detector.hh.

◆ nDFL

size_t detector::nDFL

Definition at line 343 of file detector.hh.

◆ nDFS

size_t detector::nDFS

Definition at line 342 of file detector.hh.

◆ nRMS

WSeries<double> detector::nRMS

Definition at line 358 of file detector.hh.

◆ null

double detector::null

Definition at line 336 of file detector.hh.

◆ nVAR

WSeries<float> detector::nVAR

Definition at line 359 of file detector.hh.

◆ polarization

POLARIZATION detector::polarization

Definition at line 384 of file detector.hh.

◆ rate

double detector::rate

Definition at line 341 of file detector.hh.

◆ Rv

double detector::Rv[3]

Definition at line 330 of file detector.hh.

◆ RWFID

std::vector<int> detector::RWFID

Definition at line 381 of file detector.hh.

◆ RWFP

std::vector<wavearray<double>*> detector::RWFP

Definition at line 382 of file detector.hh.

◆ sHIFt

double detector::sHIFt

Definition at line 335 of file detector.hh.

◆ sSNR

double detector::sSNR

Definition at line 338 of file detector.hh.

◆ tau

skymap detector::tau

Definition at line 346 of file detector.hh.

◆ TDUR

wavearray<double> detector::TDUR

Definition at line 376 of file detector.hh.

◆ TFmap

WSeries<double> detector::TFmap

Definition at line 354 of file detector.hh.

◆ TIME

wavearray<double> detector::TIME

Definition at line 375 of file detector.hh.

◆ vSS

std::vector<SSeries<double> > detector::vSS

Definition at line 352 of file detector.hh.

◆ waveBand

WSeries<double> detector::waveBand

Definition at line 356 of file detector.hh.

◆ waveForm

WSeries<double> detector::waveForm

Definition at line 355 of file detector.hh.

◆ waveNull

WSeries<double> detector::waveNull

Definition at line 357 of file detector.hh.

◆ wfSAVE

int detector::wfSAVE

Definition at line 344 of file detector.hh.

◆ xSNR

double detector::xSNR

Definition at line 339 of file detector.hh.

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

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

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ detector() [1/4]

◆ detector() [2/4]

◆ detector() [3/4]

◆ detector() [4/4]

◆ ~detector()

Member Function Documentation

◆ addSTFmap()

◆ antenna()

◆ bandCut()

◆ bandPass()

◆ bandPass1G()

◆ Browse()

◆ clearFilter()

◆ delay() [1/4]

◆ delay() [2/4]

◆ delay() [3/4]

◆ delay() [4/4]

◆ get_NN()

◆ get_SS()

◆ get_XS()

◆ get_XX()

◆ getDetectorParams()

◆ getHoT()

◆ getNoise()

◆ getPolarization()

◆ getSTFind()

◆ getSTFmap()

◆ getTau()

◆ getTFmap()

◆ getwave()

◆ getWFfreq()

◆ getWFtime()

◆ highPass()

◆ init()

◆ isBuiltin()

◆ lowPass()

◆ operator<<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator>>()

◆ print()

◆ readFilter()

◆ rotate()

◆ sclear()

◆ setFilter() [1/2]

◆ setFilter() [2/2]

◆ setFpFx() [1/2]

◆ setFpFx() [2/2]

◆ setPolarization()

◆ setrms()

◆ setsim()

◆ setsnr()

◆ setTau() [1/2]

◆ setTau() [2/2]

◆ shift() [1/2]

◆ shift() [2/2]

◆ ssize()

◆ wfsave() [1/2]

◆ wfsave() [2/2]

◆ white()

◆ writeFilter()

Member Data Documentation

◆ BAND

◆ dP

◆ DT

◆ ED

◆ ekXk

◆ enrg

◆ Ex

◆ Ey

◆ ffm

◆ ffp

◆ filter

◆ fp

◆ fpx

◆ FREQ

◆ fx