Commit 79ab596b authored by Karl Wette's avatar Karl Wette Committed by Reinhard Prix

UserInput: transition to new XLALRegisterUvarMember() macro

- Remove deprecated XLALreg<TYPE>UserStruct() macros
- Refs #2966
Original: 31d1b79b0fc6d1b79cbfb96e739a35496f67adb5
parent b4bf43be
......@@ -88,15 +88,14 @@ extern "C" {
* uvar->andAString = NULL; // Note: need to assign allocated strings here as default!!
*
* // 2. step: Register all user-variables using the shortcut macros:
* XLALregBOOLUserStruct ( help, 'h', UVAR_HELP, "Output this help-message");
* XLALregINTUserStruct ( anInteger, 'i', UVAR_OPTIONAL, "An example user-variable of an optional integer");
* XLALregREALUserStruct ( aDoubleVar, 'r', UVAR_REQUIRED, "This REAL8 user-variable is required");
* XLALregSTRINGUserStruct( andAString, 0, UVAR_OPTIONAL, "Optional string-input, has no short-option");
* XLALregEPOCHUserStruct ( someEpoch, 0, UVAR_OPTIONAL, "Reference epoch (format 'xx.yy[GPS|MJD]')");
* XLALregRAJUserStruct ( RAJ, 0, UVAR_OPTIONAL, "Sky location: equatorial right ascension in [0,2pi] (in radians or hours:minutes:seconds)");
* XLALregDECJUserStruct ( DEC, 0, UVAR_OPTIONAL, "Sky location: equatorial declination [-pi/2,pi/2] (in radians or degrees:minutes:seconds)");
*
* XLALregREALUserStruct ( specialGeekSwitch, 'g', UVAR_DEVELOPER, "This REAL8 user-variable may not be relevant for standard usage");
* XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Output this help-message");
* XLALRegisterUvarMember( anInteger, INT4, 'i', OPTIONAL, "An example user-variable of an optional integer");
* XLALRegisterUvarMember( aDoubleVar, REAL8, 'r', REQUIRED, "This REAL8 user-variable is required");
* XLALRegisterUvarMember( andAString, STRING, 0, OPTIONAL, "Optional string-input, has no short-option");
* XLALRegisterUvarMember( someEpoch, EPOCH, 0, OPTIONAL, "Reference epoch (format 'xx.yy[GPS|MJD]')");
* XLALRegisterUvarMember( RAJ, RAJ, 0, OPTIONAL, "Sky location: equatorial right ascension in [0,2pi] (in radians or hours:minutes:seconds)");
* XLALRegisterUvarMember( DEC, DECJ, 0, OPTIONAL, "Sky location: equatorial declination [-pi/2,pi/2] (in radians or degrees:minutes:seconds)");
* XLALRegisterUvarMember( specialGeekSwitch, REAL8, 'g', DEVELOPER, "This REAL8 user-variable may not be relevant for standard usage");
*
* // 3. step: parse all user-input, from either config-file if given, or commandline (overloads config-file values)
* XLAL_CHECK ( XLALUserVarReadAllInput ( argc, argv ) == XLAL_SUCCESS, XLAL_EFUNC);
......@@ -150,41 +149,12 @@ someEpoch = {2147483596 s, 816000000 ns}, RA = 2.727813 rad, DEC = -0.523599 rad
/*@{*/
/**
* \name Shortcut Macro for registering new user variables, which are assumed
* Shortcut Macro for registering new user variables, which are assumed
* to be accessible via the \e struct-pointer '*uvar'
*/
#define XLALRegisterUvarMember(name,type,option,category,help) \
XLALRegister ##type## UserVar( #name, option, UVAR_CATEGORY_ ## category, help, &(uvar-> name))
/** \deprecated Use XLALRegisterUvarMember() instead.
*/
/*@{*/
#define XLALregREALUserStruct(name,option,category,help) \
XLALRegisterREAL8UserVar(#name, option, category, help, &(uvar-> name))
#define XLALregINTUserStruct(name,option,category,help) \
XLALRegisterINT4UserVar(#name, option,category, help, &(uvar-> name))
#define XLALregBOOLUserStruct(name,option,category,help) \
XLALRegisterBOOLEANUserVar(#name, option, category, help, &(uvar-> name))
#define XLALregSTRINGUserStruct(name,option,category,help) \
XLALRegisterSTRINGUserVar(#name, option, category, help, &(uvar-> name))
#define XLALregLISTUserStruct(name,option,category,help) \
XLALRegisterSTRINGVectorUserVar(#name, option, category, help, &(uvar-> name))
#define XLALregEPOCHUserStruct(name,option,category,help) \
XLALRegisterEPOCHUserVar(#name, option, category, help, &(uvar-> name))
#define XLALregRAJUserStruct(name,option,category,help) \
XLALRegisterRAJUserVar(#name, option, category, help, &(uvar-> name))
#define XLALregDECJUserStruct(name,option,category,help) \
XLALRegisterDECJUserVar(#name, option, category, help, &(uvar-> name))
/*@}*/
/// (mutually exclusive) UserVariable categories: optional, required, help, developer, ...
typedef enum {
UVAR_CATEGORY_START = 0, ///< internal start marker for range checking
......
......@@ -66,19 +66,19 @@ main(int argc, char *argv[])
UserInput_t *uvar = &my_uvars;
uvar->string2 = XLALStringDuplicate ( "this is the default value");
XLAL_CHECK ( XLALregREALUserStruct( argNum, 0, UVAR_REQUIRED, "Testing float argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregSTRINGUserStruct( argStr, 0, UVAR_REQUIRED, "Testing string argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregBOOLUserStruct( argBool, 0, UVAR_REQUIRED, "Testing bool argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregINTUserStruct( argInt, 'a', UVAR_REQUIRED, "Testing INT argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregINTUserStruct( dummy, 'c', UVAR_OPTIONAL, "Testing INT argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregBOOLUserStruct( argB2, 'b', UVAR_REQUIRED, "Testing short-option bool argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregSTRINGUserStruct( string2, 0, UVAR_REQUIRED, "Testing another string argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregEPOCHUserStruct( epochGPS, 0, UVAR_REQUIRED, "Testing epoch given as GPS time") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregEPOCHUserStruct( epochMJDTT, 0, UVAR_REQUIRED, "Testing epoch given as MJD(TT) time") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregRAJUserStruct( longHMS, 0, UVAR_REQUIRED, "Testing RAJ(HMS) argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregRAJUserStruct( longRad, 0, UVAR_REQUIRED, "Testing RAJ(rad) argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregDECJUserStruct( latDMS, 0, UVAR_REQUIRED, "Testing DECJ(DMS) argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALregDECJUserStruct( latRad, 0, UVAR_REQUIRED, "Testing DECJ(rad) argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( argNum, REAL8, 0, REQUIRED, "Testing float argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( argStr, STRING, 0, REQUIRED, "Testing string argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( argBool, BOOLEAN, 0, REQUIRED, "Testing bool argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( argInt, INT4, 'a', REQUIRED, "Testing INT argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( dummy, INT4, 'c', OPTIONAL, "Testing INT argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( argB2, BOOLEAN, 'b', REQUIRED, "Testing short-option bool argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( string2, STRING, 0, REQUIRED, "Testing another string argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( epochGPS, EPOCH, 0, REQUIRED, "Testing epoch given as GPS time") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( epochMJDTT, EPOCH, 0, REQUIRED, "Testing epoch given as MJD(TT) time") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( longHMS, RAJ, 0, REQUIRED, "Testing RAJ(HMS) argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( longRad, RAJ, 0, REQUIRED, "Testing RAJ(rad) argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( latDMS, DECJ, 0, REQUIRED, "Testing DECJ(DMS) argument") == XLAL_SUCCESS, XLAL_EFUNC );
XLAL_CHECK ( XLALRegisterUvarMember( latRad, DECJ, 0, REQUIRED, "Testing DECJ(rad) argument") == XLAL_SUCCESS, XLAL_EFUNC );
/* ---------- now read all input from commandline and config-file ---------- */
XLAL_CHECK ( XLALUserVarReadAllInput ( my_argc, my_argv ) == XLAL_SUCCESS, XLAL_EFUNC );
......
......@@ -127,9 +127,9 @@ main ( int argc, char *argv[] )
uvar->randSeed = 1;
uvar->Nruns = 1;
// ---------- register user-variable ----------
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP , "Print this help/usage message");
XLALregINTUserStruct ( randSeed, 's', UVAR_OPTIONAL, "Random-number seed");
XLALregINTUserStruct ( Nruns, 'r', UVAR_OPTIONAL, "Number of repeated timing 'runs' to average over (=improves variance)" );
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP , "Print this help/usage message");
XLALRegisterUvarMember( randSeed, INT4, 's', OPTIONAL, "Random-number seed");
XLALRegisterUvarMember( Nruns, INT4, 'r', OPTIONAL, "Number of repeated timing 'runs' to average over (=improves variance)" );
XLAL_CHECK ( XLALUserVarReadAllInput ( argc, argv ) == XLAL_SUCCESS, XLAL_EFUNC );
if ( uvar->help ) { /* if help was requested, we're done */
......
......@@ -489,12 +489,12 @@ ReadUserVars( int argc,char *argv[], UserInput_t *uvar, CHAR *clargs)
uvar->deltat = MIN_DT;
/* ---------- register all user-variables ---------- */
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP, "Print this message");
XLALregSTRINGUserStruct ( inputfile, 'i', UVAR_REQUIRED, "The input FITS file name");
XLALregSTRINGUserStruct ( outputdir, 'o', UVAR_REQUIRED, "The output frame file directory name");
XLALregREALUserStruct ( deltat, 't', UVAR_OPTIONAL, "The output sampling time (in seconds)");
XLALregBOOLUserStruct ( bary, 'b', UVAR_OPTIONAL, "Output barycentered data");
XLALregBOOLUserStruct ( version, 'V', UVAR_SPECIAL, "Output code version");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this message");
XLALRegisterUvarMember( inputfile, STRING, 'i', REQUIRED, "The input FITS file name");
XLALRegisterUvarMember( outputdir, STRING, 'o', REQUIRED, "The output frame file directory name");
XLALRegisterUvarMember( deltat, REAL8, 't', OPTIONAL, "The output sampling time (in seconds)");
XLALRegisterUvarMember( bary, BOOLEAN, 'b', OPTIONAL, "Output barycentered data");
XLALRegisterUvarMember( version, BOOLEAN, 'V', SPECIAL, "Output code version");
/* do ALL cmdline and cfgfile handling */
XLAL_CHECK ( XLALUserVarReadAllInput ( argc, argv ) == XLAL_SUCCESS, XLAL_EFUNC );
......
......@@ -963,115 +963,115 @@ initUserVars ( UserInput_t *uvar )
uvar->transient_useFReg = 0;
/* ---------- register all user-variables ---------- */
XLALregBOOLUserStruct( help, 'h', UVAR_HELP, "Print this message");
XLALregRAJUserStruct( Alpha, 'a', UVAR_OPTIONAL, "Sky: equatorial J2000 right ascension (in radians or hours:minutes:seconds)");
XLALregDECJUserStruct( Delta, 'd', UVAR_OPTIONAL, "Sky: equatorial J2000 declination (in radians or degrees:minutes:seconds)");
XLALregSTRINGUserStruct ( skyRegion, 'R', UVAR_OPTIONAL, "ALTERNATIVE: Sky-region polygon '(Alpha1,Delta1),(Alpha2,Delta2),...' or 'allsky'");
XLALregREALUserStruct( Freq, 'f', UVAR_OPTIONAL, "Starting search frequency Freq in Hz");
XLALregREALUserStruct( f1dot, 's', UVAR_OPTIONAL, "First spindown parameter f1dot = dFreq/dt");
XLALregREALUserStruct( f2dot, 0 , UVAR_OPTIONAL, "Second spindown parameter f2dot = d^2Freq/dt^2");
XLALregREALUserStruct( f3dot, 0 , UVAR_OPTIONAL, "Third spindown parameter f3dot = d^3Freq/dt^3");
XLALregRAJUserStruct( AlphaBand, 'z', UVAR_OPTIONAL, "Sky: search band from Alpha to Alpha+AlphaBand (in radians or h:m:s)");
XLALregDECJUserStruct( DeltaBand, 'c', UVAR_OPTIONAL, "Sky: search band from Delta to Delta+DeltaBand (in radians or d:m:s)");
XLALregREALUserStruct( FreqBand, 'b', UVAR_OPTIONAL, "Search band in frequency in Hz");
XLALregREALUserStruct( f1dotBand, 'm', UVAR_OPTIONAL, "Search band in f1dot in Hz/s");
XLALregREALUserStruct( f2dotBand, 0 , UVAR_OPTIONAL, "Search band in f2dot in Hz/s^2");
XLALregREALUserStruct( f3dotBand, 0 , UVAR_OPTIONAL, "Search band in f3dot in Hz/s^3");
XLALregRAJUserStruct( dAlpha, 'l', UVAR_OPTIONAL, "Sky: stepsize in Alpha (in radians or h:m:s)");
XLALregDECJUserStruct( dDelta, 'g', UVAR_OPTIONAL, "Sky: stepsize in Delta (in radians or d:m:s)");
XLALregREALUserStruct( dFreq, 'r', UVAR_OPTIONAL, "Stepsize for frequency in Hz");
XLALregREALUserStruct( df1dot, 'e', UVAR_OPTIONAL, "Stepsize for f1dot in Hz/s");
XLALregREALUserStruct( df2dot, 0 , UVAR_OPTIONAL, "Stepsize for f2dot in Hz/s^2");
XLALregREALUserStruct( df3dot, 0 , UVAR_OPTIONAL, "Stepsize for f3dot in Hz/s^3");
XLALregREALUserStruct( orbitasini, 0, UVAR_OPTIONAL, "Binary Orbit: Projected semi-major axis in light-seconds [Default: 0.0]");
XLALregREALUserStruct( orbitPeriod, 0, UVAR_OPTIONAL, "Binary Orbit: Period in seconds");
XLALregEPOCHUserStruct( orbitTp, 0, UVAR_OPTIONAL, "Binary Orbit: (true) epoch of periapsis: use 'xx.yy[GPS|MJD]' format.");
XLALregREALUserStruct( orbitArgp, 0, UVAR_OPTIONAL, "Binary Orbit: Orbital argument of periapse in radians");
XLALregREALUserStruct( orbitEcc, 0, UVAR_OPTIONAL, "Binary Orbit: Orbital eccentricity");
XLALregSTRINGUserStruct(DataFiles, 'D', UVAR_REQUIRED, "File-pattern specifying (also multi-IFO) input SFT-files");
XLALregSTRINGUserStruct(IFO, 'I', UVAR_OPTIONAL, "Detector: 'G1', 'L1', 'H1', 'H2' ...(useful for single-IFO v1-SFTs only!)");
XLALregBOOLUserStruct( SignalOnly, 'S', UVAR_OPTIONAL, "Signal only flag");
XLALregREALUserStruct( TwoFthreshold, 'F', UVAR_OPTIONAL, "Set the threshold for selection of 2F");
XLALregINTUserStruct( gridType, 0 , UVAR_OPTIONAL, "Grid: 0=flat, 1=isotropic, 2=metric, 3=skygrid-file, 6=grid-file, 8=spin-square, 9=spin-age-brk");
XLALregINTUserStruct( metricType, 'M', UVAR_OPTIONAL, "Metric: 0=none,1=Ptole-analytic,2=Ptole-numeric, 3=exact");
XLALregREALUserStruct( metricMismatch, 'X', UVAR_OPTIONAL, "Maximal allowed mismatch for metric tiling");
XLALregSTRINGUserStruct(outputLogfile, 0, UVAR_OPTIONAL, "Name of log-file identifying the code + search performed");
XLALregSTRINGUserStruct(gridFile, 0, UVAR_OPTIONAL, "Load grid from this file: sky-grid or full-grid depending on --gridType.");
XLALregEPOCHUserStruct(refTime, 0, UVAR_OPTIONAL, "Reference SSB epoch for pulsar-parameters: use 'xx.yy[GPS|MJD]' format [Default: startTime]");
XLALregSTRINGUserStruct(outputFstat, 0, UVAR_OPTIONAL, "Output-file for F-statistic field over the parameter-space");
XLALregSTRINGUserStruct(outputLoudest, 0, UVAR_OPTIONAL, "Loudest F-statistic candidate + estimated MLE amplitudes");
XLALregSTRINGUserStruct(outputFstatHist, 0, UVAR_OPTIONAL, "Output-file for a discrete histogram of all Fstatistic values");
XLALregREALUserStruct( FstatHistBin, 0, UVAR_OPTIONAL, "Width of an Fstatistic histogram bin");
XLALregINTUserStruct( NumCandidatesToKeep,0, UVAR_OPTIONAL, "Number of Fstat 'candidates' to keep. (0 = All)");
XLALregREALUserStruct(FracCandidatesToKeep,0, UVAR_OPTIONAL, "Fraction of Fstat 'candidates' to keep.");
XLALregINTUserStruct( clusterOnScanline, 0, UVAR_OPTIONAL, "Neighbors on each side for finding 1D local maxima on scanline");
XLALregEPOCHUserStruct(minStartTime, 0, UVAR_OPTIONAL, "Only use SFTs with timestamps starting from (including) this epoch (format 'xx.yy[GPS|MJD]') ");
XLALregEPOCHUserStruct(maxStartTime, 0, UVAR_OPTIONAL, "Only use SFTs with timestamps up to (excluding) this epoch (format 'xx.yy[GPS|MJD]')");
XLALregSTRINGUserStruct(outputFstatAtoms,0, UVAR_OPTIONAL, "Output filename *base* for F-statistic 'atoms' {a,b,Fa,Fb}_alpha. One file per doppler-point.");
XLALregBOOLUserStruct( outputSingleFstats,0, UVAR_OPTIONAL, "In multi-detector case, also output single-detector F-stats?");
XLALregSTRINGUserStruct(RankingStatistic,0, UVAR_DEVELOPER, "Rank toplist candidates according to 'F' or 'BSGL' statistic");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this message");
XLALRegisterUvarMember( Alpha, RAJ, 'a', OPTIONAL, "Sky: equatorial J2000 right ascension (in radians or hours:minutes:seconds)");
XLALRegisterUvarMember( Delta, DECJ, 'd', OPTIONAL, "Sky: equatorial J2000 declination (in radians or degrees:minutes:seconds)");
XLALRegisterUvarMember( skyRegion, STRING, 'R', OPTIONAL, "ALTERNATIVE: Sky-region polygon '(Alpha1,Delta1),(Alpha2,Delta2),...' or 'allsky'");
XLALRegisterUvarMember( Freq, REAL8, 'f', OPTIONAL, "Starting search frequency Freq in Hz");
XLALRegisterUvarMember( f1dot, REAL8, 's', OPTIONAL, "First spindown parameter f1dot = dFreq/dt");
XLALRegisterUvarMember( f2dot, REAL8, 0 , OPTIONAL, "Second spindown parameter f2dot = d^2Freq/dt^2");
XLALRegisterUvarMember( f3dot, REAL8, 0 , OPTIONAL, "Third spindown parameter f3dot = d^3Freq/dt^3");
XLALRegisterUvarMember( AlphaBand, RAJ, 'z', OPTIONAL, "Sky: search band from Alpha to Alpha+AlphaBand (in radians or h:m:s)");
XLALRegisterUvarMember( DeltaBand, DECJ, 'c', OPTIONAL, "Sky: search band from Delta to Delta+DeltaBand (in radians or d:m:s)");
XLALRegisterUvarMember( FreqBand, REAL8, 'b', OPTIONAL, "Search band in frequency in Hz");
XLALRegisterUvarMember( f1dotBand, REAL8, 'm', OPTIONAL, "Search band in f1dot in Hz/s");
XLALRegisterUvarMember( f2dotBand, REAL8, 0 , OPTIONAL, "Search band in f2dot in Hz/s^2");
XLALRegisterUvarMember( f3dotBand, REAL8, 0 , OPTIONAL, "Search band in f3dot in Hz/s^3");
XLALRegisterUvarMember( dAlpha, RAJ, 'l', OPTIONAL, "Sky: stepsize in Alpha (in radians or h:m:s)");
XLALRegisterUvarMember( dDelta, DECJ, 'g', OPTIONAL, "Sky: stepsize in Delta (in radians or d:m:s)");
XLALRegisterUvarMember( dFreq, REAL8, 'r', OPTIONAL, "Stepsize for frequency in Hz");
XLALRegisterUvarMember( df1dot, REAL8, 'e', OPTIONAL, "Stepsize for f1dot in Hz/s");
XLALRegisterUvarMember( df2dot, REAL8, 0 , OPTIONAL, "Stepsize for f2dot in Hz/s^2");
XLALRegisterUvarMember( df3dot, REAL8, 0 , OPTIONAL, "Stepsize for f3dot in Hz/s^3");
XLALRegisterUvarMember( orbitasini, REAL8, 0, OPTIONAL, "Binary Orbit: Projected semi-major axis in light-seconds [Default: 0.0]");
XLALRegisterUvarMember( orbitPeriod, REAL8, 0, OPTIONAL, "Binary Orbit: Period in seconds");
XLALRegisterUvarMember( orbitTp, EPOCH, 0, OPTIONAL, "Binary Orbit: (true) epoch of periapsis: use 'xx.yy[GPS|MJD]' format.");
XLALRegisterUvarMember( orbitArgp, REAL8, 0, OPTIONAL, "Binary Orbit: Orbital argument of periapse in radians");
XLALRegisterUvarMember( orbitEcc, REAL8, 0, OPTIONAL, "Binary Orbit: Orbital eccentricity");
XLALRegisterUvarMember(DataFiles, STRING, 'D', REQUIRED, "File-pattern specifying (also multi-IFO) input SFT-files");
XLALRegisterUvarMember(IFO, STRING, 'I', OPTIONAL, "Detector: 'G1', 'L1', 'H1', 'H2' ...(useful for single-IFO v1-SFTs only!)");
XLALRegisterUvarMember( SignalOnly, BOOLEAN, 'S', OPTIONAL, "Signal only flag");
XLALRegisterUvarMember( TwoFthreshold, REAL8, 'F', OPTIONAL, "Set the threshold for selection of 2F");
XLALRegisterUvarMember( gridType, INT4, 0 , OPTIONAL, "Grid: 0=flat, 1=isotropic, 2=metric, 3=skygrid-file, 6=grid-file, 8=spin-square, 9=spin-age-brk");
XLALRegisterUvarMember( metricType, INT4, 'M', OPTIONAL, "Metric: 0=none,1=Ptole-analytic,2=Ptole-numeric, 3=exact");
XLALRegisterUvarMember( metricMismatch, REAL8, 'X', OPTIONAL, "Maximal allowed mismatch for metric tiling");
XLALRegisterUvarMember(outputLogfile, STRING, 0, OPTIONAL, "Name of log-file identifying the code + search performed");
XLALRegisterUvarMember(gridFile, STRING, 0, OPTIONAL, "Load grid from this file: sky-grid or full-grid depending on --gridType.");
XLALRegisterUvarMember(refTime, EPOCH, 0, OPTIONAL, "Reference SSB epoch for pulsar-parameters: use 'xx.yy[GPS|MJD]' format [Default: startTime]");
XLALRegisterUvarMember(outputFstat, STRING, 0, OPTIONAL, "Output-file for F-statistic field over the parameter-space");
XLALRegisterUvarMember(outputLoudest, STRING, 0, OPTIONAL, "Loudest F-statistic candidate + estimated MLE amplitudes");
XLALRegisterUvarMember(outputFstatHist, STRING, 0, OPTIONAL, "Output-file for a discrete histogram of all Fstatistic values");
XLALRegisterUvarMember( FstatHistBin, REAL8, 0, OPTIONAL, "Width of an Fstatistic histogram bin");
XLALRegisterUvarMember( NumCandidatesToKeep,INT4, 0, OPTIONAL, "Number of Fstat 'candidates' to keep. (0 = All)");
XLALRegisterUvarMember(FracCandidatesToKeep,REAL8, 0, OPTIONAL, "Fraction of Fstat 'candidates' to keep.");
XLALRegisterUvarMember( clusterOnScanline, INT4, 0, OPTIONAL, "Neighbors on each side for finding 1D local maxima on scanline");
XLALRegisterUvarMember(minStartTime, EPOCH, 0, OPTIONAL, "Only use SFTs with timestamps starting from (including) this epoch (format 'xx.yy[GPS|MJD]') ");
XLALRegisterUvarMember(maxStartTime, EPOCH, 0, OPTIONAL, "Only use SFTs with timestamps up to (excluding) this epoch (format 'xx.yy[GPS|MJD]')");
XLALRegisterUvarMember(outputFstatAtoms,STRING, 0, OPTIONAL, "Output filename *base* for F-statistic 'atoms' {a,b,Fa,Fb}_alpha. One file per doppler-point.");
XLALRegisterUvarMember( outputSingleFstats,BOOLEAN, 0, OPTIONAL, "In multi-detector case, also output single-detector F-stats?");
XLALRegisterUvarMember(RankingStatistic,STRING, 0, DEVELOPER, "Rank toplist candidates according to 'F' or 'BSGL' statistic");
// ----- Line robust stats parameters ----------
XLALregBOOLUserStruct( computeBSGL, 0, UVAR_OPTIONAL, "Compute and output line-robust statistic BSGL ");
XLALregREALUserStruct( Fstar0, 0, UVAR_OPTIONAL, "BSGL: transition-scale parameter 'Fstar0'");
XLALregLISTUserStruct( oLGX, 0, UVAR_OPTIONAL, "BSGL: prior per-detector line-vs-Gauss odds 'oLGX' (Defaults to oLGX=1/Ndet)");
XLALregBOOLUserStruct( BSGLlogcorr, 0, UVAR_DEVELOPER,"BSGL: include log-correction terms (slower) or not (faster)");
XLALregREALUserStruct( BSGLthreshold, 0, UVAR_OPTIONAL, "BSGL threshold for candidate output");
XLALRegisterUvarMember( computeBSGL, BOOLEAN, 0, OPTIONAL, "Compute and output line-robust statistic BSGL ");
XLALRegisterUvarMember( Fstar0, REAL8, 0, OPTIONAL, "BSGL: transition-scale parameter 'Fstar0'");
XLALRegisterUvarMember( oLGX, STRINGVector, 0, OPTIONAL, "BSGL: prior per-detector line-vs-Gauss odds 'oLGX' (Defaults to oLGX=1/Ndet)");
XLALRegisterUvarMember( BSGLlogcorr, BOOLEAN, 0, DEVELOPER,"BSGL: include log-correction terms (slower) or not (faster)");
XLALRegisterUvarMember( BSGLthreshold, REAL8, 0, OPTIONAL, "BSGL threshold for candidate output");
// --------------------------------------------
XLALregSTRINGUserStruct(outputTransientStats,0, UVAR_OPTIONAL, "TransientCW: Output filename for transient-CW statistics.");
XLALregSTRINGUserStruct( transient_WindowType,0,UVAR_OPTIONAL, "TransientCW: Type of transient signal window to use. ('none', 'rect', 'exp').");
XLALregREALUserStruct ( transient_t0Days, 0, UVAR_OPTIONAL, "TransientCW: Earliest GPS start-time for transient window search, as offset in days from dataStartGPS");
XLALregREALUserStruct ( transient_t0DaysBand,0,UVAR_OPTIONAL, "TransientCW: Range of GPS start-times to search in transient search, in days");
XLALregINTUserStruct ( transient_dt0, 0, UVAR_OPTIONAL, "TransientCW: Step-size in transient-CW start-time in seconds [Default:Tsft]");
XLALregREALUserStruct( transient_tauDays,0, UVAR_OPTIONAL, "TransientCW: Minimal transient-CW duration timescale, in days");
XLALregREALUserStruct( transient_tauDaysBand,0, UVAR_OPTIONAL, "TransientCW: Range of transient-CW duration timescales to search, in days");
XLALregINTUserStruct ( transient_dtau, 0, UVAR_OPTIONAL, "TransientCW: Step-size in transient-CW duration timescale, in seconds [Default:Tsft]");
XLALRegisterUvarMember(outputTransientStats,STRING, 0, OPTIONAL, "TransientCW: Output filename for transient-CW statistics.");
XLALRegisterUvarMember( transient_WindowType,STRING, 0,OPTIONAL, "TransientCW: Type of transient signal window to use. ('none', 'rect', 'exp').");
XLALRegisterUvarMember( transient_t0Days, REAL8, 0, OPTIONAL, "TransientCW: Earliest GPS start-time for transient window search, as offset in days from dataStartGPS");
XLALRegisterUvarMember( transient_t0DaysBand,REAL8, 0,OPTIONAL, "TransientCW: Range of GPS start-times to search in transient search, in days");
XLALRegisterUvarMember( transient_dt0, INT4, 0, OPTIONAL, "TransientCW: Step-size in transient-CW start-time in seconds [Default:Tsft]");
XLALRegisterUvarMember( transient_tauDays,REAL8, 0, OPTIONAL, "TransientCW: Minimal transient-CW duration timescale, in days");
XLALRegisterUvarMember( transient_tauDaysBand,REAL8, 0, OPTIONAL, "TransientCW: Range of transient-CW duration timescales to search, in days");
XLALRegisterUvarMember( transient_dtau, INT4, 0, OPTIONAL, "TransientCW: Step-size in transient-CW duration timescale, in seconds [Default:Tsft]");
XLALregSTRINGUserStruct(FstatMethod, 0, UVAR_OPTIONAL, XLALFstatMethodHelpString() );
XLALRegisterUvarMember(FstatMethod, STRING, 0, OPTIONAL, XLALFstatMethodHelpString() );
XLALregBOOLUserStruct( version, 'V', UVAR_SPECIAL, "Output version information");
XLALRegisterUvarMember( version, BOOLEAN, 'V', SPECIAL, "Output version information");
/* ----- more experimental/expert options ----- */
XLALregREALUserStruct( dopplermax, 'q', UVAR_DEVELOPER, "Maximum doppler shift expected");
XLALregBOOLUserStruct( UseNoiseWeights,'W', UVAR_DEVELOPER, "Use per-SFT noise weights");
XLALregSTRINGUserStruct(ephemEarth, 0, UVAR_DEVELOPER, "Earth ephemeris file to use");
XLALregSTRINGUserStruct(ephemSun, 0, UVAR_DEVELOPER, "Sun ephemeris file to use");
XLALRegisterUvarMember( dopplermax, REAL8, 'q', DEVELOPER, "Maximum doppler shift expected");
XLALRegisterUvarMember( UseNoiseWeights,BOOLEAN, 'W', DEVELOPER, "Use per-SFT noise weights");
XLALRegisterUvarMember(ephemEarth, STRING, 0, DEVELOPER, "Earth ephemeris file to use");
XLALRegisterUvarMember(ephemSun, STRING, 0, DEVELOPER, "Sun ephemeris file to use");
XLALregINTUserStruct ( SSBprecision, 0, UVAR_DEVELOPER, "Precision to use for time-transformation to SSB: 0=Newtonian 1=relativistic");
XLALRegisterUvarMember( SSBprecision, INT4, 0, DEVELOPER, "Precision to use for time-transformation to SSB: 0=Newtonian 1=relativistic");
XLALregINTUserStruct( RngMedWindow, 'k', UVAR_DEVELOPER, "Running-Median window size");
XLALregINTUserStruct( Dterms, 't', UVAR_DEVELOPER, "Number of terms to keep in Dirichlet kernel sum");
XLALRegisterUvarMember( RngMedWindow, INT4, 'k', DEVELOPER, "Running-Median window size");
XLALRegisterUvarMember( Dterms, INT4, 't', DEVELOPER, "Number of terms to keep in Dirichlet kernel sum");
XLALregSTRINGUserStruct(workingDir, 'w', UVAR_DEVELOPER, "Directory to use as work directory.");
XLALregREALUserStruct( timerCount, 0, UVAR_DEVELOPER, "N: Output progress/timer info every N seconds");
XLALRegisterUvarMember(workingDir, STRING, 'w', DEVELOPER, "Directory to use as work directory.");
XLALRegisterUvarMember( timerCount, REAL8, 0, DEVELOPER, "N: Output progress/timer info every N seconds");
XLALregBOOLUserStruct( projectMetric, 0, UVAR_DEVELOPER, "Use projected metric on Freq=const subspact");
XLALRegisterUvarMember( projectMetric, BOOLEAN, 0, DEVELOPER, "Use projected metric on Freq=const subspact");
XLALregSTRINGUserStruct(outputLogPrintf, 0, UVAR_DEVELOPER, "Send all output from LogPrintf statements to this file");
XLALRegisterUvarMember(outputLogPrintf, STRING, 0, DEVELOPER, "Send all output from LogPrintf statements to this file");
XLALregBOOLUserStruct( countTemplates, 0, UVAR_DEVELOPER, "Count number of templates (if supported) instead of search");
XLALRegisterUvarMember( countTemplates, BOOLEAN, 0, DEVELOPER, "Count number of templates (if supported) instead of search");
XLALregREALUserStruct( spindownAge, 0, UVAR_DEVELOPER, "Spindown age for --gridType=9");
XLALregREALUserStruct( minBraking, 0, UVAR_DEVELOPER, "Minimum braking index for --gridType=9");
XLALregREALUserStruct( maxBraking, 0, UVAR_DEVELOPER, "Maximum braking index for --gridType=9");
XLALRegisterUvarMember( spindownAge, REAL8, 0, DEVELOPER, "Spindown age for --gridType=9");
XLALRegisterUvarMember( minBraking, REAL8, 0, DEVELOPER, "Minimum braking index for --gridType=9");
XLALRegisterUvarMember( maxBraking, REAL8, 0, DEVELOPER, "Maximum braking index for --gridType=9");
XLALregBOOLUserStruct(transient_useFReg, 0, UVAR_DEVELOPER, "FALSE: use 'standard' e^F for marginalization, if TRUE: use e^FReg = (1/D)*e^F (BAD)");
XLALRegisterUvarMember(transient_useFReg, BOOLEAN, 0, DEVELOPER, "FALSE: use 'standard' e^F for marginalization, if TRUE: use e^FReg = (1/D)*e^F (BAD)");
XLALregSTRINGUserStruct(outputTiming, 0, UVAR_DEVELOPER, "Append timing measurements and parameters into this file");
XLALRegisterUvarMember(outputTiming, STRING, 0, DEVELOPER, "Append timing measurements and parameters into this file");
// ---------- deprecated but still-supported or tolerated options ----------
XLALRegisterUvarMember ( RA, STRING, 0, DEPRECATED, "Use --Alpha instead" );
......
......@@ -278,41 +278,41 @@ initUserVars ( UserInput_t *uvar )
uvar->transientWindowType = XLALStringDuplicate ( "none" );
/* register all our user-variables */
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP, "Print this message");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this message");
XLALregREALUserStruct ( aPlus, 0 , UVAR_OPTIONAL, "'Plus' polarization amplitude: aPlus [alternative to {h0, cosi}");
XLALregREALUserStruct ( aCross, 0 , UVAR_OPTIONAL, "'Cross' polarization amplitude: aCross [alternative to {h0, cosi}");
XLALregREALUserStruct ( h0, 's', UVAR_OPTIONAL, "Overall GW amplitude h0 [alternative to {aPlus, aCross}]");
XLALregREALUserStruct ( cosi, 'i', UVAR_OPTIONAL, "Inclination angle of rotation axis cos(iota) [alternative to {aPlus, aCross}]");
XLALRegisterUvarMember( aPlus, REAL8, 0 , OPTIONAL, "'Plus' polarization amplitude: aPlus [alternative to {h0, cosi}");
XLALRegisterUvarMember( aCross, REAL8, 0 , OPTIONAL, "'Cross' polarization amplitude: aCross [alternative to {h0, cosi}");
XLALRegisterUvarMember( h0, REAL8, 's', OPTIONAL, "Overall GW amplitude h0 [alternative to {aPlus, aCross}]");
XLALRegisterUvarMember( cosi, REAL8, 'i', OPTIONAL, "Inclination angle of rotation axis cos(iota) [alternative to {aPlus, aCross}]");
XLALregREALUserStruct ( psi, 0, UVAR_REQUIRED, "Polarisation angle in radians");
XLALregREALUserStruct ( phi0, 0, UVAR_OPTIONAL, "Initial GW phase phi0 in radians");
XLALRegisterUvarMember( psi, REAL8, 0, REQUIRED, "Polarisation angle in radians");
XLALRegisterUvarMember( phi0, REAL8, 0, OPTIONAL, "Initial GW phase phi0 in radians");
XLALregREALUserStruct ( Alpha, 'a', UVAR_REQUIRED, "Sky position alpha (equatorial coordinates) in radians");
XLALregREALUserStruct ( Delta, 'd', UVAR_REQUIRED, "Sky position delta (equatorial coordinates) in radians");
XLALregREALUserStruct ( Freq, 'F', UVAR_REQUIRED, "GW signal frequency (only used for noise-estimation in SFTs)");
XLALRegisterUvarMember( Alpha, REAL8, 'a', REQUIRED, "Sky position alpha (equatorial coordinates) in radians");
XLALRegisterUvarMember( Delta, REAL8, 'd', REQUIRED, "Sky position delta (equatorial coordinates) in radians");
XLALRegisterUvarMember( Freq, REAL8, 'F', REQUIRED, "GW signal frequency (only used for noise-estimation in SFTs)");
XLALregSTRINGUserStruct ( DataFiles, 'D', UVAR_REQUIRED, "File-pattern specifying (multi-IFO) input SFT-files");
XLALregSTRINGUserStruct ( IFO, 'I', UVAR_OPTIONAL, "Detector-constraint: 'G1', 'L1', 'H1', 'H2' ...(useful for single-IFO v1-SFTs only!)");
XLALregSTRINGUserStruct ( ephemEarth, 0, UVAR_OPTIONAL, "Earth ephemeris file to use");
XLALregSTRINGUserStruct ( ephemSun, 0, UVAR_OPTIONAL, "Sun ephemeris file to use");
XLALregSTRINGUserStruct ( outputFstat, 0, UVAR_OPTIONAL, "Output-file for predicted F-stat value" );
XLALregBOOLUserStruct ( printFstat, 0, UVAR_OPTIONAL, "Print predicted F-stat value to terminal" );
XLALRegisterUvarMember( DataFiles, STRING, 'D', REQUIRED, "File-pattern specifying (multi-IFO) input SFT-files");
XLALRegisterUvarMember( IFO, STRING, 'I', OPTIONAL, "Detector-constraint: 'G1', 'L1', 'H1', 'H2' ...(useful for single-IFO v1-SFTs only!)");
XLALRegisterUvarMember( ephemEarth, STRING, 0, OPTIONAL, "Earth ephemeris file to use");
XLALRegisterUvarMember( ephemSun, STRING, 0, OPTIONAL, "Sun ephemeris file to use");
XLALRegisterUvarMember( outputFstat, STRING, 0, OPTIONAL, "Output-file for predicted F-stat value" );
XLALRegisterUvarMember( printFstat, BOOLEAN, 0, OPTIONAL, "Print predicted F-stat value to terminal" );
XLALregINTUserStruct ( minStartTime, 0, UVAR_OPTIONAL, "Only use SFTs with timestamps starting from (including) this GPS time");
XLALregINTUserStruct ( maxStartTime, 0, UVAR_OPTIONAL, "Only use SFTs with timestamps up to (excluding) this GPS time");
XLALRegisterUvarMember( minStartTime, INT4, 0, OPTIONAL, "Only use SFTs with timestamps starting from (including) this GPS time");
XLALRegisterUvarMember( maxStartTime, INT4, 0, OPTIONAL, "Only use SFTs with timestamps up to (excluding) this GPS time");
XLALregLISTUserStruct ( assumeSqrtSX, 0, UVAR_OPTIONAL, "Don't estimate noise-floors but assume (stationary) per-IFO sqrt{SX} (if single value: use for all IFOs)");
XLALregBOOLUserStruct ( SignalOnly, 'S', UVAR_DEVELOPER,"DEPRECATED ALTERNATIVE: Don't estimate noise-floors but assume sqrtSX=1 instead");
XLALRegisterUvarMember( assumeSqrtSX, STRINGVector, 0, OPTIONAL, "Don't estimate noise-floors but assume (stationary) per-IFO sqrt{SX} (if single value: use for all IFOs)");
XLALRegisterUvarMember( SignalOnly, BOOLEAN, 'S', DEVELOPER,"DEPRECATED ALTERNATIVE: Don't estimate noise-floors but assume sqrtSX=1 instead");
XLALregBOOLUserStruct ( version, 'V', UVAR_SPECIAL, "Output code version");
XLALRegisterUvarMember( version, BOOLEAN, 'V', SPECIAL, "Output code version");
XLALregINTUserStruct ( RngMedWindow, 'k', UVAR_DEVELOPER, "Running-Median window size");
XLALRegisterUvarMember( RngMedWindow, INT4, 'k', DEVELOPER, "Running-Median window size");
/* transient signal window properties (name, start, duration) */
XLALregSTRINGUserStruct ( transientWindowType, 0, UVAR_OPTIONAL, "Name of transient signal window to use. ('none', 'rect', 'exp').");
XLALregREALUserStruct ( transientStartTime, 0, UVAR_OPTIONAL, "GPS start-time 't0' of transient signal window.");
XLALregREALUserStruct ( transientTauDays, 0, UVAR_OPTIONAL, "Timescale 'tau' of transient signal window in seconds.");
XLALRegisterUvarMember( transientWindowType, STRING, 0, OPTIONAL, "Name of transient signal window to use. ('none', 'rect', 'exp').");
XLALRegisterUvarMember( transientStartTime, REAL8, 0, OPTIONAL, "GPS start-time 't0' of transient signal window.");
XLALRegisterUvarMember( transientTauDays, REAL8, 0, OPTIONAL, "Timescale 'tau' of transient signal window in seconds.");
return XLAL_SUCCESS;
......
......@@ -120,14 +120,14 @@ XLALinitUserVars ( UserVariables_t *uvar )
uvar->tol_atMax = 5e-2;
/* now register all user-variables */
XLALregSTRINGUserStruct ( Fname1, '1', UVAR_REQUIRED, "Path and basefilename for first Fstats file");
XLALregSTRINGUserStruct ( Fname2, '2', UVAR_REQUIRED, "Path and basefilename for second Fstats file");
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP, "Print this help/usage message");
XLALregREALUserStruct ( tol_L1, 0, UVAR_OPTIONAL, "tolerance on relative error between vectors using L1 norm, between [0,2]");
XLALregREALUserStruct ( tol_L2, 0, UVAR_OPTIONAL, "tolerance on relative error between vectors using L2 norm, between [0,2]");
XLALregREALUserStruct ( tol_angle, 0, UVAR_OPTIONAL, "tolerance on angle between the two vectors in radians, between [0,pi]");
XLALregREALUserStruct ( tol_atMax, 0, UVAR_OPTIONAL, "tolerance on single-sample relative error *at* respective maximum, between [0,2]");
XLALRegisterUvarMember( Fname1, STRING, '1', REQUIRED, "Path and basefilename for first Fstats file");
XLALRegisterUvarMember( Fname2, STRING, '2', REQUIRED, "Path and basefilename for second Fstats file");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this help/usage message");
XLALRegisterUvarMember( tol_L1, REAL8, 0, OPTIONAL, "tolerance on relative error between vectors using L1 norm, between [0,2]");
XLALRegisterUvarMember( tol_L2, REAL8, 0, OPTIONAL, "tolerance on relative error between vectors using L2 norm, between [0,2]");
XLALRegisterUvarMember( tol_angle, REAL8, 0, OPTIONAL, "tolerance on angle between the two vectors in radians, between [0,pi]");
XLALRegisterUvarMember( tol_atMax, REAL8, 0, OPTIONAL, "tolerance on single-sample relative error *at* respective maximum, between [0,2]");
return XLAL_SUCCESS;
......
......@@ -356,31 +356,31 @@ initUserVars ( UserInput_t *uvar )
uvar->E = 0; /* RAA approximation antenna-pattern matrix component M_{14}. Zero if using LWL */
/* register all our user-variables */
XLALregBOOLUserStruct( help, 'h', UVAR_HELP, "Print this message");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this message");
XLALregREALUserStruct( h0Nat, 's', UVAR_OPTIONAL, "Overall GW amplitude h0 in *natural units*: h0Nat = h0 sqrt(T/Sn) ");
XLALregREALUserStruct( h0NatBand, 0, UVAR_OPTIONAL, "Randomize amplitude within [h0, h0+h0Band] with uniform prior");
XLALregREALUserStruct( SNR, 0, UVAR_OPTIONAL, "Alternative: adjust h0 to obtain signal of exactly this optimal SNR");
XLALRegisterUvarMember( h0Nat, REAL8, 's', OPTIONAL, "Overall GW amplitude h0 in *natural units*: h0Nat = h0 sqrt(T/Sn) ");
XLALRegisterUvarMember( h0NatBand, REAL8, 0, OPTIONAL, "Randomize amplitude within [h0, h0+h0Band] with uniform prior");
XLALRegisterUvarMember( SNR, REAL8, 0, OPTIONAL, "Alternative: adjust h0 to obtain signal of exactly this optimal SNR");
XLALregREALUserStruct( cosi, 'i', UVAR_OPTIONAL, "cos(inclination angle). If not set: randomize within [-1,1].");
XLALregREALUserStruct( psi, 0, UVAR_OPTIONAL, "polarization angle psi. If not set: randomize within [-pi/4,pi/4].");
XLALregREALUserStruct( phi0, 0, UVAR_OPTIONAL, "initial GW phase phi_0. If not set: randomize within [0, 2pi]");
XLALRegisterUvarMember( cosi, REAL8, 'i', OPTIONAL, "cos(inclination angle). If not set: randomize within [-1,1].");
XLALRegisterUvarMember( psi, REAL8, 0, OPTIONAL, "polarization angle psi. If not set: randomize within [-pi/4,pi/4].");
XLALRegisterUvarMember( phi0, REAL8, 0, OPTIONAL, "initial GW phase phi_0. If not set: randomize within [0, 2pi]");
XLALregREALUserStruct( A, 0, UVAR_REQUIRED, "Antenna-pattern matrix MNat_mu_nu: component {1,1} = A = <|a|^2>");
XLALregREALUserStruct( B, 0, UVAR_REQUIRED, "Antenna-pattern matrix MNat_mu_nu: component {2,2} = B = <|b|^2>");
XLALregREALUserStruct( C, 0, UVAR_REQUIRED, "Antenna-pattern matrix MNat_mu_nu: component {1,2} = C = <Re(b a*)>");
XLALregREALUserStruct( E, 0, UVAR_OPTIONAL, "Antenna-pattern matrix MNat_mu_nu: component {1,4} = E = <Im(b a*)>");
XLALRegisterUvarMember( A, REAL8, 0, REQUIRED, "Antenna-pattern matrix MNat_mu_nu: component {1,1} = A = <|a|^2>");
XLALRegisterUvarMember( B, REAL8, 0, REQUIRED, "Antenna-pattern matrix MNat_mu_nu: component {2,2} = B = <|b|^2>");
XLALRegisterUvarMember( C, REAL8, 0, REQUIRED, "Antenna-pattern matrix MNat_mu_nu: component {1,2} = C = <Re(b a*)>");
XLALRegisterUvarMember( E, REAL8, 0, OPTIONAL, "Antenna-pattern matrix MNat_mu_nu: component {1,4} = E = <Im(b a*)>");
XLALregREALUserStruct( numDraws, 'N', UVAR_OPTIONAL, "Number of random 'draws' to simulate for F-stat and B-stat");
XLALRegisterUvarMember( numDraws, REAL8, 'N', OPTIONAL, "Number of random 'draws' to simulate for F-stat and B-stat");
XLALregSTRINGUserStruct( outputStats, 'o', UVAR_OPTIONAL, "Output file containing 'numDraws' random draws of lnL, 2F and B");
XLALRegisterUvarMember( outputStats, STRING, 'o', OPTIONAL, "Output file containing 'numDraws' random draws of lnL, 2F and B");
XLALregINTUserStruct( integrationMethod,'m', UVAR_OPTIONAL, "2D Integration-method: 0=Gauss-Kronod, 1=Monte-Carlo(Vegas)");
XLALregREALUserStruct( numMCpoints, 'M', UVAR_OPTIONAL, "Number of points to use in Monte-Carlo integration");
XLALRegisterUvarMember( integrationMethod,INT4, 'm', OPTIONAL, "2D Integration-method: 0=Gauss-Kronod, 1=Monte-Carlo(Vegas)");
XLALRegisterUvarMember( numMCpoints, REAL8, 'M', OPTIONAL, "Number of points to use in Monte-Carlo integration");
XLALregBOOLUserStruct( SignalOnly, 'S', UVAR_SPECIAL, "No noise-draws: will result in non-random 'signal only' values for F and B");
XLALRegisterUvarMember( SignalOnly, BOOLEAN, 'S', SPECIAL, "No noise-draws: will result in non-random 'signal only' values for F and B");
XLALregBOOLUserStruct( version, 'V', UVAR_SPECIAL, "Output code version");
XLALRegisterUvarMember( version, BOOLEAN, 'V', SPECIAL, "Output code version");
return XLAL_SUCCESS;
......
......@@ -456,54 +456,54 @@ XLALInitUserVars ( UserInput_t *uvar )
#define DEFAULT_TRANSIENT "rect"
/* register all our user-variables */
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP, "Print this message");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this message");
/* signal Doppler parameters */
XLALregREALUserStruct ( Alpha, 'a', UVAR_OPTIONAL, "Sky position alpha (equatorial coordinates) in radians [Default:allsky]");
XLALregREALUserStruct ( Delta, 'd', UVAR_OPTIONAL, "Sky position delta (equatorial coordinates) in radians [Default:allsky]");
XLALRegisterUvarMember( Alpha, REAL8, 'a', OPTIONAL, "Sky position alpha (equatorial coordinates) in radians [Default:allsky]");
XLALRegisterUvarMember( Delta, REAL8, 'd', OPTIONAL, "Sky position delta (equatorial coordinates) in radians [Default:allsky]");
/* signal amplitude parameters */
XLALregREALUserStruct ( fixedh0Nat, 0, UVAR_OPTIONAL, "Alternative 1: if >=0 fix the GW amplitude: h0/sqrt(Sn)");
XLALregREALUserStruct ( fixedSNR, 0, UVAR_OPTIONAL, "Alternative 2: if >=0 fix the optimal SNR of the injected signals");
XLALreg