CIMG
====

The Continuum Imaging Pipeline (CIMG) produces contimuum images from the pre-processed target field
visibilities (generated by BPP) and the gain table and facet regions generated by the
self-calibration pipeline (ICAL) using `WSClean <https://wsclean.readthedocs.io/en/latest/>`_.

Current outputs include model images, residual images and restored images. Work is planned to
support stacking images into a cube.

CIMG runs either on a single or multiple nodes (using MPI) and selected WSClean parameters are
configured using a YAML file as input. It can optionally accept a mask. CIMG is written in Python
and orchestrated with `prefect <https://docs.prefect.io/v3/get-started>`_. Its progress can be
monitored using the prefect UI.

.. mermaid::

    flowchart LR

        input_ms@{ shape: disk, label: "Pre-processed <br> Visibilities <br> (Target)"}
        solutions@{ shape: disk, label: "Gain Table (DDE)"}
        facet_regions@{ shape: disk, label: "Facet Regions"}
        config@{ shape: doc, label: "Configuration"}

        ical(("Self-Calibration<br>(ICAL)")) --> solutions & facet_regions
        bpp(("Batch Pre-Processing<br>(BPP)")) --> input_ms

        subgraph cimg["Continuum Imaging (CIMG)"]
            configure@{ shape: rect, label: "Configure pipeline" }
            image@{ shape: rect, label: "Run WSClean"}
            stack@{ shape: rect, label: "Stack images" }
        end

        image_cube@{ shape: disk, label: "Image cube"}
        images@{ shape: disk, label: "Images"}

        config --> configure --> image
        input_ms & solutions & facet_regions --> image
        image --> images
        image -.-> stack -.-> image_cube

        style stack fill:stroke-width:2px,stroke-dasharray: 5 5
        style image_cube fill:stroke-width:2px,stroke-dasharray: 5 5

Useful Links
------------

Complete the following with relevant links for your pipeline.

- **Repository**: https://gitlab.com/ska-telescope/sdp/science-pipeline-workflows/ska-sdp-cimg
- **Documentation**: https://developer.skao.int/projects/ska-sdp-cimg/en/latest/
- **Description**: Produces continuum images of the sky following self-calibration.
- **Quickstart**: https://developer.skao.int/projects/ska-sdp-cimg/en/latest/quickstart.html
- **Status**: In development
- **Contact**: Team GECKO
- **Where to get help**: `#gecko-cimg <https://skao.slack.com/archives/C09N77H8Y8K>`_