csiactdata.py

Go to the documentation of this file.

#!/usr/bin/env python
# ==========================================================================
# Inspect an IACT data storage
#
# Copyright (C) 2015-2022 Michael Mayer
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# ==========================================================================
import sys
import os
import json
import gammalib
import ctools


# ================ #
# csiactdata class #
# ================ #
class csiactdata(ctools.cscript):
    """
    Inspect an IACT data storage
    
    This script inspects the available FITS data storage on the user machine
    and writes information about the available FITS configurations into a log
    file or prints it on the screen. These information can be used as input
    for 'csiactobs'.
    """

    # Constructor
    def __init__(self, *argv):
        """
        Constructor.
        """
        # Initialise application by calling the base class constructor
        self._init_cscript(self.__class__.__name__, ctools.__version__, argv)

        # Set name
        self._datapath    = os.getenv('VHEFITS','')
        self._prodnames   = []
        self._master_indx = ''
        self._master_file = ''

        # Return
        return


    # Private methods
    def _get_parameters(self):
        """
        Get parameters from parfile and setup the observation
        """
        # Query datapath. If the parameter is not NONE then use it, otherwise
        # use the datapath from the VHEFITS environment variable
        datapath = self['datapath'].string()
        if gammalib.toupper(datapath) != 'NONE':
            self._datapath = datapath
        else:
            self._datapath = os.getenv('VHEFITS','')

        # Expand environment
        self._datapath = gammalib.expand_env(self._datapath)

        # Get filename of master index file
        self._master_indx = self['master_indx'].string()
        self._master_file = os.path.join(self._datapath, self._master_indx)

        # Check for presence of master index file
        if not os.path.isfile(self._master_file):
            raise RuntimeError('Master index file "'+self._master_file+
                               '" not found. Use hidden parameter '+
                               '"master_indx" to specifiy a different '+
                               'filename.')

        #  Write input parameters into logger
        self._log_parameters(gammalib.TERSE)
        
        # Return
        return

    # Log configuration
    def _log_configuration(self, config):
        """
        Log configuration
        
        Parameters
        ----------
        config : dict
            Dictionary containing data configuration
        """
        # Log configuration information
        self._log_header3(gammalib.TERSE, str(config['name']))
        self._log_value(gammalib.TERSE, 'Name', config['name'])
        self._log_value(gammalib.TERSE, 'Observation index', config['obsindx'])
        self._log_value(gammalib.TERSE, 'HDU index', config['hduindx'])
            
        # Print additional information
        for key in config:
                
            # Skip keys that were treated above
            if key in ['name','hduindx','obsindx']:
                continue
            self._log_value(gammalib.TERSE, key, config[key])

        # Return
        return


    # Public methods
    def process(self):
        """
        Process the script
        """
        # Get parameters
        self._get_parameters()

        # Write header into logger
        if self._logTerse():
            self._log('\n')
            self._log.header1('Data storage entries')
            self._log.parformat('Master index file')
            self._log(self._master_file)
            self._log('\n')
        
        # Open and load JSON file
        json_data = open(self._master_file).read()
        data      = json.loads(json_data)    
        configs   = data['datasets']
        
        # Initialise array for available names
        self._prodnames = []

        # Write header into logger
        self._log('\n')
        self._log.header2('Available data configs')
        
        # Loop over configs and log available configs       
        for config in configs:       
            
            # Create hdu and obs index files
            hdu          = os.path.join(self._datapath, config['hduindx'])
            obs          = os.path.join(self._datapath, config['obsindx'])
            filename_hdu = gammalib.GFilename(str(hdu)+'[HDU_INDEX]')
            filename_obs = gammalib.GFilename(str(obs)+'[OBS_INDEX]')
            
            # If index files are available then log configuration
            # information ...
            if (filename_hdu.is_fits() and filename_obs.is_fits()):

                # Append to available names
                self._prodnames.append(str(config['name']))
                
                # Log information
                self._log_configuration(config)

            # ... otherwise log that the configuration is not available
            else:
                if self._logTerse():
                    self._log.header3(str(config['name']))
                    self._log(' Not available\n')

        # Return
        return       

    def names(self):
        """ 
        Return available FITS production names
        
        Returns
        -------
        names : list of str
            List of available FITS production names.
        """
        # Return
        return self._prodnames


# ======================== #
# Main routine entry point #
# ======================== #
if __name__ == '__main__':

    # Create instance of application
    app = csiactdata(sys.argv)

    # Execute application
    app.execute()