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 );
......
......@@ -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");
XLALregREALUserStruct ( fixedh0NatMax, 0, UVAR_OPTIONAL, "Alternative 3: if >=0 draw GW amplitude h0 in [0, h0NatMax ] (FReg prior)");
XLALregREALUserStruct ( fixedRhohMax, 0, UVAR_OPTIONAL, "Alternative 4: if >=0 draw rhoh=h0*(detM)^(1/8) in [0, rhohMax] (canonical F-stat prior)");
XLALRegisterUvarMember( fixedh0Nat, REAL8, 0, OPTIONAL, "Alternative 1: if >=0 fix the GW amplitude: h0/sqrt(Sn)");
XLALRegisterUvarMember( fixedSNR, REAL8, 0, OPTIONAL, "Alternative 2: if >=0 fix the optimal SNR of the injected signals");
XLALRegisterUvarMember( fixedh0NatMax, REAL8, 0, OPTIONAL, "Alternative 3: if >=0 draw GW amplitude h0 in [0, h0NatMax ] (FReg prior)");
XLALRegisterUvarMember( fixedRhohMax, REAL8, 0, OPTIONAL, "Alternative 4: if >=0 draw rhoh=h0*(detM)^(1/8) in [0, rhohMax] (canonical F-stat prior)");
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]");
XLALregINTUserStruct ( AmpPriorType, 0, UVAR_OPTIONAL, "Enumeration of types of amplitude-priors: 0=physical, 1=canonical");
XLALRegisterUvarMember( AmpPriorType, INT4, 0, OPTIONAL, "Enumeration of types of amplitude-priors: 0=physical, 1=canonical");
XLALregLISTUserStruct( IFOs, 'I', UVAR_OPTIONAL, "Comma-separated list of detectors, eg. \"H1,H2,L1,G1, ...\" ");
XLALregSTRINGUserStruct ( lineIFO, 0, UVAR_OPTIONAL, "Insert a line (signal in this one IFO, pure gaussian noise in others), e.g. \"H1\"");
XLALregINTUserStruct ( dataStartGPS, 0, UVAR_OPTIONAL, "data start-time in GPS seconds");
XLALregINTUserStruct ( dataDuration, 0, UVAR_OPTIONAL, "data-span to generate (in seconds)");
XLALRegisterUvarMember( IFOs, STRINGVector, 'I', OPTIONAL, "Comma-separated list of detectors, eg. \"H1,H2,L1,G1, ...\" ");
XLALRegisterUvarMember( lineIFO, STRING, 0, OPTIONAL, "Insert a line (signal in this one IFO, pure gaussian noise in others), e.g. \"H1\"");
XLALRegisterUvarMember( dataStartGPS, INT4, 0, OPTIONAL, "data start-time in GPS seconds");
XLALRegisterUvarMember( dataDuration, INT4, 0, OPTIONAL, "data-span to generate (in seconds)");
/* misc params */
XLALregBOOLUserStruct ( computeBSGL, 0, UVAR_OPTIONAL, "Compute 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, length must be numDetectors. (Defaults to oLGX=1/Ndet)");
XLALRegisterUvarMember( computeBSGL, BOOLEAN, 0, OPTIONAL, "Compute 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, length must be numDetectors. (Defaults to oLGX=1/Ndet)");
XLALregLISTUserStruct ( sqrtSX, 0, UVAR_OPTIONAL, "Per-detector noise PSD sqrt(SX). Only ratios relevant to compute noise weights. Defaults to 1,1,...");
XLALRegisterUvarMember( sqrtSX, STRINGVector, 0, OPTIONAL, "Per-detector noise PSD sqrt(SX). Only ratios relevant to compute noise weights. Defaults to 1,1,...");
XLALregINTUserStruct ( numDraws, 'N', UVAR_OPTIONAL,"Number of random 'draws' to simulate");
XLALregINTUserStruct ( randSeed, 0, UVAR_OPTIONAL, "GSL random-number generator seed value to use");
XLALRegisterUvarMember( numDraws, INT4, 'N', OPTIONAL,"Number of random 'draws' to simulate");
XLALRegisterUvarMember( randSeed, INT4, 0, OPTIONAL, "GSL random-number generator seed value to use");
XLALregSTRINGUserStruct ( outputStats, 'o', UVAR_OPTIONAL, "Output file containing 'numDraws' random draws of stats");
XLALregSTRINGUserStruct ( outputAtoms, 0, UVAR_OPTIONAL, "Output F-statistic atoms into a file with this basename");
XLALregSTRINGUserStruct ( outputInjParams, 0, UVAR_OPTIONAL, "Output injection parameters into this file");
XLALregBOOLUserStruct ( outputMmunuX, 0, UVAR_OPTIONAL, "Write the per-IFO antenna pattern matrices into the parameter file");
XLALRegisterUvarMember( outputStats, STRING, 'o', OPTIONAL, "Output file containing 'numDraws' random draws of stats");
XLALRegisterUvarMember( outputAtoms, STRING, 0, OPTIONAL, "Output F-statistic atoms into a file with this basename");
XLALRegisterUvarMember( outputInjParams, STRING, 0, OPTIONAL, "Output injection parameters into this file");
XLALRegisterUvarMember( outputMmunuX, BOOLEAN, 0, OPTIONAL, "Write the per-IFO antenna pattern matrices into the parameter file");
XLALregBOOLUserStruct ( SignalOnly, 'S', UVAR_OPTIONAL, "Signal only: generate pure signal without noise");
XLALregBOOLUserStruct ( useFReg, 0, UVAR_OPTIONAL, "use 'regularized' Fstat (1/D)*e^F (if TRUE) for marginalization, or 'standard' e^F (if FALSE)");
XLALRegisterUvarMember( SignalOnly, BOOLEAN, 'S', OPTIONAL, "Signal only: generate pure signal without noise");
XLALRegisterUvarMember( useFReg, BOOLEAN, 0, OPTIONAL, "use 'regularized' Fstat (1/D)*e^F (if TRUE) for marginalization, or 'standard' e^F (if FALSE)");
XLALregSTRINGUserStruct ( ephemEarth, 0, UVAR_OPTIONAL, "Earth ephemeris file to use");
XLALregSTRINGUserStruct ( ephemSun, 0, UVAR_OPTIONAL, "Sun ephemeris file to use");
XLALRegisterUvarMember( ephemEarth, STRING, 0, OPTIONAL, "Earth ephemeris file to use");
XLALRegisterUvarMember( ephemSun, STRING, 0, OPTIONAL, "Sun ephemeris file to use");
XLALregBOOLUserStruct ( version, 'V', UVAR_SPECIAL, "Output code version");
XLALRegisterUvarMember( version, BOOLEAN, 'V', SPECIAL, "Output code version");
/* 'hidden' stuff */
XLALregINTUserStruct ( TAtom, 0, UVAR_DEVELOPER, "Time baseline for Fstat-atoms (typically Tsft) in seconds." );
XLALRegisterUvarMember( TAtom, INT4, 0, DEVELOPER, "Time baseline for Fstat-atoms (typically Tsft) in seconds." );
if ( xlalErrno ) {
XLALPrintError ("%s: something failed in initializing user variabels .. errno = %d.\n", __func__, xlalErrno );
......
......@@ -203,11 +203,11 @@ initUserVars ( UserInput_t *uvar )
/* now register all our user-variable */
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP, "Print this help/usage message");
XLALregSTRINGUserStruct ( sftBname1, '1', UVAR_REQUIRED, "Path and basefilename for SFTs1");
XLALregSTRINGUserStruct ( sftBname2, '2', UVAR_REQUIRED, "Path and basefilename for SFTs2");
XLALregBOOLUserStruct ( verbose, 'v', UVAR_OPTIONAL, "Verbose output of differences");
XLALregREALUserStruct ( relErrorMax, 'e', UVAR_OPTIONAL, "Maximal relative error acceptable to 'pass' comparison");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this help/usage message");
XLALRegisterUvarMember( sftBname1, STRING, '1', REQUIRED, "Path and basefilename for SFTs1");
XLALRegisterUvarMember( sftBname2, STRING, '2', REQUIRED, "Path and basefilename for SFTs2");
XLALRegisterUvarMember( verbose, BOOLEAN, 'v', OPTIONAL, "Verbose output of differences");
XLALRegisterUvarMember( relErrorMax, REAL8, 'e', OPTIONAL, "Maximal relative error acceptable to 'pass' comparison");
return XLAL_SUCCESS;
......
......@@ -123,12 +123,12 @@ initUserVars ( UserVar *uvar )
uvar->relErrorMax = 1e-4;
/* now register all our user-variable */
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP, "Print this help/usage message");
XLALregSTRINGUserStruct ( infile1, '1', UVAR_REQUIRED, "First timeseries input file");
XLALregSTRINGUserStruct ( infile2, '2', UVAR_REQUIRED, "Second timeseries input file");
XLALregBOOLUserStruct ( verbose, 'v', UVAR_OPTIONAL, "Verbose output of differences");
XLALregREALUserStruct ( relErrorMax, 'e', UVAR_OPTIONAL, "Maximal relative error acceptable to 'pass' comparison");
XLALregBOOLUserStruct ( version, 'V', UVAR_SPECIAL, "Output version information");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this help/usage message");
XLALRegisterUvarMember( infile1, STRING, '1', REQUIRED, "First timeseries input file");
XLALRegisterUvarMember( infile2, STRING, '2', REQUIRED, "Second timeseries input file");
XLALRegisterUvarMember( verbose, BOOLEAN, 'v', OPTIONAL, "Verbose output of differences");
XLALRegisterUvarMember( relErrorMax, REAL8, 'e', OPTIONAL, "Maximal relative error acceptable to 'pass' comparison");
XLALRegisterUvarMember( version, BOOLEAN, 'V', SPECIAL, "Output version information");
return XLAL_SUCCESS;
} /* initUserVars() */
......
......@@ -182,10 +182,10 @@ XLALprintData ( const SFTtype *sft )
int
XLALReadUserInput ( int argc, char *argv[], UserVariables_t *uvar )
{
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP, "Print this help/usage message");
XLALregSTRINGUserStruct ( SFTfiles, 'i', UVAR_REQUIRED, "File-pattern for input SFTs");
XLALregBOOLUserStruct ( headerOnly, 'H', UVAR_OPTIONAL, "Output only header-info");
XLALregBOOLUserStruct ( noHeader, 'n', UVAR_OPTIONAL, "Output only data, no header");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP, "Print this help/usage message");
XLALRegisterUvarMember( SFTfiles, STRING, 'i', REQUIRED, "File-pattern for input SFTs");
XLALRegisterUvarMember( headerOnly, BOOLEAN, 'H', OPTIONAL, "Output only header-info");
XLALRegisterUvarMember( noHeader, BOOLEAN, 'n', OPTIONAL, "Output only data, no header");
/* read cmdline & cfgfile */
XLAL_CHECK ( XLALUserVarReadAllInput ( argc, argv ) == XLAL_SUCCESS, XLAL_EFUNC );
......
......@@ -554,57 +554,57 @@ XLALInitUserVars ( UserVariables_t *uvar, int argc, char *argv[] )
XLAL_CHECK ( (uvar->outLabel = XLALStringDuplicate ( MISC_DEFAULT )) != NULL, XLAL_EFUNC );
// ---------- register all our user-variable ----------
XLALregBOOLUserStruct ( help, 'h', UVAR_HELP , "Print this help/usage message");
XLALRegisterUvarMember( help, BOOLEAN, 'h', HELP , "Print this help/usage message");
/* output options */
XLALregBOOLUserStruct ( outSingleSFT, 's', UVAR_OPTIONAL, "Write a single concatenated SFT file instead of individual files" );
XLALregSTRINGUserStruct ( outSFTdir, 'n', UVAR_OPTIONAL, "Output SFTs: directory for output SFTs");
XLALregSTRINGUserStruct( outLabel, 0, UVAR_OPTIONAL, "'misc' entry in SFT-filenames or 'description' entry of frame filenames" );
XLALRegisterUvarMember( outSingleSFT, BOOLEAN, 's', OPTIONAL, "Write a single concatenated SFT file instead of individual files" );
XLALRegisterUvarMember( outSFTdir, STRING, 'n', OPTIONAL, "Output SFTs: directory for output SFTs");
XLALRegisterUvarMember( outLabel, STRING, 0, OPTIONAL, "'misc' entry in SFT-filenames or 'description' entry of frame filenames" );
#ifdef HAVE_LIBLALFRAME
XLALRegisterUvarMember ( outFrameDir, STRING, 'F', OPTIONAL, "Output Frames: directory for output timeseries frame files");
#endif
XLALregSTRINGUserStruct ( TDDfile, 't', UVAR_OPTIONAL, "Filename to output time-series into");
XLALRegisterUvarMember( TDDfile, STRING, 't', OPTIONAL, "Filename to output time-series into");
XLALregSTRINGUserStruct ( logfile, 'l', UVAR_OPTIONAL, "Filename for log-output");
XLALRegisterUvarMember( logfile, STRING, 'l', OPTIONAL, "Filename for log-output");
/* detectors and respective noise-floors */
XLALregLISTUserStruct ( IFOs, 'I', UVAR_OPTIONAL, "CSV list of detectors, eg. \"H1,H2,L1,G1, ...\" ");
XLALregLISTUserStruct ( sqrtSX, 0, UVAR_OPTIONAL, "Add Gaussian Noise: CSV list of detectors' noise-floors sqrt{Sn}");
XLALRegisterUvarMember( IFOs, STRINGVector, 'I', OPTIONAL, "CSV list of detectors, eg. \"H1,H2,L1,G1, ...\" ");
XLALRegisterUvarMember( sqrtSX, STRINGVector, 0, OPTIONAL, "Add Gaussian Noise: CSV list of detectors' noise-floors sqrt{Sn}");
XLALregSTRINGUserStruct( ephemEarth, 0, UVAR_OPTIONAL, "Earth ephemeris file to use");
XLALregSTRINGUserStruct( ephemSun, 0, UVAR_OPTIONAL, "Sun ephemeris file to use");
XLALRegisterUvarMember( ephemEarth, STRING, 0, OPTIONAL, "Earth ephemeris file to use");
XLALRegisterUvarMember( ephemSun, STRING, 0, OPTIONAL, "Sun ephemeris file to use");
/* start + duration of timeseries */
XLALregEPOCHUserStruct (startTime, 'G', UVAR_OPTIONAL, "Start-time of requested signal in detector-frame (format 'xx.yy[GPS|MJD]')");
XLALregINTUserStruct ( duration, 0, UVAR_OPTIONAL, "Duration of requested signal in seconds");
XLALregLISTUserStruct ( timestampsFiles, 0, UVAR_OPTIONAL, "ALTERNATIVE: File to read timestamps from (file-format: lines with <seconds> <nanoseconds>)");
XLALRegisterUvarMember(startTime, EPOCH, 'G', OPTIONAL, "Start-time of requested signal in detector-frame (format 'xx.yy[GPS|MJD]')");
XLALRegisterUvarMember( duration, INT4, 0, OPTIONAL, "Duration of requested signal in seconds");
XLALRegisterUvarMember( timestampsFiles, STRINGVector, 0, OPTIONAL, "ALTERNATIVE: File to read timestamps from (file-format: lines with <seconds> <nanoseconds>)");
/* sampling and heterodyning frequencies */
XLALregREALUserStruct ( fmin, 0, UVAR_OPTIONAL, "Lowest frequency in output SFT (= heterodyning frequency)");
XLALregREALUserStruct ( Band, 0, UVAR_OPTIONAL, "Bandwidth of output SFT in Hz (= 1/2 sampling frequency)");
XLALRegisterUvarMember( fmin, REAL8, 0, OPTIONAL, "Lowest frequency in output SFT (= heterodyning frequency)");
XLALRegisterUvarMember( Band, REAL8, 0, OPTIONAL, "Bandwidth of output SFT in Hz (= 1/2 sampling frequency)");
/* SFT properties */
XLALregREALUserStruct ( Tsft, 0, UVAR_OPTIONAL, "Time baseline of one SFT in seconds");
XLALregREALUserStruct ( SFToverlap, 0, UVAR_OPTIONAL, "Overlap between successive SFTs in seconds (conflicts with --noiseSFTs or --timestampsFiles)");
XLALregSTRINGUserStruct( SFTWindowType, 0, UVAR_OPTIONAL, "Window function to be applied to the SFTs (required when using --noiseSFTs)");
XLALregREALUserStruct ( SFTWindowBeta, 0, UVAR_OPTIONAL, "Window 'beta' parameter required for a few window-types (eg. 'tukey')");
XLALRegisterUvarMember( Tsft, REAL8, 0, OPTIONAL, "Time baseline of one SFT in seconds");
XLALRegisterUvarMember( SFToverlap, REAL8, 0, OPTIONAL, "Overlap between successive SFTs in seconds (conflicts with --noiseSFTs or --timestampsFiles)");
XLALRegisterUvarMember( SFTWindowType, STRING, 0, OPTIONAL, "Window function to be applied to the SFTs (required when using --noiseSFTs)");
XLALRegisterUvarMember( SFTWindowBeta, REAL8, 0, OPTIONAL, "Window 'beta' parameter required for a few window-types (eg. 'tukey')");
/* pulsar params */
XLALregLISTUserStruct( injectionSources, 0, UVAR_OPTIONAL, "Source parameters to inject: comma-separated list of file-patterns and/or direct config-strings ('{...}')" );
XLALRegisterUvarMember( injectionSources, STRINGVector, 0, OPTIONAL, "Source parameters to inject: comma-separated list of file-patterns and/or direct config-strings ('{...}')" );
/* noise */
XLALregSTRINGUserStruct ( noiseSFTs, 'D', UVAR_OPTIONAL, "Noise-SFTs to be added to signal (Used also to set IFOs and timestamps)");
XLALRegisterUvarMember( noiseSFTs, STRING, 'D', OPTIONAL, "Noise-SFTs to be added to signal (Used also to set IFOs and timestamps)");
#ifdef HAVE_LIBLALFRAME
XLALRegisterUvarMember ( inFrames, STRINGVector,'C', OPTIONAL, "CSV list (one per IFO) of input frame cache files");
XLALRegisterUvarMember ( inFrChannels, STRINGVector,'N', OPTIONAL, "CSV list (one per IFO) of frame channels to read timeseries from");
#endif
XLALregBOOLUserStruct ( version, 'V', UVAR_SPECIAL, "Output version information");
XLALRegisterUvarMember( version, BOOLEAN, 'V', SPECIAL, "Output version information");
// ----- 'expert-user/developer' options ----- (only shown in help at lalDebugLevel >= warning)
XLALregINTUserStruct ( randSeed, 0, UVAR_DEVELOPER, "Specify random-number seed for reproducible noise (0 means use /dev/urandom for seeding).");
XLALRegisterUvarMember( randSeed, INT4, 0, DEVELOPER, "Specify random-number seed for reproducible noise (0 means use /dev/urandom for seeding).");
// ----- deprecated but still supported options [throw warning if used] (only shown in help at lalDebugLevel >= info) ----------
#ifdef HAVE_LIBLALFRAME
......
......@@ -657,19 +657,19 @@ InitUserVars ( UserInput_t *uvar, /**< [out] UserInput structure to be fill
uvar->ephemSun = XLALStringDuplicate("sun00-19-DE405.dat.gz");
/* Register User Variables*/
XLALregBOOLUserStruct( help, 'h', UVAR_HELP, "Print this message");
/* XLALregSTRINGUserStruct(out_chan, 'o', UVAR_OPTIONAL, "Output channel i.e. (IFO)_LDAS_C02_L2_CWINJ");*/
/* XLALregSTRINGUserStruct(in_chan, 'i', UVAR_OPTIONAL, "Input channel from .gwf file, i.e. (IFO):LDAS-STRAIN");*/
XLALregREALUserStruct(srate, 'r', UVAR_OPTIONAL, "user defined sample rate, default = 16384");
/* XLALregREALUserStruct(duration, 'd', UVAR_OPTIONAL, "duration of frame (sec)"); */
/* XLALregREALUserStruct(start, 's', UVAR_OPTIONAL, "epoch in GPS Seconds"); */
XLALregSTRINGUserStruct(inputdir, 'p', UVAR_OPTIONAL, "directory for .par files");
XLALregSTRINGUserStruct(gwfdir, 'g', UVAR_OPTIONAL,"directory for .gwf files");
XLALregSTRINGUserStruct(outputdir, 'c', UVAR_OPTIONAL, "directory for CWINJ files");
XLALregSTRINGUserStruct( ephemEarth, 0, UVAR_OPTIONAL, "Earth ephemeris file to use");
XLALregSTRINGUserStruct( ephemSun, 0, UVAR_OPTIONAL, "Sun ephemeris file to use");
XLALregSTRINGUserStruct( IFO, 'I', UVAR_REQUIRED, "Detector: 'G1', 'L1', 'H1', 'H2', 'V1'...");