Commit 7459039c authored by David Keitel's avatar David Keitel Committed by Reinhard Prix

CFSv2: deprecate transient arguments in days and introduce new args in seconds instead

Original: 94032fe880239f22c83e0c5808230a38a2b4bbee
parent 334d43b8
......@@ -295,11 +295,16 @@ typedef struct {
CHAR *outputTransientStats; /**< output file for transient B-stat values */
CHAR *outputTransientStatsAll; /**< output file for transient B-stat values */
CHAR *transient_WindowType; /**< name of transient window ('none', 'rect', 'exp',...) */
REAL8 transient_t0Days; /**< earliest GPS start-time for transient window search, as offset in days from dataStartGPS */
REAL8 transient_t0DaysBand; /**< Range of GPS start-times to search in transient search, in days */
LIGOTimeGPS transient_t0Epoch; /**< earliest GPS start-time for transient window search, in seconds */
UINT4 transient_t0Offset; /**< earliest start-time for transient window search, as offset in seconds from dataStartGPS */
UINT4 transient_t0Band; /**< Range of GPS start-times to search in transient search, in seconds */
REAL8 transient_t0Days; /**< [DEPRECATED] earliest GPS start-time for transient window search, as offset in days from dataStartGPS */
REAL8 transient_t0DaysBand; /**< [DEPRECATED] Range of GPS start-times to search in transient search, in days */
INT4 transient_dt0; /**< Step-size for search/marginalization over transient-window start-time, in seconds */
REAL8 transient_tauDays; /**< smallest transient window length for marginalization, in days */
REAL8 transient_tauDaysBand; /**< Range of transient-window timescales to search, in days */
UINT4 transient_tau; /**< smallest transient window length for marginalization, in seconds */
UINT4 transient_tauBand; /**< Range of transient-window timescales to search, in seconds */
REAL8 transient_tauDays; /**< [DEPRECATED] smallest transient window length for marginalization, in days */
REAL8 transient_tauDaysBand; /**< [DEPRECATED] Range of transient-window timescales to search, in days */
INT4 transient_dtau; /**< Step-size for search/marginalization over transient-window timescale, in seconds */
BOOLEAN transient_useFReg; /**< FALSE: use 'standard' e^F for marginalization, TRUE: use e^FReg = (1/D)*e^F */
......@@ -1075,12 +1080,17 @@ initUserVars ( UserInput_t *uvar )
XLALRegisterUvarMember(outputTransientStats,STRING, 0, OPTIONAL, "TransientCW: Output filename for transient-CW statistics.");
XLALRegisterUvarMember(outputTransientStatsAll,STRING, 0, DEVELOPER, "TransientCW: Output filename for transient-CW statistics -- including the whole (t0,tau) grid for each candidate -- WARNING: CAN BE HUGE!.");
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]");
XLALRegisterUvarMember( transient_t0Epoch, EPOCH, 0, OPTIONAL, "TransientCW: Earliest start-time for transient window search, in seconds (format 'xx.yy[GPS|MJD]')");
XLALRegisterUvarMember( transient_t0Offset, UINT4, 0, OPTIONAL, "TransientCW: Earliest start-time for transient window search, as offset in seconds from dataStartGPS");
XLALRegisterUvarMember( transient_t0Band, UINT4, 0, OPTIONAL, "TransientCW: Range of GPS start-times to search in transient search, in seconds");
XLALRegisterUvarMember( transient_t0Days, REAL8, 0, DEPRECATED, "TransientCW: Earliest GPS start-time for transient window search, as offset in days from dataStartGPS [use --transient_t0Offset in seconds instead]");
XLALRegisterUvarMember( transient_t0DaysBand, REAL8, 0, DEPRECATED, "TransientCW: Range of GPS start-times to search in transient search, in days [use --transient_t0Band in seconds instead]");
XLALRegisterUvarMember( transient_dt0, INT4, 0, OPTIONAL, "TransientCW: Step-size in transient-CW start-time in seconds [Default:Tsft]");
XLALRegisterUvarMember( transient_tau, UINT4, 0, OPTIONAL, "TransientCW: Minimal transient-CW duration timescale, in seconds");
XLALRegisterUvarMember( transient_tauBand, UINT4, 0, OPTIONAL, "TransientCW: Range of transient-CW duration timescales to search, in seconds");
XLALRegisterUvarMember( transient_tauDays, REAL8, 0, DEPRECATED, "TransientCW: Minimal transient-CW duration timescale, in days [better use --transient_tau in seconds instead]");
XLALRegisterUvarMember( transient_tauDaysBand, REAL8, 0, DEPRECATED, "TransientCW: Range of transient-CW duration timescales to search, in days [better use --transient_tauBand in seconds instead]");
XLALRegisterUvarMember( transient_dtau, INT4, 0, OPTIONAL, "TransientCW: Step-size in transient-CW duration timescale, in seconds [Default:Tsft]");
XLALRegisterUvarMember(FstatMethod, STRING, 0, OPTIONAL, "F-statistic method to use. Available methods: %s", XLALFstatMethodHelpString() );
......@@ -1473,7 +1483,9 @@ InitFstat ( ConfigVariables *cfg, const UserInput_t *uvar )
/* make sure user doesn't set window=none but sets window-parameters => indicates she didn't mean 'none' */
if ( cfg->transientWindowRange.type == TRANSIENT_NONE )
if ( XLALUserVarWasSet ( &uvar->transient_t0Days ) || XLALUserVarWasSet ( &uvar->transient_t0DaysBand ) || XLALUserVarWasSet ( &uvar->transient_dt0 ) ||
XLALUserVarWasSet ( &uvar->transient_tauDays ) || XLALUserVarWasSet ( &uvar->transient_tauDaysBand ) || XLALUserVarWasSet ( &uvar->transient_dtau ) ) {
XLALUserVarWasSet ( &uvar->transient_t0Epoch ) || XLALUserVarWasSet ( &uvar->transient_t0Offset ) || XLALUserVarWasSet ( &uvar->transient_t0Band ) ||
XLALUserVarWasSet ( &uvar->transient_tauDays ) || XLALUserVarWasSet ( &uvar->transient_tauDaysBand ) ||
XLALUserVarWasSet ( &uvar->transient_tau ) || XLALUserVarWasSet ( &uvar->transient_tauBand ) || XLALUserVarWasSet ( &uvar->transient_dtau ) ) {
XLAL_ERROR ( XLAL_EINVAL, "ERROR: transientWindow->type == NONE, but window-parameters were set! Use a different window-type!\n" );
}
......@@ -1481,9 +1493,31 @@ InitFstat ( ConfigVariables *cfg, const UserInput_t *uvar )
XLAL_ERROR (XLAL_EINVAL, "Only positive t0/tau bands allowed (%f, %f)\n", uvar->transient_t0DaysBand, uvar->transient_tauDaysBand );
}
cfg->transientWindowRange.t0 = cfg->startTime.gpsSeconds + uvar->transient_t0Days * DAY24;
cfg->transientWindowRange.t0Band = uvar->transient_t0DaysBand * DAY24;
if ( XLALUserVarWasSet ( &uvar->transient_t0Days ) ) { /* deprecated */
if ( XLALUserVarWasSet ( &uvar->transient_t0Epoch ) || XLALUserVarWasSet ( &uvar->transient_t0Offset ) ) {
XLAL_ERROR ( XLAL_EINVAL, "ERROR: only one of transient_t0Epoch, transient_t0Offset, transient_t0Days may be used!\n" );
}
cfg->transientWindowRange.t0 = cfg->startTime.gpsSeconds + uvar->transient_t0Days * DAY24;
}
else if ( XLALUserVarWasSet ( &uvar->transient_t0Offset ) ) {
if ( XLALUserVarWasSet ( &uvar->transient_t0Epoch ) ) {
XLAL_ERROR ( XLAL_EINVAL, "ERROR: only one of transient_t0Epoch, transient_t0Offset may be used!\n" );
}
cfg->transientWindowRange.t0 = cfg->startTime.gpsSeconds + uvar->transient_t0Offset;
}
else if ( XLALUserVarWasSet ( &uvar->transient_t0Epoch ) ) {
cfg->transientWindowRange.t0 = uvar->transient_t0Epoch.gpsSeconds; /* just dropping ns part here */
}
if ( XLALUserVarWasSet ( &uvar->transient_t0DaysBand ) ) { /* deprecated */
if ( XLALUserVarWasSet ( &uvar->transient_t0Band ) ) {
XLAL_ERROR ( XLAL_EINVAL, "ERROR: only one of transient_t0Band, transient_t0DaysBand may be used!\n" );
}
cfg->transientWindowRange.t0Band = uvar->transient_t0DaysBand * DAY24;
}
else if ( XLALUserVarWasSet ( &uvar->transient_t0Band ) ) {
cfg->transientWindowRange.t0Band = uvar->transient_t0Band;
}
if ( XLALUserVarWasSet ( &uvar->transient_dt0 ) ) {
cfg->transientWindowRange.dt0 = uvar->transient_dt0;
......@@ -1492,8 +1526,25 @@ InitFstat ( ConfigVariables *cfg, const UserInput_t *uvar )
cfg->transientWindowRange.dt0 = cfg->Tsft;
}
cfg->transientWindowRange.tau = (UINT4) ( uvar->transient_tauDays * DAY24 );
cfg->transientWindowRange.tauBand = (UINT4) ( uvar->transient_tauDaysBand * DAY24 );
if ( XLALUserVarWasSet ( &uvar->transient_tauDays ) ) { /* deprecated */
if ( XLALUserVarWasSet ( &uvar->transient_tau ) ) {
XLAL_ERROR ( XLAL_EINVAL, "ERROR: only one of transient_tau, transient_tauDays may be used!\n" );
}
cfg->transientWindowRange.tau = uvar->transient_tauDays * DAY24;
}
else if ( XLALUserVarWasSet ( &uvar->transient_tau ) ) {
cfg->transientWindowRange.tau = uvar->transient_tau;
}
if ( XLALUserVarWasSet ( &uvar->transient_tauDaysBand ) ) { /* deprecated */
if ( XLALUserVarWasSet ( &uvar->transient_tauBand ) ) {
XLAL_ERROR ( XLAL_EINVAL, "ERROR: only one of transient_tauBand, transient_tauDaysBand may be used!\n" );
}
cfg->transientWindowRange.tauBand = uvar->transient_tauDaysBand * DAY24;
}
else if ( XLALUserVarWasSet ( &uvar->transient_tauBand ) ) {
cfg->transientWindowRange.tauBand = uvar->transient_tauBand;
}
if ( XLALUserVarWasSet ( &uvar->transient_dtau ) ) {
cfg->transientWindowRange.dtau = uvar->transient_dtau;
......
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