===========================================================
How to create regions using clustering code
===========================================================

The clustering code is contained in :mod:`cbasspy.clusteringCode`.

There is a convenient wrapper :mod:`cbasspy.createClusters`.

The wrapper is called as follows::

    python cbass_analysis/cbasspy/createClusters.py input_options.ini


Options file
------------
The input options are all passed using an .ini file.
A typical options file will look like the following::

    [inputOptions]
    # Location of the input maps
    map1_dir: ../
    map2_dir: /elephant/cbassvisitor3/v28allels_jk/smoothedMaps/
    map3_dir: ../
    # File names of the input maps
    map1_name: haslam408_ds_Remazeilles2014_1deg_0064.fits
    map2_name: NIGHT_v28allelsNs_ALL_noiseCut_masked5pc_G_1024_ol500_lessTol_g_map_g_1deg_0064.fits
    map3_name: 64_60.00smoothed_wmap9decbeamCMBcommandersub_22.8_512_2013_mKCMBunits_mono_Krj.fits
    # Frequencies of the maps
    freq1: 0.408e9
    freq2: 4.75e9
    freq3: 22.5e9
    # Zero level offsets to apply to the maps
    offset1: 0.
    offset2: 0.020
    offset3: 0.
    # Voronoi options
    voronoi_min_pixels: 20
    voronoi_threshold_score: 2.5
    # Meanshift options
    meanshift_min_bin_freq: 20
    meanshift_bandwidth:0.13
    # Which to do
    do_voronoi: False
    do_meanshift: True
    [outputOptions]
    meanshift_out_name : regions_cabHasWma_meanshift_1.fits
    voronoi_out_name : regions_cba_voronoi_1.fits