lalapps » src » pulsar » FDS_isolated

FstatShapeTestLAL.c File Reference

Note on the code. More...

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <math.h>
#include <float.h>
#include <lal/LALStdlib.h>
#include <lal/LALDatatypes.h>
#include <lal/LALConstants.h>
#include <lal/LALDemod.h>
#include <lal/AVFactories.h>
#include <lalapps.h>
#include "getopt.h"

Include dependency graph for FstatShapeTestLAL.c:

Go to the source code of this file.

Data Structures

struct  tagFSTControlParameters
struct  tagFSTClustInfo
struct  tagFSTUserInput
struct  tagFSTFstatPair
struct  tagFSTClustInfoPair
struct  tagFSTFVetoStat

Defines

#define FSTATSHAPETESTC_ENULL   1
#define FSTATSHAPETESTC_ENONULL   2
#define FSTATSHAPETESTC_EFILEIO   3
#define FSTATSHAPETESTC_EMEMORY   4
#define FSTATSHAPETESTC_EODDDATA   5
#define FSTATSHAPETESTC_MSGENULL   "Input argument pointer is NULL."
#define FSTATSHAPETESTC_MSGENONULL   "Output argument pointer is not NULL."
#define FSTATSHAPETESTC_MSGEFILIO   "File I/O error."
#define FSTATSHAPETESTC_MSGEMEMORY   "Memory allocation error."
#define FSTATSHAPETESTC_MSGEODDDATA   "Strange data."
#define FSTATSHAPETESTC_EDATADOMAIN   6
#define FSTATSHAPETESTC_EPARAMDOMAIN   7
#define FSTATSHAPETESTC_EINPUTDOMAIN   8
#define FSTATSHAPETESTC_EDOFDOMAIN   9
#define FSTATSHAPETESTC_MSGEDATADOMAIN   "Data should be non-negative."
#define FSTATSHAPETESTC_MSGEPARAMDOMAIN   "Parameter domain error."
#define FSTATSHAPETESTC_MSGEINPUTDOMAIN   "Input argument(s) domain error."
#define FSTATSHAPETESTC_MSGEDOFDOMAIN   "Degrees of freedom should be non-negative."

Typedefs

typedef tagFSTControlParameters FSTControlParameters
typedef tagFSTClustInfo FSTClustInfo
typedef tagFSTUserInput FSTUserInput
typedef tagFSTFstatPair FSTFstatPair
typedef tagFSTClustInfoPair FSTClustInfoPair
typedef tagFSTFVetoStat FSTFVetoStat

Functions

 RCSID ("$Id: FstatShapeTestLAL.c,v 1.16 2007/06/08 15:29:51 bema Exp $")
INT4 main (INT4 argc, CHAR **argv)

Variables

INT4 vrbflg
 defined in lalapps.c

Detailed Description

Note on the code.

Author:
Itoh, Yousuke
Id
FstatShapeTestLAL.c,v 1.16 2007/06/08 15:29:51 bema Exp
Note:
(1)Description of the algorithm: See the GWDAW8 proceedings. gr-qc/0408092 Title: Chi-square test on candidate events from CW signal coherent searches Authors: Y. Itoh, M.A. Papa, B. Krishnan, X. Siemens Comments: proceedings of GWDAW8, 2003 conference, 12pages, 6 figures

(2)Note: This is a LALAppsified version of the original code FstatShapeTest.c.

Purposes are to make this code more modular to prepare for a possible future functionization of ComputeFstatistic and for c-code-based search pipelines including MC experiments.

(3)Example: ./FstatShapeTestLAL -o FaFb00.001 -t FaFb01.001 > FST.txt

(4)Validation: Generate 10^5 signals of SNR = {2F} ranging from sqrt(20) to ~ 30 with a Gaussian stationary noise, run ComputeFStatistic with the threshold on 2F being 20. The code reported 789135 outliers that includes statistical disturbances. The resulting veto statistics by the original FstatShapeTest are consistent with those by this LALAppsified code with a relative difference of 6x10^-8.

Todo:

Definition in file FstatShapeTestLAL.c.

Define Documentation

#define FSTATSHAPETESTC_ENULL   1

Error code for Fstatistic shape test main part.

Definition at line 84 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_ENONULL   2

Definition at line 85 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_EFILEIO   3

Definition at line 86 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_EMEMORY   4

Definition at line 87 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_EODDDATA   5

Definition at line 88 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGENULL   "Input argument pointer is NULL."

Definition at line 91 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGENONULL   "Output argument pointer is not NULL."

Definition at line 92 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGEFILIO   "File I/O error."

Definition at line 93 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGEMEMORY   "Memory allocation error."

Definition at line 94 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGEODDDATA   "Strange data."

Definition at line 95 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_EDATADOMAIN   6

Error code for ChiSquare distribution computation.

Definition at line 99 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_EPARAMDOMAIN   7

Definition at line 100 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_EINPUTDOMAIN   8

Definition at line 101 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_EDOFDOMAIN   9

Definition at line 102 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGEDATADOMAIN   "Data should be non-negative."

Definition at line 105 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGEPARAMDOMAIN   "Parameter domain error."

Definition at line 106 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGEINPUTDOMAIN   "Input argument(s) domain error."

Definition at line 107 of file FstatShapeTestLAL.c.

#define FSTATSHAPETESTC_MSGEDOFDOMAIN   "Degrees of freedom should be non-negative."

Definition at line 108 of file FstatShapeTestLAL.c.

Typedef Documentation

typedef struct tagFSTControlParameters FSTControlParameters

control parameters

typedef struct tagFSTClustInfo FSTClustInfo

Files headers information

typedef struct tagFSTUserInput FSTUserInput

User input Variables user can specify.

typedef struct tagFSTFstatPair FSTFstatPair

Frequency and Fa, Fb

typedef struct tagFSTClustInfoPair FSTClustInfoPair

pair of the cluster information of observed data and veto signal

typedef struct tagFSTFVetoStat FSTFVetoStat

resulting veto statistic

Function Documentation

RCSID ( "$Id: FstatShapeTestLAL.  c,
v 1.16 2007/06/08 15:29:51 bema Exp $"   
)

INT4 main ( INT4  argc,
CHAR **  argv 
)

Definition at line 206 of file FstatShapeTestLAL.c.

Variable Documentation

INT4 vrbflg

defined in lalapps.c

Parameters:
vrbflg INT4 Control debugging messages. Defined in lalapps.h

Definition at line 45 of file lalapps.c.

Generated on Sun Sep 7 03:07:45 2008 for LAL by  doxygen 1.5.2