Commit 071ce9df authored by David Keitel's avatar David Keitel Committed by Karl Wette
Browse files

add help for --injectionSources to MFDv5, CFSv2, HSGCT and --injections for Weave

 -shared help string defined in lalpulsar/CWMakeFakeData.c
 -displayed through the regular --help output of each lalapp
 -thanks to Karl Wette for implementation aspects
 -refs https://git.ligo.org/CW/software/lalsuite/issues/37
parent d97ebebb
...@@ -1159,7 +1159,7 @@ initUserVars ( UserInput_t *uvar ) ...@@ -1159,7 +1159,7 @@ initUserVars ( UserInput_t *uvar )
XLALRegisterUvarMember(allowedMismatchFromSFTLength, REAL8, 0, DEVELOPER, "Maximum allowed mismatch from SFTs being too long [Default: what's hardcoded in XLALFstatMaximumSFTLength]" ); XLALRegisterUvarMember(allowedMismatchFromSFTLength, REAL8, 0, DEVELOPER, "Maximum allowed mismatch from SFTs being too long [Default: what's hardcoded in XLALFstatMaximumSFTLength]" );
/* inject signals into the data being analyzed */ /* inject signals into the data being analyzed */
XLALRegisterUvarMember(injectionSources, STRINGVector, 0, DEVELOPER, "CSV list of files containing signal parameters for injection [see mfdv5]"); XLALRegisterUvarMember(injectionSources, STRINGVector, 0, DEVELOPER, "%s", InjectionSourcesHelpString );
XLALRegisterUvarMember(injectSqrtSX, STRINGVector, 0, DEVELOPER, "Generate Gaussian Noise SFTs on-the-fly: CSV list of detectors' noise-floors sqrt{Sn}"); XLALRegisterUvarMember(injectSqrtSX, STRINGVector, 0, DEVELOPER, "Generate Gaussian Noise SFTs on-the-fly: CSV list of detectors' noise-floors sqrt{Sn}");
XLALRegisterUvarMember(IFOs, STRINGVector, 0, DEVELOPER, "CSV list of detectors, eg. \"H1,H2,L1,G1, ...\", when no SFT files are specified"); XLALRegisterUvarMember(IFOs, STRINGVector, 0, DEVELOPER, "CSV list of detectors, eg. \"H1,H2,L1,G1, ...\", when no SFT files are specified");
XLALRegisterUvarMember(timestampsFiles, STRINGVector, 0, DEVELOPER, XLALRegisterUvarMember(timestampsFiles, STRINGVector, 0, DEVELOPER,
......
...@@ -569,7 +569,7 @@ int MAIN( int argc, char *argv[]) { ...@@ -569,7 +569,7 @@ int MAIN( int argc, char *argv[]) {
XLAL_CHECK_MAIN( XLALRegisterNamedUvar( &uvar_loudestTwoFPerSeg, "loudestTwoFPerSeg", BOOLEAN, 0, DEVELOPER, "Output loudest per-segment Fstat values into file '_loudestTwoFPerSeg'" ) == XLAL_SUCCESS, XLAL_EFUNC ); XLAL_CHECK_MAIN( XLALRegisterNamedUvar( &uvar_loudestTwoFPerSeg, "loudestTwoFPerSeg", BOOLEAN, 0, DEVELOPER, "Output loudest per-segment Fstat values into file '_loudestTwoFPerSeg'" ) == XLAL_SUCCESS, XLAL_EFUNC );
/* inject signals into the data being analyzed */ /* inject signals into the data being analyzed */
XLAL_CHECK_MAIN( XLALRegisterNamedUvar ( &uvar_injectionSources, "injectionSources", STRINGVector, 0, DEVELOPER, "CSV list of files containing signal parameters for injection [see mfdv5]") == XLAL_SUCCESS, XLAL_EFUNC ); XLAL_CHECK_MAIN( XLALRegisterNamedUvar ( &uvar_injectionSources, "injectionSources", STRINGVector, 0, DEVELOPER, "%s", InjectionSourcesHelpString) == XLAL_SUCCESS, XLAL_EFUNC );
/* read all command line variables */ /* read all command line variables */
BOOLEAN should_exit = 0; BOOLEAN should_exit = 0;
......
...@@ -650,7 +650,7 @@ XLALInitUserVars ( UserVariables_t *uvar, int argc, char *argv[] ) ...@@ -650,7 +650,7 @@ XLALInitUserVars ( UserVariables_t *uvar, int argc, char *argv[] )
XLALRegisterUvarMember( SFTWindowBeta, REAL8, 0, OPTIONAL, "Window 'beta' parameter required for a few window-types (eg. 'tukey')"); XLALRegisterUvarMember( SFTWindowBeta, REAL8, 0, OPTIONAL, "Window 'beta' parameter required for a few window-types (eg. 'tukey')");
/* pulsar params */ /* pulsar params */
XLALRegisterUvarMember( injectionSources, STRINGVector, 0, OPTIONAL, "Source parameters to inject: comma-separated list of file-patterns and/or direct config-strings ('{...}')" ); XLALRegisterUvarMember( injectionSources, STRINGVector, 0, OPTIONAL, "%s", InjectionSourcesHelpString );
/* noise */ /* noise */
XLALRegisterUvarMember( noiseSFTs, STRING, 'D', OPTIONAL, "Noise-SFTs to be added to signal (Used also to set IFOs and timestamps, and frequency range unless separately specified.)"); XLALRegisterUvarMember( noiseSFTs, STRING, 'D', OPTIONAL, "Noise-SFTs to be added to signal (Used also to set IFOs and timestamps, and frequency range unless separately specified.)");
......
...@@ -119,11 +119,7 @@ int main( int argc, char *argv[] ) ...@@ -119,11 +119,7 @@ int main( int argc, char *argv[] )
); );
XLALRegisterUvarMember( XLALRegisterUvarMember(
injections, STRINGVector, 'J', NODEFAULT, injections, STRINGVector, 'J', NODEFAULT,
"Inject simulated CW signals in the loaded/generated SFTs. Possibilities for <string> are:\n" "%s", InjectionSourcesHelpString
" <config-file>\n"
" {parameter=value; ...} where:\n"
" required parameters are: (h0, cosi) or (aPlus, aCross), Alpha, Delta, Freq\n"
" optional parameters are: refTime, psi, phi0, f<n>dot, ..."
); );
// //
// - Search parameter space // - Search parameter space
......
...@@ -55,6 +55,23 @@ ...@@ -55,6 +55,23 @@
// ---------- Global variables // ---------- Global variables
const REAL8 eps = 10 * LAL_REAL8_EPS; const REAL8 eps = 10 * LAL_REAL8_EPS;
const char *const InjectionSourcesHelpString = "Source parameters to inject for simulated signal(s).\n"
"This is a comma-separated list of file patterns for configuration files,\n"
"or else direct configuration strings in the following format:\n"
" * Enclose with curly braces ('{}').\n"
" * Give pulsar parameters as key=value pairs with a '=' separator.\n"
" * Separate each key=value pair with a semicolon (';').\n"
"Available parameters are:\n"
" * Required parameters: Alpha, Delta, Freq, refTime\n"
" * Optional parameters:\n"
" - Injection amplitudes: either (h0, cosi) or (aPlus, aCross), psi, phi0\n"
" - Higher-order spindowns: f1dot, f2dot, ... f6dot\n"
" - Binary sources: orbitTp, orbitArgp, orbitasini, orbitEcc, orbitPeriod\n"
" - Transient injections: transientWindowType, transientStartTime, transientTau\n"
"Examples:\n"
" * '{Alpha=0; Delta=0; Freq=50; f1dot=1e-11; f2dot=0; refTime=1000000000; h0=1.00000000e-23; cosi=0; psi=0; phi0=0;}'\n"
" * 'file1.dat,someFiles*.txt,{Alpha=0;Delta=0;Freq=0;refTime=1000000000;},someOtherFiles[0-9].dat'\n\n";
// ---------- local prototypes // ---------- local prototypes
static UINT4 gcd (UINT4 numer, UINT4 denom); static UINT4 gcd (UINT4 numer, UINT4 denom);
int XLALcorrect_phase ( SFTtype *sft, LIGOTimeGPS tHeterodyne ); int XLALcorrect_phase ( SFTtype *sft, LIGOTimeGPS tHeterodyne );
......
...@@ -84,6 +84,8 @@ typedef struct tagCWMFDataParams ...@@ -84,6 +84,8 @@ typedef struct tagCWMFDataParams
// ---------- Global variables ---------- // ---------- Global variables ----------
extern const char *const InjectionSourcesHelpString;
// ---------- exported prototypes [API] ---------- // ---------- exported prototypes [API] ----------
#ifdef SWIG // SWIG interface directives #ifdef SWIG // SWIG interface directives
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment