User Parameters

The default schema for user parameters is:

{
"additionalProperties": false,
"properties": {
    "Acore": {
        "default": 1.4142135623730951,
        "description": "threshold of core pixels (supercluster, likelihood)",
        "type": "number"
    },
    "BATCH": {
        "default": 10000,
        "description": "max number of pixel to process in one loadTDamp batch",
        "type": "integer"
    },
    "DQF": {
        "c_type": "dqfile",
        "default": [],
        "type": "array"
    },
    "EFEC": {
        "default": true,
        "description": "Earth Fixed / Selestial coordinates",
        "type": "boolean"
    },
    "Fgap": {
        "default": 130.0,
        "description": "defragmentation frequency gap between clusters (Hz)",
        "type": "number"
    },
    "LOUD": {
        "default": 200,
        "description": "number of pixel per cluster to load TD amplitudes ",
        "type": "integer"
    },
    "MIN_SKYRES_ANGLE": {
        "default": 3,
        "description": "minimun skymap resolution used for subNetCut",
        "type": "integer"
    },
    "MIN_SKYRES_HEALPIX": {
        "default": 4,
        "description": "minimun skymap resolution used for subNetCut",
        "type": "integer"
    },
    "Phi1": {
        "default": 0.0,
        "description": "start phi",
        "type": "number"
    },
    "Phi2": {
        "default": 360.0,
        "description": "stop phi",
        "type": "number"
    },
    "REGRESSION_APPLY_THR": {
        "default": 0.8,
        "description": "regression parameters",
        "type": "number"
    },
    "REGRESSION_FILTER_LENGTH": {
        "default": 8,
        "description": "regression parameters",
        "type": "integer"
    },
    "REGRESSION_MATRIX_FRACTION": {
        "default": 0.95,
        "description": "regression parameters",
        "type": "number"
    },
    "REGRESSION_SOLVE_EIGEN_NUM": {
        "default": 10,
        "description": "regression parameters",
        "type": "integer"
    },
    "REGRESSION_SOLVE_EIGEN_THR": {
        "default": 0.0,
        "description": "regression parameters",
        "type": "number"
    },
    "REGRESSION_SOLVE_REGULATOR": {
        "default": "h",
        "description": "regression parameters",
        "type": "string"
    },
    "Search": {
        "default": "",
        "description": "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 ",
        "enum": [
            "",
            "CBC",
            "BBH",
            "IMBHB"
        ]
    },
    "TDSize": {
        "default": 12,
        "description": "time-delay filter size (max 20) ",
        "maximum": 20,
        "type": "integer"
    },
    "TFgap": {
        "default": 6.0,
        "description": "threshold on the time-frequency separation between two pixels",
        "type": "number"
    },
    "Tgap": {
        "default": 3.0,
        "description": "defragmentation time gap between clusters (sec)",
        "type": "number"
    },
    "Theta1": {
        "default": 0.0,
        "description": "start theta",
        "type": "number"
    },
    "Theta2": {
        "default": 180.0,
        "description": "stop theta",
        "type": "number"
    },
    "WDM_beta_order": {
        "default": 6,
        "description": "WDM default parameters: beta function order for Meyer",
        "type": "integer"
    },
    "WDM_precision": {
        "default": 10,
        "description": "WDM default parameters: wavelet precision",
        "type": "integer"
    },
    "analysis": {
        "default": "2G",
        "description": "true/false -> online/offline",
        "enum": [
            "1G",
            "2G"
        ]
    },
    "bpp": {
        "default": 0.001,
        "description": "probability for black pixel selection (netpixel)",
        "type": "number"
    },
    "catalog_dir": {
        "cwb": false,
        "default": "catalog",
        "description": "catalog directory",
        "type": "string"
    },
    "cedRHO": {
        "default": 4.0,
        "description": "cedRHO",
        "type": "number"
    },
    "cfg_gamma": {
        "default": 0.5,
        "description": "[-1:1] regulate |fx|<<|f+| and |f+|<<1 sky locations. gamma=0 : regulator is disabled, gamma<0 : sky prior is applied",
        "maximum": 1,
        "minimum": -1,
        "type": "number"
    },
    "cfg_search": {
        "default": "r",
        "description": "see description below",
        "enum": [
            "r",
            "i",
            "p",
            "l",
            "s",
            "c",
            "g",
            "e",
            "b",
            "R",
            "I",
            "P",
            "L",
            "S",
            "C",
            "G",
            "E",
            "B"
        ]
    },
    "channelNamesMDC": {
        "default": [],
        "description": "channel names for MDC data",
        "type": "array"
    },
    "channelNamesRaw": {
        "default": [],
        "description": "channel names for raw data",
        "type": "array"
    },
    "compress_output_json": {
        "cwb": false,
        "default": false,
        "description": "compress output json",
        "type": "boolean"
    },
    "configPlugin": {
        "c_type": "TMacro",
        "default": "",
        "type": "string"
    },
    "dcCal": {
        "default": [
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0
        ],
        "description": "DC corrections",
        "type": "array"
    },
    "delta": {
        "default": 0.5,
        "description": "[-1:1] regulate 2 Detector sky locations. delta=0 : regulator is disabled, delta<0 : select Lo as skystat instead of Lr",
        "maximum": 1,
        "minimum": -1,
        "type": "number"
    },
    "fHigh": {
        "default": 2048.0,
        "description": "high frequency of the search",
        "type": "number"
    },
    "fLow": {
        "default": 64.0,
        "description": "low frequency of the search",
        "type": "number"
    },
    "fResample": {
        "default": 0,
        "description": "if zero resampling is not applied",
        "type": "number"
    },
    "factors": {
        "default": [],
        "description": "array of simulation factors (when sim=4 factors[0] is used as offset [must be int])",
        "items": {
            "type": "number"
        },
        "type": "array"
    },
    "filter_dir": {
        "default": "",
        "description": "filter directory, defaults to environment HOME_WAT_FILTERS",
        "type": "string"
    },
    "frFiles": {
        "default": [],
        "type": "array"
    },
    "gap": {
        "default": 5.0,
        "description": "alias of iwindow",
        "type": "number"
    },
    "healpix": {
        "default": 7,
        "description": "if not 0 use healpix sky map (number of sky pixels = 12*pow(4,healpix))",
        "type": "number"
    },
    "ifo": {
        "default": [
            "L1",
            "H1",
            "V1",
            "I1",
            "J1",
            "G1"
        ],
        "description": "ifo[] can be redefined by user",
        "items": {
            "type": "string"
        },
        "type": "array",
        "uniqueItems": true
    },
    "inRate": {
        "default": 16384,
        "description": "input data rate",
        "type": "integer"
    },
    "injection": {
        "cwb": false,
        "default": {},
        "description": "injection parameters",
        "type": "object"
    },
    "iwindow": {
        "default": 5.0,
        "description": "injection time window (Tinj +/- iwindow/2)",
        "type": "number"
    },
    "l_high": {
        "default": 8,
        "description": "high frequency resolution level (2^l_high Hz)",
        "type": "integer"
    },
    "l_low": {
        "default": 3,
        "description": "low frequency resolution level (2^l_low Hz)",
        "type": "integer"
    },
    "l_white": {
        "default": 0,
        "description": "whitening frequency resolution level (2^l_white Hz), if 0 then l_white=l_high",
        "type": "integer"
    },
    "lagFile": {
        "default": null,
        "description": "slag file list",
        "type": "string"
    },
    "lagMax": {
        "default": 150,
        "description": "0/>0 -  standard/extended lags",
        "type": "number"
    },
    "lagMode": {
        "default": "w",
        "description": "w/r  -  write/read lag list",
        "enum": [
            "w",
            "r"
        ]
    },
    "lagOff": {
        "default": 6,
        "description": "first lag id (lagOff=0 - include zero lag )",
        "type": "integer"
    },
    "lagSite": {
        "default": null,
        "description": "site index starting with 0",
        "type": "integer"
    },
    "lagSize": {
        "default": 1,
        "description": "number of lags (simulation:1)",
        "type": "integer"
    },
    "lagStep": {
        "default": 1.0,
        "description": "[sec] time interval between lags",
        "type": "number"
    },
    "levelR": {
        "default": 2,
        "description": "resampling level : inRate[fResample]/(2^levelR) Hz",
        "type": "integer"
    },
    "logDir": {
        "cwb": false,
        "default": "log",
        "description": "log directory",
        "type": "string"
    },
    "nDQF": {
        "default": 8,
        "type": "integer"
    },
    "nIFO": {
        "default": 8,
        "description": "number of interferometers",
        "type": "integer"
    },
    "nSky": {
        "default": 0,
        "description": "if nSky>0 -> # of skymap prob pixels dumped to ascii \n if nSky=0 -> (#pixels==1000 || cum prob > 0.99) \n if nSky<0 -> nSky=-XYZ... save all pixels with prob < 0.XYZ...",
        "type": "integer"
    },
    "netCC": {
        "default": 0.5,
        "description": "network correlation (supercluster, likelihood)",
        "type": "number"
    },
    "netRHO": {
        "default": 4.0,
        "description": "[>4.0] coherent network SNR (supercluster, likelihood), if <=0 then use the new statistics for XGBoost",
        "type": "number"
    },
    "nfactor": {
        "default": 0,
        "description": "number of simulation factors",
        "type": "number"
    },
    "nproc": {
        "cwb": false,
        "default": 4,
        "description": "number of processes",
        "type": "integer"
    },
    "online": {
        "default": false,
        "description": "true/false -> online/offline",
        "type": "boolean"
    },
    "optim": {
        "default": false,
        "description": "true -> optimal resolution likelihood analysis",
        "type": "boolean"
    },
    "outputDir": {
        "cwb": false,
        "default": "output",
        "description": "output directory",
        "type": "string"
    },
    "pattern": {
        "default": 0,
        "description": "select pixel pattern used to produce the energy max maps for pixel's selection \npatterns: \"/\" - ring-up, \"\\\" - ring-down, \"|\" - delta, \"-\" line, \"*\" - single \npattern =  0 - \"*\"   1-pixel  standard search \npattern =  1 - \"3|\"  3-pixels vertical packet (delta) \npattern =  2 - \"3-\"  3-pixels horizontal packet (line) \npattern =  3 - \"3/\"  3-pixels diagonal packet (ring-up) \npattern =  4 - \"3\"  3-pixels anti-diagonal packet (ring-down) \npattern =  5 - \"5/\"  5-pixels diagonal packet (ring-up) \npattern =  6 - \"5\"  5-pixels anti-diagonal packet (ring-down) \npattern =  7 - \"3+\"  5-pixels plus packet (plus) \npattern =  8 - \"3x\"  5-pixels cross packet (cross) \npattern =  9 - \"9p\"  9-pixels square packet (box) \npattern = else - \"*\" 1-pixel  packet (single) \n------------------------------------------------------------------------------------ \npattern==0                   Standard Search : std-pixel    selection + likelihood2G \npattern!=0 && pattern<0      Mixed    Search : packet-pixel selection + likelihood2G  \npattern!=0 && pattern>0      Packed   Search : packet-pixel selection + likelihoodWP \n",
        "type": "integer"
    },
    "plot_injection": {
        "cwb": false,
        "default": false,
        "description": "plot injected waveform",
        "type": "boolean"
    },
    "plot_sky_map": {
        "cwb": false,
        "default": false,
        "description": "plot sky maps",
        "type": "boolean"
    },
    "plot_trigger": {
        "cwb": false,
        "default": false,
        "description": "plot triggers",
        "type": "boolean"
    },
    "plot_waveform": {
        "cwb": false,
        "default": false,
        "description": "plot waveform from triggers",
        "type": "boolean"
    },
    "plugin": {
        "c_type": "TMacro",
        "default": "",
        "type": "string"
    },
    "precision": {
        "default": 0.0,
        "description": "set parameters for big clusters events management",
        "type": "number"
    },
    "refIFO": {
        "default": "L1",
        "description": "reference IFO",
        "type": "string"
    },
    "save_injection": {
        "cwb": false,
        "default": false,
        "description": "save injected waveform",
        "type": "boolean"
    },
    "save_sky_map": {
        "cwb": false,
        "default": false,
        "description": "save sky maps to json",
        "type": "boolean"
    },
    "save_waveform": {
        "cwb": false,
        "default": false,
        "description": "save waveform from triggers",
        "type": "boolean"
    },
    "segEdge": {
        "default": 8.0,
        "description": "wavelet boundary offset [sec]",
        "type": "number"
    },
    "segLen": {
        "default": 600.0,
        "description": "Segment length [sec]",
        "type": "number"
    },
    "segMLS": {
        "default": 300.0,
        "description": "Minimum Segment Length after DQ_CAT1 [sec]",
        "type": "number"
    },
    "segOverlap": {
        "default": 0.0,
        "description": "overlap between job segments [sec]",
        "type": "number"
    },
    "segTHR": {
        "default": 30.0,
        "description": "Minimum Segment Length after DQ_CAT2 [sec] (to disable put segTHR=0)",
        "type": "number"
    },
    "select_subnet": {
        "default": 0.1,
        "description": "subnet netcluster select function threshold (coherence)",
        "type": "number"
    },
    "select_subrho": {
        "default": 5.0,
        "description": "subrho netcluster select function threshold (coherence)",
        "type": "number"
    },
    "simulation": {
        "default": null,
        "type": "string"
    },
    "skyMaskCCFile": {
        "default": "",
        "description": "sky mask file",
        "type": "string"
    },
    "skyMaskFile": {
        "default": "",
        "description": "sky mask file",
        "type": "string"
    },
    "slagMax": {
        "default": 0,
        "description": "select the maximum available slag distance",
        "type": "integer"
    },
    "slagMin": {
        "default": 0,
        "description": "select the minimum available slag distance : slagMin must be <= slagMax",
        "type": "integer"
    },
    "slagOff": {
        "default": 0,
        "description": "first slag id (slagOff=0 - include zero slag )",
        "type": "integer"
    },
    "slagSize": {
        "default": 0,
        "description": "number of super lags (simulation=1) - if slagSize=0 -> Standard Segments",
        "type": "integer"
    },
    "subacor": {
        "default": 0.0,
        "description": "sub network threshold in the skyloop subNetCuts, if<=0 then subacor=Acore (supercluster) ",
        "type": "number"
    },
    "subcut": {
        "default": 0.33,
        "description": "[0,1]   sub network threshold in the skyloop (supercluster)",
        "maximum": 1,
        "minimum": -1,
        "type": "number"
    },
    "subnet": {
        "default": 0.7,
        "description": "[0,0.7] sub network threshold (supercluster)",
        "maximum": 0.7,
        "minimum": 0,
        "type": "number"
    },
    "subnorm": {
        "default": 0.0,
        "description": " [0,2*num_resolution_levels] sub network norm threshold, enabled only if >0 (supercluster) ",
        "minimum": 0,
        "type": "number"
    },
    "subrho": {
        "default": 0.0,
        "description": "sub network threshold in the skyloop subNetCuts, if <=0 then subrho=netRHO (supercluster) ",
        "type": "number"
    },
    "trigger_dir": {
        "cwb": false,
        "default": "trigger",
        "description": "trigger directory",
        "type": "string"
    },
    "upTDF": {
        "default": 4,
        "description": "upsample factor to obtain rate of TD filter : TDRate = (inRate>>levelR)*upTDF",
        "type": "integer"
    },
    "use_root_supercluster": {
        "cwb": false,
        "default": true,
        "description": "use cwb supercluster, if false use python version",
        "type": "boolean"
    },
    "wdmXTalk": {
        "default": "wdmXTalk/OverlapCatalog_Lev_8_16_32_64_128_256_iNu_4_Prec_10.bin",
        "description": "WDM cross-talk file",
        "type": "string"
    },
    "whiteStride": {
        "default": 20.0,
        "description": "[sec] noise sampling time stride",
        "type": "number"
    },
    "whiteWindow": {
        "default": 60.0,
        "description": "[sec] time window dT. if = 0 - dT=T, where T is segment duration",
        "type": "number"
    }
},
"required": [
    "analysis",
    "ifo",
    "refIFO"
],
"type": "object"

}