Alexander Ziegler / ctools

#!/usr/bin/env python
# ==========================================================================
# Shows the content of a model container
#
# Copyright (C) 2015-2016 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 gammalib
import ctools


# ================= #
# csmodelinfo class #
# ================= #
class csmodelinfo(ctools.cscript):
    """
    Shows the content of a model container

    The script is useful to show, e.g., the number of sources in a model
    container, the background models, free and fixed parameters etc.
    The script can also dump the models into a region file to for display
    with DS9.
    """

    # Constructor
    def __init__(self, *argv):
        """
        Constructor
        """
        # Set name
        self._name    = 'csmodelinfo'
        self._version = '1.2.0'

        # Initialise class members
        self._models = gammalib.GModels()

        # Initialise application by calling the appropriate class constructor
        self._init_cscript(argv)

        # Return
        return


    # Private methods
    def _get_parameters(self):
        """
        Get parameters from parfile and setup the observation
        """
        # Get models
        self._models = gammalib.GModels(self['inmodel'].filename())
        
        # Query hidden parameters for region file
        self['pnt_type'].string()
        self['pnt_mark_size'].integer()
        self['show_labels'].boolean()
        self['width'].integer()
        self['fontfamily'].string()
        self['fontsize'].integer()
        self['fontweight'].string()
        self['fontslant'].string()
        self['show_ext_type'].boolean()
        self['free_color'].string()
        self['fixed_color'].string()

        # Query ahead DS9 filename
        if self._read_ahead():
            self["ds9file"].filename()

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

    def _ds9attributes(self, model):
        """
        Returns attributes for DS9 string
        Parameters
        ----------
        model : `~gammalib.GModel`
            Model

        Returns
        -------
        attributes : str
            DS9 attribute string
        """
        # Determine region color. A model where all parameters are fixed will
        # get the color defined by "fixed_color", a model with at least one
        # free parameter will get the color defined by "free_color".
        color = self['fixed_color'].string()
        for par in model:
            if par.is_free():
                color = self['free_color'].string()
                break

        # Set DS9 attributes
        attributes = (' color=%s width=%d font=%s %d %s %s' %
                      (color, self['width'].integer(),
                       self['fontfamily'].string(), self['fontsize'].integer(),
                       self['fontweight'].string(), self['fontslant'].string()))

        # Return attributes
        return attributes

    def _model2ds9string(self, model):
        """
        Converts model into a DS9 region string

        Parameters
        ----------
        model : `~gammalib.GModel`
            Model

        Returns
        -------
        ds9string : str
            DS9 region string
        """
        # Initialise DS9 region string
        ds9string = ''

        # Retrieve model sky direction. The model is skipped in case that
        # it does not provide a sky direction.
        is_valid = True  
        try:
            modelpos = model.spatial().dir()
        except AttributeError:            
            msg = ('Skip model "%s" since it has no sky direction.\n' %
                   model.name())
            self._log(msg)
            is_valid = False

        # Continue only if sky direction was found
        if is_valid: 

            # Retrieve model type and name   
            modeltype = model.type()
            modelname = model.name()

            # Handle point source
            if modeltype == 'PointSource':

                # Append point with Right Ascension and Declination to the DS9
                # string. The type of the point is specified by the "pnt_type"
                # parameter, the size of the point by the "pnt_mark_size"
                # parameter
                ds9string += ('point(%.6f,%.6f) # point=%s %d' %
                              (modelpos.ra_deg(), modelpos.dec_deg(),
                               self['pnt_type'].string(),
                               self['pnt_mark_size'].integer()))

            # Handle extended sources    
            elif modeltype == "ExtendedSource":

                # Retrieve spatial model
                spatial   = model.spatial()
                classname = spatial.classname()

                # Handle radial sources
                if 'Radial' in classname:

                    # Retrieve short name of model class (e.g. "Gauss"
                    # or "Disk)
                    shorttype = classname.split('Radial')[-1]

                    # Handle Disk and Shell model
                    if (classname == 'GModelSpatialRadialDisk' or
                        classname == 'GModelSpatialRadialShell'):
                        size = spatial.radius()

                    # Handle Gauss Model
                    elif classname == 'GModelSpatialRadialGauss':
                        size = spatial.sigma()

                    # Skip if source is unknown
                    else:
                        msg = ('Skip model "%s" since the radial model "%s" '
                               'is unknown.\n' % (model.name(), classname))
                        self._log(msg)
                        is_valid = False

                    # Append circle to DS9 string
                    if is_valid:
                        ds9string += ('circle(%.6f,%.6f,%.6f) #' %
                                      (modelpos.ra_deg(), modelpos.dec_deg(),
                                       size*3600.0))
            
                # Handle elliptical sources 
                elif 'Elliptical' in classname:

                    # Retrieve short name and source size
                    shorttype = classname.split('Elliptical')[-1]
                    size1     = spatial.semimajor()
                    size2     = spatial.semiminor()
                    angle     = spatial.posangle()

                    # Append ellipse to DS9 string
                    ds9string += ('ellipse(%.6f,%.6f,%.6f,%.6f,%.6f) #' %
                                  (modelpos.ra_deg(), modelpos.dec_deg(),
                                   size1*3600.0, size2*3600.0, angle+90.0))
                
                # Skip if source is neither radial nor elliptical      
                else:
                    msg = ('Skip model "%s" since the model "%s" is neither '
                           'a point source, a radial source, nor an elliptical '
                           'source.\n' % (model.name(), classname))
                    self._log(msg)
                    is_valid = False
                
                # Add short model type to modelname
                if self['show_ext_type'].boolean():
                    modelname +=' ('+shorttype+')'
    
            # Add DS9 attributes
            if is_valid:
                ds9string += self._ds9attributes(model)
                if self['show_labels'].boolean():
                    ds9string += ' text={'+modelname+'}'
        
        # Return string
        return ds9string 


    # Public methods
    def run(self):
        """
        Run the script
        """
        # Switch screen logging on in debug mode
        if self._logDebug():
            self._log.cout(True)

        # Get parameters
        self._get_parameters()
        
        # Optionally log models
        if self._logVerbose():
            self._log('\n')
            self._log.header1('Models')
            self._log('\n')
            self._log(str(self._models))
            self._log('\n')
        
        # Initialise output values 
        types           = {}
        instruments     = {}
        ts              = {}
        pars_at_limit   = {}
        free_src_pars   = {}
        n_par_total     = 0
        n_par_free      = 0
        n_par_fixed     = 0
        n_par_at_limit  = 0
        n_par_free_bkg  = 0
        n_par_free_src  = 0
        n_par_free_spec = 0
        n_par_free_spat = 0
        n_par_free_temp = 0
        
        # Loop over models and initialise dictionaries with model names
        for model in self._models:
            types[model.type()] = 0 
            instruments[model.instruments()] = 0
            pars_at_limit[model.name()] = []

        # Loop over models again and fill values to be dumped
        for model in self._models:
            
            # Model types
            types[model.type()] += 1
            
            # Model instruments
            instruments[model.instruments()] += 1 
            
            # TS
            if model.has_ts():
                ts[model.name()] = model.ts()
                
            # Skymodel?
            skymodel = (model.classname() == 'GModelSky')
            if skymodel:
                free_src_pars[model.name()] = []                
            
            # Loop over model parameters
            for par in model:
                
                # Increment total parameters
                n_par_total += 1
                
                # Check if parameter is at limit
                if par.has_range():
                    if par.value() == par.min() or par.value() == par.max():
                        pars_at_limit[model.name()].append(par.name())   
                        n_par_at_limit += 1 
                        
                # Check if model parameter is free/fixed and
                # increment respective variable      
                if par.is_free():         
                    n_par_free += 1
                    if skymodel:
                        free_src_pars[model.name()].append(par)
                        n_par_free_src += 1
                    else:
                        n_par_free_bkg += 1
                else:
                    n_par_fixed += 1
            
            # If sky model, divide free parameters into spatial, spectral
            # and temporal
            if skymodel:
                for par in model.spectral():
                    if par.is_free():
                        n_par_free_spec += 1
                for par in model.spatial():
                    if par.is_free():
                        n_par_free_spat += 1
                for par in model.temporal():
                    if par.is_free():
                        n_par_free_temp += 1     

        # Optionally log model information
        if self._logTerse():
        
            # Log summary
            self._log_header1(gammalib.TERSE, 'Summary')
        
            # Log instruments
            self._log.header3('Instrument specific models')
            for inst, n_inst in instruments.items():
                if inst == '':
                    inst = 'All'
                self._log_value(gammalib.TERSE, inst, n_inst)
        
            # Log model types
            self._log_header3(gammalib.TERSE, 'Model types')
            for modeltype, n_types in types.items():
                self._log_value(gammalib.TERSE, modeltype, n_types)
        
            # Log model parameter information
            self._log_header1(gammalib.TERSE,'Parameter information')
            self._log_value(gammalib.TERSE,'All parameters', n_par_total)
            self._log_value(gammalib.TERSE,'Fixed parameters', n_par_fixed)
            self._log_value(gammalib.TERSE,'Free parameters (total)', n_par_free)
            self._log_value(gammalib.TERSE,'Free background parameters', n_par_free_bkg)
            self._log_value(gammalib.TERSE,'Free source parameters', n_par_free_src)
            if n_par_free_spec > 0:
                self._log_value(gammalib.TERSE,'Free spectral parameters', n_par_free_spec)
            if n_par_free_spat > 0:
                self._log_value(gammalib.TERSE,'Free spatial parameters', n_par_free_spat)
            if n_par_free_temp > 0:
                self._log_value(gammalib.TERSE,'Free temporal parameters', n_par_free_temp)
            self._log_value(gammalib.TERSE,'Parameters at limit', n_par_at_limit)
        
            # Log parameters at limit (if any)
            if n_par_at_limit > 0:
                self._log_header3(gammalib.TERSE, 'Parameters at limit')
                for source, parameter in pars_at_limit.items():   
                    if len(parameter):  
                        for par in parameter:
                            self._log_value(gammalib.TERSE, source, par)
        
            # Optionally log free parameters
            if len(free_src_pars):
                self._log_header2(gammalib.EXPLICIT, 'Free source parameters')
                for source, parameter in free_src_pars.items():   
                    if len(parameter): 
                        self._log.header3(source)
                        for par in parameter:
                            self._log_string(gammalib.EXPLICIT, str(par)+'\n')
        
            # Log TS values if available
            if len(ts):       
                self._log_header3(gammalib.TERSE, 'Test statistics')
                for source, tsvalue in ts.items():
                    self._log_value(gammalib.TERSE, source, tsvalue)
                
        # Return
        return

    def save(self):
        """ 
        Save models to ds9 region file
        """
        # Get output filename
        ds9file = self['ds9file'].filename()

        # Check if DS9 file is valid
        if ds9file != '' and ds9file != 'NONE':
            
            # Write header
            self._log_header1(gammalib.TERSE, 'Save models in DS9 file')
            
            # Log filename
            self._log_value(gammalib.NORMAL, 'DS9 filename', ds9file.url())
            
            # Open file   
            f = open(ds9file.url(), 'w')
            
            # Write coordinate system
            f.write('fk5\n')
             
            # Loop over models
            for model in self._models:
                
                # Continue only if point source or extended source model
                if (model.type() == 'PointSource' or
                    model.type() == 'ExtendedSource'):
                    line = self._model2ds9string(model)
                    if len(line):
                        f.write(line+'\n')
                
                # Logging for diffuse components    
                elif model.type() == 'DiffuseSource':
                    self._log('Skipping diffuse model "'+model.name()+'".\n')
                    
                # Logging for background components 
                else:
                    if self._logExplicit():
                        self._log('Skipping background model "'+model.name()+
                                  '".\n')
                                      
            # Close file
            f.close()
        
        # Return
        return 

    def execute(self):
        """
        Execute the script
        """
        # Open logfile
        self.logFileOpen()

        # Read ahead output parameters
        self._read_ahead(True)

        # Run the script
        self.run()

        # Save ds9 file if required
        self.save()

        # Return
        return    
        

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

    # Create instance of application
    app = csmodelinfo(sys.argv)
    
    # Execute application
    app.execute()