ADMIT Products and Usage

From CASA Guides
Revision as of 16:25, 18 October 2019 by Alipnick (talk | contribs)
Jump to navigationJump to search

Intro/What is ADMIT?

The ALMA Data-Mining Toolkit (ADMIT) is an execution environment and set of tools for analyzing image data cubes. ADMIT is based on python and designed to be fully compliant with CASA and to utilize CASA routines where possible. ADMIT has a flow-oriented approach, executing a series of ADMIT Tasks (AT) in a sequence to produce a sequence of outputs. For the beginner, ADMIT can be driven by simple scripts that can be run at the Unix level or from inside of CASA. ADMIT provides a simple browser interface for looking at the data products, and all major data products are on disk as CASA images and graphics files. For the advanced user, ADMIT is a python environment for data analysis and for creating new tools for analyzing data.

For a detailed quick-look at ALMA images, standardized ADMIT “recipes” can be run which produce various products depending on the image type. For continuum images, ADMIT simply finds some of the basic image properties (RMS, peak flux, etc) and produces a moment map. For cube images, ADMIT will analyze the cube, attempt to identify spectral features, and create moment maps of each identified spectral line.

ADMIT does not interact with u,v data or create images from u,v data; CASA should be used to create images. ADMIT provides a number of ways to inspect your image cubes. The astronomer can then decide whether the ALMA image cubes need to be improved, which requires running standard CASA routines to re-image the u,v data. If new images are made, the ADMIT flow can be run on these new image cubes to produce new set of ADMIT products.

Obtaining ADMIT and data for this guide

For this CASA Guide, we will go through creating an ADMIT product of some science verification data and then inspect the output. You’ll of course need CASA installed ( as well as ADMIT. To install ADMIT from scratch, you’ll need to clone the source code using git:

# In bash
git clone

If this method doesn't work for whatever reason, you can also use wget and then untar the file:

# In bash
tar zxf admit.tar.gz

Then execute the configure step to create the necessary environment replacing "X" with the necessary software versions.

# In bash
cd admit_1.X.X
./configure --with-casa-root=/path/to/casa-release-X.X.X

Once you have run the configure script, simply source the script before executing any ADMIT commands.

# In bash

If you want to check that ADMIT is set up, you can type

# In bash

In your terminal after sourcing the start script and you should see the directory paths and versions of ADMIT. For more details, please see:

For this guide, we’ll be using the data from the Antennae Band 7 CASA Guide. We’ll just need the reference images, Antennae_Band7_ReferenceImages.tgz, which are available here:

Untar the package in your working area.

Creating an ADMIT product

Now that we have some ALMA images and ADMIT installed, let’s run one of the standard ADMIT recipes on our image. There are two standard recipes that handle most ALMA images, (or runa1, which works on data cubes and (or runa2, which works on continuum images. These images are data cubes so we’ll use the first recipe. There are two ways to do this, if you just want the results of the ADMIT recipe just type

# In bash
runa1 Antennae_North.CO3_2Line.Clean.pcal1.image.fits

within the directory where the image is located. runa1 is the default implementation and gives a streamlined result. Another option is to specify the recipe which allows you to use flags for customization. To do this, type:

# In bash
/path/to/your/admit/installation/admit/admit/test/ Antennae_North.CO3_2Line.Clean.pcal1.image.fits

This will produce identical output as runa1; however, there are over 30 tunable parameters that allow you to set the VLSR, rest frequency, regions of interest, etc. as well as many line identification parameters to tune such as using the online version of Splatalogue rather than the internal one for line identification. These can be tuned via creating a file with your parameter choices and specifying it via the --apar flag. Later in this guide we will go through a little bit more on how to customize ADMIT to better suit your data but for now, more information can be found here:

In the end, either method (runa1 or will result in the creation of a file named Antennae_North.CO3_2Line.Clean.pcal1.image.admit which contains the output from the ADMIT recipe.

The ADMIT weblog, viewing the ADMIT product

To view the ADMIT output by descending into the Antennae_North.CO3_2Line.Clean.pcal1.image.admit directory and open up the index.html file in your favorite browser (currently Firefox is the best option). This will open up the ADMIT browser interface (weblog) which is the most convenient way to view the ADMIT results on the image. It should look something like Figure 1.

<figure id="ADMIT_weblog_homepage.png">

The homepage for an ADMIT weblog. Each green horizontal bar represents an individual ADMIT task that was run and clicking on it will expand that section to show more details and the output for that section.


The text within each bar gives the ADMIT Task name, the task ID number, the parameters that were used within that task, and any output image names (Figure 1). Clicking on one of the green horizontal bars will reveal all the output for that ADMIT task. Just under the expanded bar will be the task name (which hyperlinks to the ADMIT wiki page for that task) and a one-line explanation of what that task does.

<figure id="ADMIT_task_link.png">

Below each green horizontal bar is a one-line description of that ADMIT task, clicking on the task name hyperlinks to the ADMIT wiki page for that task.


Now, we will go through all of the output in the ADMIT weblog and describe what each task does and what output to expect.

The ADMIT data Flow

Clicking on the top-most bar of the weblog, “Flow Diagram for Antennae_North.CO3_2Line.Clean.pcal1.image.admit” (see Figure 1), reveals the “ADMIT Flow Diagram” (Figure 3). This is an illustration of how the products created in each task flow through the entire process. For a detailed discussion of how ADMIT flows work (and how to create your own) please see

For continuum images, these diagrams are extremely simple but for line-dense image cubes these can be incredibly complicated. Figure 3 shows what the ADMIT Flow looks like for our dataset. This diagram is a directed acyclic graph representing the ADMIT Task connections. Each arrow represents the connection from an ADMIT task output to the input of another ADMIT Task. The integer next to each arrow is the zero-based index of the ADMIT Task's output basic data product. Note that any output basic data product may be used as the input for more than one ADMIT Task.

<figure id="ADMIT_Flow_diagram_example.png">

The ADMIT Flow diagram for processing the Antennae_North.CO3_2Line.Clean.pcal1.image.fits file.