ZCoarseGrainFrequencySeriesTest.c File Reference

#include <lal/LALStdlib.h>
#include <math.h>
#include <string.h>
#include <stdio.h>
#include <config.h>
#include <lal/CoarseGrainFrequencySeries.h>
#include <lal/AVFactories.h>
#include <lal/ReadFTSeries.h>
#include <lal/PrintFTSeries.h>
#include <lal/Units.h>
#include "CheckStatus.h"

Include dependency graph for ZCoarseGrainFrequencySeriesTest.c:

Go to the source code of this file.

Defines

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_TOL   1e-15
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EPOCHSEC   1234
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EPOCHNS   56789
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF0   1.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F00   0.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH0   8
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF1   2.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F01   0.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH1   4
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF2   3.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F02   0.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH2   3
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF3   1.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F03   40.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH3   5
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF4   2.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F04   41.0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH4   2
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_TRUE   1
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_FALSE   0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_ENOM   0
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EARG   1
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_ECHK   2
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EFLS   3
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EUSE   4
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGENOM   "Nominal exit"
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGEARG   "Error parsing command-line arguments"
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGECHK   "Error checking failed to catch bad data"
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGEFLS   "Incorrect answer for valid data"
#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGEUSE   "Bad user-entered data"

Functions

 NRCSID (ZCOARSEGRAINFREQUENCYSERIESTESTC,"$Id: ZCoarseGrainFrequencySeriesTest.c,v 1.2 2007/06/08 14:42:01 bema Exp $")
int main (int argc, char *argv[])
 MAIN function of SideBandMCMC code Compute the posterior pdfs of the orbital and nuisance parameters of a binary signal in Fstat form.

Variables

char * optarg
int optind
int lalDebugLevel = LALNDEBUG
 DECLARE AND SET GLOBAL DEBUG LEVEL.
BOOLEAN optVerbose = ZCOARSEGRAINFREQUENCYSERIESTESTC_FALSE
UINT4 optInLength = 0
UINT4 optOutLength = 0
REAL8 optDeltaF = -1.0
REAL8 optF0 = 0.0
CHAR optInputFile [LALNameLength] = ""
CHAR optOutputFile [LALNameLength] = ""
INT4 code


Define Documentation

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_TOL   1e-15

Definition at line 169 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EPOCHSEC   1234

Definition at line 171 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EPOCHNS   56789

Definition at line 172 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF0   1.0

Definition at line 174 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F00   0.0

Definition at line 175 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH0   8

Definition at line 176 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF1   2.0

Definition at line 178 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F01   0.0

Definition at line 179 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH1   4

Definition at line 180 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF2   3.0

Definition at line 182 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F02   0.0

Definition at line 183 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH2   3

Definition at line 184 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF3   1.0

Definition at line 186 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F03   40.0

Definition at line 187 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH3   5

Definition at line 188 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_DELTAF4   2.0

Definition at line 190 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_F04   41.0

Definition at line 191 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_LENGTH4   2

Definition at line 192 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_TRUE   1

Definition at line 194 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_FALSE   0

Definition at line 195 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_ENOM   0

Definition at line 219 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EARG   1

Definition at line 220 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_ECHK   2

Definition at line 221 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EFLS   3

Definition at line 222 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_EUSE   4

Definition at line 223 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGENOM   "Nominal exit"

Definition at line 225 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGEARG   "Error parsing command-line arguments"

Definition at line 226 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGECHK   "Error checking failed to catch bad data"

Definition at line 227 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGEFLS   "Incorrect answer for valid data"

Definition at line 228 of file ZCoarseGrainFrequencySeriesTest.c.

#define ZCOARSEGRAINFREQUENCYSERIESTESTC_MSGEUSE   "Bad user-entered data"

Definition at line 229 of file ZCoarseGrainFrequencySeriesTest.c.


Function Documentation

NRCSID ( ZCOARSEGRAINFREQUENCYSERIESTESTC  ,
"$Id: ZCoarseGrainFrequencySeriesTest.  c,
v 1.2 2007/06/08 14:42:01 bema Exp $"   
)

int main ( int  argc,
char *  argv[] 
)

MAIN function of SideBandMCMC code Compute the posterior pdfs of the orbital and nuisance parameters of a binary signal in Fstat form.

..

variable declarations

the status must be initially blank; this can be done by making it static:

static LALStatus status;

other variables:

ExampleOutput output; ExampleInput input; ExampleParams params;

parse arguments, if desired

for example:

program = *argv; while ( --argc > 0 ) { ++argv; if ( ! strcmp( *argv, "-d" ) ) { --argc; ++argv; lalDebugLevel = atoi( *argv ); continue; } if ( ! strcmp( *argv, "-v" ) ) { verbose = 1; continue; } if ( ! strcmp( *argv, "-h" ) ) { fprintf( stderr, usage, program ); return 0; } fprintf( stderr, "no such option %s\n", *argv ); fprintf( stderr, usage, program ); return FAIL_ARGS; }

/** test response to invalid data

these tests must be wrapped so they are not done when debugging is disabled:

ifndef LAL_NDEBUG if ( ! lalNoDebug ) { LALExample( &status, NULL, &input, &params ); if ( status.statusCode != EXAMPLEH_ENULL || strcmp( status.statusDescription, EXAMPLEH_MSGENULL ) ) { fprintf( stderr, "incorrect error code %d and message %s\n", status.statusCode, status.statusDescription ); fprintf( stderr, "expecting error code %d and message %s\n", EXAMPLEH_ENULL, EXAMPLEH_MSGENULL ); return FAIL_CODE; }

fputs( "PASS: Test response to invalid data\n", stderr ); } endif

test response to valid data

for example:

LALExample( &status, &output, &input, &param ); if ( status.statusCode ) { fprintf( stderr, "received error code %d and message %s\n", status.statusCode, status.statusDescription ); return FAIL_ESUB; }

(perform checks on the contents of output too!)

during default operation, output to the screen should be minimal:

for ( i = 0; i < 1048576; ++i ) printf( "%d\n", i ); !!! BAD !!!

but it is OK to indicate that tests have passed:

fputs( "PASS: Test response to valid data\n", stderr );

check for memory leaks and return success:

LALCheckMemoryLeaks(); fputs( "PASS: All tests\n" );

Definition at line 233 of file ZCoarseGrainFrequencySeriesTest.c.


Variable Documentation

char* optarg

Definition at line 176 of file GeneralMeshTest.c.

int optind

Definition at line 149 of file packages/support/src/getopt.c.

int lalDebugLevel = LALNDEBUG

DECLARE AND SET GLOBAL DEBUG LEVEL.

see the section (currently 7.4.1) of the LSD on "Status-reporting objects" for a list of predefined debug levels

Definition at line 201 of file ZCoarseGrainFrequencySeriesTest.c.

BOOLEAN optVerbose = ZCOARSEGRAINFREQUENCYSERIESTESTC_FALSE

Definition at line 202 of file ZCoarseGrainFrequencySeriesTest.c.

UINT4 optInLength = 0

Definition at line 203 of file ZCoarseGrainFrequencySeriesTest.c.

UINT4 optOutLength = 0

Definition at line 204 of file ZCoarseGrainFrequencySeriesTest.c.

REAL8 optDeltaF = -1.0

Definition at line 205 of file ZCoarseGrainFrequencySeriesTest.c.

REAL8 optF0 = 0.0

Definition at line 206 of file ZCoarseGrainFrequencySeriesTest.c.

CHAR optInputFile[LALNameLength] = ""

Definition at line 208 of file ZCoarseGrainFrequencySeriesTest.c.

CHAR optOutputFile[LALNameLength] = ""

Definition at line 209 of file ZCoarseGrainFrequencySeriesTest.c.

INT4 code

Definition at line 210 of file ZCoarseGrainFrequencySeriesTest.c.


Generated on Sat Sep 6 03:08:40 2008 for LAL by  doxygen 1.5.2