User Parameters

The default schema for user parameters is:

Parameter	Type	Description	Default
outputDir	string	output directory	output
logDir	string	log directory	log
catalog_dir	string	catalog directory	catalog
trigger_dir	string	trigger directory	trigger
plot_trigger	boolean	plot triggers	False
save_waveform	boolean	save waveform from triggers	False
plot_waveform	boolean	plot waveform from triggers	False
save_injection	boolean	save injected waveform	False
plot_injection	boolean	plot injected waveform	False
save_cluster	boolean	save cluster to json	True
save_sky_map	boolean	save sky maps to json	False
plot_sky_map	boolean	plot sky maps	False
compress_output_json	boolean	compress output json	False
segment_processer	string	main segment processer function for the analysis, the arguments for the function are: func(working_dir, config, job_seg, **kwargs)	pycwb.workflow.subflow.process_job_segment.process_job_segment
use_root_supercluster	boolean	use cwb supercluster, if false use python version	True
nproc	integer	number of processes	4
skip_no_injection	boolean	skip jobs without injection	False
injection	object	injection parameters	{}
gps_start	number	start gps time, used together with gps_end for generating job segments
gps_end	number	end gps time, used together with gps_start for generating job segments
gps_center	number	center gps time, used together with time_left and time_right for generating job segments
time_left	number	left time offset from gps_center, used together with gps_center and time_right for generating job segments
time_right	number	right time offset from gps_center, used together with gps_center and time_left for generating job segments
superevent	string	superevent name, used together with time_left and time_right for generating job segments
gwdatafind	object	If the gwdatafind is set, the framefiles can be pulled from the LIGO data server, the support keys are: site, frametype, host. Example:
WDM_beta_order	integer	WDM default parameters: beta function order for Meyer	6
WDM_precision	integer	WDM default parameters: wavelet precision	10
MIN_SKYRES_HEALPIX	integer	minimun skymap resolution used for subNetCut	4
MIN_SKYRES_ANGLE	integer	minimun skymap resolution used for subNetCut	3
REGRESSION_FILTER_LENGTH	integer	regression parameters	8
REGRESSION_MATRIX_FRACTION	number	regression parameters	0.95
REGRESSION_SOLVE_EIGEN_THR	number	regression parameters	0.0
REGRESSION_SOLVE_EIGEN_NUM	integer	regression parameters	10
REGRESSION_SOLVE_REGULATOR	string	regression parameters	h
REGRESSION_APPLY_THR	number	regression parameters	0.8
analysis	enum	true/false -> online/offline	2G
cfg_search	enum	see description below	r
Search	enum	2G pipeline: If equals ‘’ then it is ignored by the 2G pipeline (default, back compatibility), Available values are: ‘’/CBC/BBH/IMBHB. If equals CBC/BBH/IMBHB then the chirp line is added to the CED l_tfmap_scalogram, moreover when netRHO<0 (rho0.XGB) than the chirp mass is computed only if Search=CBC/BBH/IMBHB
online	boolean	true/false -> online/offline	False
optim	boolean	true -> optimal resolution likelihood analysis	False
fLow	number	low frequency of the search	64.0
fHigh	number	high frequency of the search	2048.0
ifo	array	ifo[] can be redefined by user	['L1', 'H1', 'V1', 'I1', 'J1', 'G1']
nIFO	integer	number of interferometers	8
refIFO	string	reference IFO	L1
select_subrho	number	subrho netcluster select function threshold (coherence)	5.0
select_subnet	number	subnet netcluster select function threshold (coherence)	0.1
bpp	number	probability for black pixel selection (netpixel)	0.001
fResample	number	if zero resampling is not applied	0
inRate	integer	input data rate	16384
dcCal	array	DC corrections	[1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
EFEC	boolean	Earth Fixed / Selestial coordinates	True
precision	number	set parameters for big clusters events management	0.0
pattern	integer	select pixel pattern used to produce the energy max maps for pixel’s selection patterns: “/” - ring-up, “" - ring-down, “|” - delta, “-” line, “*” - single pattern = 0 - “*” 1-pixel standard search pattern = 1 - “3|” 3-pixels vertical packet (delta) pattern = 2 - “3-” 3-pixels horizontal packet (line) pattern = 3 - “3/” 3-pixels diagonal packet (ring-up) pattern = 4 - “3” 3-pixels anti-diagonal packet (ring-down) pattern = 5 - “5/” 5-pixels diagonal packet (ring-up) pattern = 6 - “5” 5-pixels anti-diagonal packet (ring-down) pattern = 7 - “3+” 5-pixels plus packet (plus) pattern = 8 - “3x” 5-pixels cross packet (cross) pattern = 9 - “9p” 9-pixels square packet (box) pattern = else - “*” 1-pixel packet (single) ———————————————————————————— pattern==0 Standard Search : std-pixel selection + likelihood2G pattern!=0 && pattern<0 Mixed Search : packet-pixel selection + likelihood2G pattern!=0 && pattern>0 Packed Search : packet-pixel selection + likelihoodWP	0
BATCH	integer	max number of pixel to process in one loadTDamp batch	10000
LOUD	integer	number of pixel per cluster to load TD amplitudes	200
nSky	integer	if nSky>0 -> # of skymap prob pixels dumped to ascii if nSky=0 -> (#pixels==1000 || cum prob > 0.99) if nSky<0 -> nSky=-XYZ… save all pixels with prob < 0.XYZ…	0
subnet	number	[0,0.7] sub network threshold (supercluster)	0.7
subcut	number	[0,1] sub network threshold in the skyloop (supercluster)	0.33
subnorm	number	[0,2*num_resolution_levels] sub network norm threshold, enabled only if >0 (supercluster)	0.0
subrho	number	sub network threshold in the skyloop subNetCuts, if <=0 then subrho=netRHO (supercluster)	0.0
subacor	number	sub network threshold in the skyloop subNetCuts, if<=0 then subacor=Acore (supercluster)	0.0
netRHO	number	[>4.0] coherent network SNR (supercluster, likelihood), if <=0 then use the new statistics for XGBoost	4.0
netCC	number	network correlation (supercluster, likelihood)	0.5
Acore	number	threshold of core pixels (supercluster, likelihood)	1.4142135623730951
Tgap	number	defragmentation time gap between clusters (sec)	3.0
Fgap	number	defragmentation frequency gap between clusters (Hz)	130.0
TFgap	number	threshold on the time-frequency separation between two pixels	6.0
delta	number	[-1:1] regulate 2 Detector sky locations. delta=0 : regulator is disabled, delta<0 : select Lo as skystat instead of Lr	0.5
cfg_gamma	number	[-1:1] regulate |fx|<<|f+| and |f+|<<1 sky locations. gamma=0 : regulator is disabled, gamma<0 : sky prior is applied	0.5
Theta1	number	start theta	0.0
Theta2	number	stop theta	180.0
Phi1	number	start phi	0.0
Phi2	number	stop phi	360.0
cedRHO	number	cedRHO	4.0
skyMaskFile	string	sky mask file
skyMaskCCFile	string	sky mask file
segLen	number	Segment length [sec]	600.0
segMLS	number	Minimum Segment Length after DQ_CAT1 [sec]	300.0
segTHR	number	Minimum Segment Length after DQ_CAT2 [sec] (to disable put segTHR=0)	30.0
segEdge	number	wavelet boundary offset [sec]	8.0
segOverlap	number	overlap between job segments [sec]	0.0
lagSize	integer	number of lags (simulation:1)	1
lagStep	number	[sec] time interval between lags	1.0
lagOff	integer	first lag id (lagOff=0 - include zero lag )	6
lagMax	number	0/>0 - standard/extended lags	150
lagMode	enum	w/r - write/read lag list	w
lagSite	integer	site index starting with 0	None
lagFile	string	slag file list	None
slagSize	integer	number of super lags (simulation=1) - if slagSize=0 -> Standard Segments	0
slagMin	integer	select the minimum available slag distance : slagMin must be <= slagMax	0
slagMax	integer	select the maximum available slag distance	0
slagOff	integer	first slag id (slagOff=0 - include zero slag )	0
channelNamesRaw	array	channel names for raw data	[]
channelNamesMDC	array	channel names for MDC data	[]
frFiles	array	No description provided	[]
DQF	array	No description provided	[]
nDQF	integer	No description provided	8
iwindow	number	injection time window (Tinj +/- iwindow/2)	5.0
gap	number	alias of iwindow	5.0
l_low	integer	low frequency resolution level (2^l_low Hz)	3
l_high	integer	high frequency resolution level (2^l_high Hz)	8
l_white	integer	whitening frequency resolution level (2^l_white Hz), if 0 then l_white=l_high	0
whiteWindow	number	[sec] time window dT. if = 0 - dT=T, where T is segment duration	60.0
whiteStride	number	[sec] noise sampling time stride	20.0
mesaSolver	string	method used to solve Levinson Recursion [‘Fast’] or [‘Standard’]. Only needed if whiteMethod is ‘MESA’	Fast
mesaOrder	number	Maximum Autoregressive order for the Lenvinson Recursion	800.0
whiteMethod	string	Sets what type of whitening has to be used. if ‘wavelet’ WDM time-frequency domain is applied. if ‘mesa’, it whitens with a PSD estimate given by mesa in the frequency domain. If ‘mixed’, the whitening is performed in time frequency domain but the nRMS is substitued with a MESA estimate for the coefficients	wavelet
mesaReindex	boolean	If True, Computes possible PSDs outliers that might affect PSDs via Isolation Forest and substitute them with closest in time estimate	True
simulation	string	No description provided	None
nfactor	number	number of simulation factors	0
factors	array	array of simulation factors (when sim=4 factors[0] is used as offset [must be int])	[]
levelR	integer	resampling level : inRate[fResample]/(2^levelR) Hz	2
healpix	number	if not 0 use healpix sky map (number of sky pixels = 12*pow(4,healpix))	7
plugin	string	No description provided
configPlugin	string	No description provided
filter_dir	string	filter directory, defaults to environment HOME_WAT_FILTERS
wdmXTalk	string	WDM cross-talk file	wdmXTalk/OverlapCatalog_Lev_8_16_32_64_128_256_iNu_4_Prec_10.bin
upTDF	integer	upsample factor to obtain rate of TD filter : TDRate = (inRate>>levelR)*upTDF	4
TDSize	integer	time-delay filter size (max 20)	12