PeakSelect.h File Reference

Header file for PeakSelect.c. More...

Prototypes
void	LALComputeMeanPower (LALStatus *status, REAL8 *mean, REAL8Periodogram1 *peri)
	to compute mean power from a periodogram – obsolete – use LAL functions in NormalizeSFTRngMed.c More...
void	LALSelectPeakWhiteNoise (LALStatus *status, UCHARPeakGram *pg, REAL8 *thr, REAL8Periodogram1 *peri)
	select peakgram in white noise – obsolete – use LAL functions in NormalizeSFTRngMed.c More...
void	LALUCHAR2HOUGHPeak (LALStatus *status, HOUGHPeakGram *pgOut, UCHARPeakGram *pgIn)
	Compress explicit peak gram. More...
void	LALPeriodo2PSDrng (LALStatus *status, REAL8Periodogram1 *psd, REAL8Periodogram1 *peri, INT4 *blocksRNG)
	Wrapper for LALRunningMedian code – obsolete – use LAL functions in NormalizeSFTRngMed.c. More...
void	LALSelectPeakColorNoise (LALStatus *status, UCHARPeakGram *pg, REAL8 *thr, REAL8PeriodoPSD *in)
	Function for selecting peaks in colored noise – obsolete – use LAL functions in NormalizeSFTRngMed.c. More...
void	SFTtoUCHARPeakGram (LALStatus *status, UCHARPeakGram *pg, const SFTtype *sft, REAL8 thr)
	Constructs peakgram from a normalized SFT – uses standard pulsar data types. More...

Detailed Description

Header file for PeakSelect.c.

Author

Sintes, A.M., and Krishnan, B.

History: Created by Sintes May 21, 2003 Modified by Krishnan Oct 2005

Header PeakSelect.h

From periodogram to peakgram

Synopsis

#include <lal/PeakSelect.h>

Definition in file PeakSelect.h.

Go to the source code of this file.

Data Structures
struct	UCHARPeakGram
	Explicit peakgram structure – 1 if power in bin is above threshold and 0 if below. More...
struct	REAL8PeriodoPSD
	structure containing psd and periodogram of a sft – obsolete – use LAL functions More...

Macros
Error Codes
#define	PEAKSELECTH_ENULL   1
#define	PEAKSELECTH_EVAL   5
#define	PEAKSELECTH_MSGENULL   "Null pointer"
#define	PEAKSELECTH_MSGEVAL   "Invalid value"

Macro Definition Documentation

PEAKSELECTH_ENULL

#define PEAKSELECTH_ENULL   1

Definition at line 88 of file PeakSelect.h.

PEAKSELECTH_EVAL

#define PEAKSELECTH_EVAL   5

Definition at line 89 of file PeakSelect.h.

PEAKSELECTH_MSGENULL

#define PEAKSELECTH_MSGENULL   "Null pointer"

Definition at line 91 of file PeakSelect.h.

PEAKSELECTH_MSGEVAL

#define PEAKSELECTH_MSGEVAL   "Invalid value"

Definition at line 92 of file PeakSelect.h.

Function Documentation

LALComputeMeanPower()

void LALComputeMeanPower	(	LALStatus *	status,
		REAL8 *	mean,
		REAL8Periodogram1 *	peri
	)

to compute mean power from a periodogram – obsolete – use LAL functions in NormalizeSFTRngMed.c

Parameters

status	pointer to LALStatus structure
mean	mean power
peri	periodogram

Definition at line 56 of file PeakSelect.c.

LALSelectPeakWhiteNoise()

void LALSelectPeakWhiteNoise	(	LALStatus *	status,
		UCHARPeakGram *	pg,
		REAL8 *	thr,
		REAL8Periodogram1 *	peri
	)

select peakgram in white noise – obsolete – use LAL functions in NormalizeSFTRngMed.c

Definition at line 97 of file PeakSelect.c.

LALUCHAR2HOUGHPeak()

void LALUCHAR2HOUGHPeak	(	LALStatus *	status,
		HOUGHPeakGram *	pgOut,
		UCHARPeakGram *	pgIn
	)

Compress explicit peak gram.

Parameters

status	pointer to LALStatus structure
pgOut	compressed peakgram
pgIn	explicit peakgram – collection of 1s and 0s

Definition at line 160 of file PeakSelect.c.

LALPeriodo2PSDrng()

void LALPeriodo2PSDrng	(	LALStatus *	status,
		REAL8Periodogram1 *	psd,
		REAL8Periodogram1 *	peri,
		INT4 *	blocksRNG
	)

Wrapper for LALRunningMedian code – obsolete – use LAL functions in NormalizeSFTRngMed.c.

Parameters

status	pointer to LALStatus structure
psd	output psd
peri	input periodogram
blocksRNG	running median block size

Definition at line 215 of file PeakSelect.c.

LALSelectPeakColorNoise()

void LALSelectPeakColorNoise	(	LALStatus *	status,
		UCHARPeakGram *	pg,
		REAL8 *	thr,
		REAL8PeriodoPSD *	in
	)

Function for selecting peaks in colored noise – obsolete – use LAL functions in NormalizeSFTRngMed.c.

Parameters

status	pointer to LALStatus structure
pg	output peakgram
thr	threshold reltive to psd
in	input psd and periodogram

Definition at line 286 of file PeakSelect.c.

SFTtoUCHARPeakGram()

void SFTtoUCHARPeakGram	(	LALStatus *	status,
		UCHARPeakGram *	pg,
		const SFTtype *	sft,
		REAL8	thr
	)

Constructs peakgram from a normalized SFT – uses standard pulsar data types.

Constructs peakgram from a normalized SFT – uses standard pulsar data types.

Parameters

status	pointer to LALStatus structure
pg	output peakgram
sft	standard pulsar sft type
thr	sft power threshold for peak selection

Definition at line 371 of file PeakSelect.c.