ALMA FITS Keywords: Difference between revisions

From Italian ARC
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:
Detailed information on the definition of the keywords provided by the AKF is presented in the  [[Media:AKF_v1.0.pdf|AKF_v1.0_manual ]]. <br>  
Detailed information on the definition of the keywords provided by the AKF is presented in the  [[Media:AKF_v1.0.pdf|AKF_v1.0_manual ]]. <br>  


It consists of two codes (that could eventually be called in sequence):<br>


1. AKF_v1.0_ms.py: it generates the following keywords:  It requires that (only) the  ms from which the input FITS image was produced is in the same folder as the image. Since the program browses the ms tables, it can take some minutes to run (and up to ~30 min for the biggest datasets as large as 100 Gb). However, it is possible to request the production of only specific keywords. <br>
A CASA task, the AKF, is build to generate and eventually ingest in the headers the FITS keywords discussed in the previous Sect. 3. The AKF is a Python-based script that exploits existing CASA tasks and  toolkit1. It is downloadable (AKF.tar) from the Italian ALMA Regional Center web page http://www.alma.inaf.it/index.php/ALMA_FITS_Keywords


2. AKF_v1.0_fits.py: it generates the keywords listed in Sect. 3.2. It calculates the values from the image itself and it is usually faster than the ms code. Also in this case it is possible to produce all or a selection of the keywords.<br>
In the following,  the instructions to install the task are described:
* be sure that astropy, numpy and pyfits are installed


The result of the codes is a Python dictionary.
* untar the AKF.tar file into a directory of your choice
(e.g., YourHomeDir/ITALIAN_TOOLS)


* cd YourHomeDir/ITALIAN_TOOLS


In the following,  the instructions to launch the codes are described:
* launch CASA and run "buildmytasks" in that directory
* enter the folder (yourDir) where your fits files and ms are stored
(i.e. os.system(‘buildmytasks’))
* launch CASA (any version > 5.0)
* define the image to process
* imageName = 'yourDir/yourImage.fits'
* define the list of keywords you want calculate
* kwdlist =['KWDi', 'KWDj',......, 'KWDk'] where KWDi,j,k are one or more keywords belong to the same category, either data acquisition or image description keywords
* launch the correct code according to the requested category of keywords with
  execfile('AKF_v1.0_ms.py') and/or execfile('AKF_v1.0_fits.py')  


Below the codes:<br>
* rename mytasks.py in ITtask_AKF.py
[[Media:AKF_v1.0_fits.py |AKF_v1.0_fits.py]]<br>
(i.e. mv mytasks.py ITtask_AKF.py)
[[Media:AKF_v1.0_ms.py |AKF_v1.0_ms.py]]
 
* execfile(‘YourHomeDir/ITALIAN_TOOLS/ITtask_AKF.py')
 
* you should be able to run the new task in CASA just doing:
inp AKF  or  tget AKF
 
The inputs of the task are:
* imName: it is the input image to process  and it is a mandatory parameter to provide;
* kwdlist: it consists in the list of keywords to be calculated. The allowed keywords are those of Sect. 3. If the list is not given (kwdlist=[]), all the implemented keywords will be calculated.
* outfile: the name of disk file to write the output could be given. If no outfile name is given, the results will be written only to the terminal;
* include: it allows to ingest the calculated keywords in the FITS headers. The default is false which means that no keywords will be added to the headers.
 
Below the AKF CASA task <br>
[[Media:AKF.tar |AKF.tar]]<br>

Revision as of 15:43, 17 July 2018

The ALMA Keywords Filler (AKF) is a Python-based script that exploits existing CASA tasks and toolkit (https://casa.nrao.edu/docs/CasaRef/CasaRef.html)
Detailed information on the definition of the keywords provided by the AKF is presented in the AKF_v1.0_manual .


A CASA task, the AKF, is build to generate and eventually ingest in the headers the FITS keywords discussed in the previous Sect. 3. The AKF is a Python-based script that exploits existing CASA tasks and toolkit1. It is downloadable (AKF.tar) from the Italian ALMA Regional Center web page http://www.alma.inaf.it/index.php/ALMA_FITS_Keywords

In the following, the instructions to install the task are described:

  • be sure that astropy, numpy and pyfits are installed
  • untar the AKF.tar file into a directory of your choice

(e.g., YourHomeDir/ITALIAN_TOOLS)

  • cd YourHomeDir/ITALIAN_TOOLS
  • launch CASA and run "buildmytasks" in that directory

(i.e. os.system(‘buildmytasks’))

  • rename mytasks.py in ITtask_AKF.py

(i.e. mv mytasks.py ITtask_AKF.py)

  • execfile(‘YourHomeDir/ITALIAN_TOOLS/ITtask_AKF.py')
  • you should be able to run the new task in CASA just doing:

inp AKF or tget AKF

The inputs of the task are:

  • imName: it is the input image to process and it is a mandatory parameter to provide;
  • kwdlist: it consists in the list of keywords to be calculated. The allowed keywords are those of Sect. 3. If the list is not given (kwdlist=[]), all the implemented keywords will be calculated.
  • outfile: the name of disk file to write the output could be given. If no outfile name is given, the results will be written only to the terminal;
  • include: it allows to ingest the calculated keywords in the FITS headers. The default is false which means that no keywords will be added to the headers.

Below the AKF CASA task
AKF.tar

Retrieved from "https://www.alma.inaf.it/index.php?title=ALMA_FITS_Keywords&oldid=3542"