|

cwb_xmdc
~~~~~~~~~~~~

This page provides a description of the cwb_xmdc command.

|
| **Usage**
|
|  This command drives the :doc:`../xmdc` engine: it generates an XMDC
|  injection set from a user configuration macro, pre-generates MDC frame
|  files for a given job (optional, only needed when frame files are
|  actually required), and produces postproduction reports from a merged
|  XMDC analysis.
|
| **Syntax**
|

 - ``cwb_xmdc`` (without arguments, or with ``help``)
    Prints help
 - ``cwb_xmdc xmdc_user_config_macro.C 'xmdc_options'``
    Make injections: runs the user configuration macro and produces the XMDC file
 - ``cwb_xmdc job_id``
    Make frame: pre-generates real MDC frame files for the given XMDC job (an integer job ID)
 - ``cwb_xmdc merge_label 'xmdc_options'``
    Postproduction reports: produces XMDC reports from a merged ``.S_ifar.root`` file

|
| **Further information**
|

 The following options can be passed to cwb_xmdc

 .. code-block:: bash

    xmdc_type = xmdc_user_config_macro_name.C / job_id / merge_label

    - make injections

      - xmdc_user_config_macro_name.C
        - xmdc_options = '--ninj number of injections --seed seed (def=150914) --tag tag_name --odir dir_name (def=xmdc) --rtype (def=all, none-> no reports))'
                        eg: cwb_xmdc XMDC_Config_BurstLF_CCSN.C '--ninj 10 --seed 1 --rtype all'

    - make frame

      - job_id

    - postproduction reports

      - merge_label
        - xmdc_options = '--xmdc_fname xmdc file name --rttype (visible_volume/hrss50(90)/dist50(90)/snr_distance/gd/eff2vv/eff2hrss50(90)/eff2dist50(90)) --ifar ifar_years)'
                        eg: cwb_xmdc M1.C_U.XGB_rthr0_run1_v3.S_ifar '--xmdc_fname xmdc_file_name --rtype snr_distance --ifar 100'
                        eg: cwb_xmdc M1.C_U.XGB_rthr0_run1_v3.S_ifar '--xmdc_fname xmdc_file_name --rtype visible_volume --compare_dir idir --compare_label label'
                        eg: cwb_xmdc M1.C_U.XGB_rthr0_run1_v3.S_ifar '--xmdc_fname xmdc_file_name --rtype gd'
                        eg: cwb_xmdc M1.C_U.XGB_rthr0_run1_v3.S_ifar '--rtype eff2vv --ifar 100 --xeff_min 1e-23 --xeff_max 1e-21 --hrss_1mpc 1e-22'
                            Note: --xeff_min (def=1e-23) --xeff_max (def=1e-21) --hrss_1mpc (def=1e-22) are optionals

 See :doc:`../xmdc` for the full workflow (configuration, on-the-fly vs.
 frame-based injection, and the meaning of each report type).

|
| **Examples**
|

 -  The following command **generates 10 injections from a CCSN configuration macro**:

    - ``cwb_xmdc XMDC_Config_BurstLF_CCSN.C '--ninj 10 --seed 1 --rtype all'``

 -  The following command **pre-generates the MDC frame files for job 3**:

    - ``cwb_xmdc 3``

 -  The following command **produces a visible-volume-vs-IFAR report at IFAR=100 years**:

    - ``cwb_xmdc M1.C_U.XGB_rthr0_run1_v3.S_ifar '--xmdc_fname xmdc_file_name --rtype snr_distance --ifar 100'``