From 07c969314589afa3b127f4f1298f9f0cee469aa9 Mon Sep 17 00:00:00 2001 From: knodlseder <> Date: Fri, 29 Jul 2011 04:42:21 +0000 Subject: [PATCH] rename to cssens.py --- scripts/cssens | 649 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- scripts/cssens.py | 654 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 654 insertions(+), 649 deletions(-) delete mode 100755 scripts/cssens create mode 100755 scripts/cssens.py diff --git a/scripts/cssens b/scripts/cssens deleted file mode 100755 index 3813a3d..0000000 --- a/scripts/cssens +++ /dev/null @@ -1,649 +0,0 @@ -#! /usr/bin/env python -# ========================================================================== -# This script computes the CTA sensitivity for a number of energy bins using -# ctlike. Crab spectra are fitted in narrow energy bins to simulated data, -# and the flux level is determined that leads to a particular significance. -# The significance can be either determined using the Test Statistic (which -# is defined as twice the likelihood difference between fitting with and -# without the test source) or using the source model scaling factor (or -# Prefactor) divided by its statistical error. The latter has been turned -# out to be more reliable, and is used as default parameter. -# -# Copyright (C) 2011 Jurgen Knodlseder -# -# 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 . -# -# ========================================================================== -from ctatools import * -from gammalib import * -import obsutils -import sys -import csv -import math - - -# ============ # -# cssens class # -# ============ # -class cssens(GApplication): - """ - This class implements the sensitivity computation script. It derives - from the GammaLib::GApplication class which provides support for parameter - files, command line arguments, and logging. In that way the Python - script behaves just as a regular ctool. - """ - def __init__(self): - """ - Void constructor. - """ - # Set name - self.name = "cssens" - self.version = "0.1.0" - - # Make sure that parfile exists - file = self.parfile() - - # Initialise application - GApplication.__init__(self, self.name, self.version) - - # Set logger properties - self.logFileOpen() - self.log_header() - self.log.date(True) - - # Return - return - - def __init__(self, argv): - """ - Command line constructor. - """ - # Set name - self.name = "cssens" - self.version = "0.1.0" - - # Make sure that parfile exists - file = self.parfile() - - # Initialise application - GApplication.__init__(self, self.name, self.version, argv) - - # Set logger properties - self.logFileOpen() - self.log_header() - self.log.date(True) - - # Return - return - - def __del__(self): - """ - Destructor. - """ - # Write separator into logger - if self.logTerse(): - self.log("\n") - - # Return - return - - def parfile(self): - """ - Check if parfile exists. If parfile does not exist then create a - default parfile. This kluge avoids shipping the cscript with a parfile. - """ - # Set parfile name - parfile = self.name+".par" - - try: - pars = GPars(parfile) - except: - # Signal if parfile was not found - print "Parfile "+parfile+" not found. Create default parfile." - - # Create default parfile - pars = GPars() - pars.append(GPar("outfile","f","h","sensitivity.dat","","","Output file name")) - pars.append(GPar("caldb","s","a","$GAMMALIB/share/caldb/cta","","","Calibration database")) - pars.append(GPar("irf","s","a","kb_E_50h_v3","","","Instrument response function")) - pars.append(GPar("duration","r","a","180000.0","","","Effective exposure time (s)")) - pars.append(GPar("rad","r","a","5.0","","","Radius of ROI (deg)")) - pars.append(GPar("enumbins","i","h","0","","","Number of energy bins")) - pars.append(GPar("sigma","r","h","5.0","","","Significance threshold")) - pars.append(GPar("ts_use","b","h","no","","","Use TS instead of Sigma?")) - pars.append(GPar("index","r","h","-2.48","","","Assumed spectral index")) - pars.append(GPar("max_iter","i","h","50","","","Maximum number of iterations")) - pars.append(GPar("num_avg","i","h","3","","","Number of iterations for sliding average")) - pars.append_standard() - pars.save(parfile) - - # Return - return - - def get_parameters(self): - """ - Get parameters from parfile. - """ - # Get parameters - self.m_outfile = self["outfile"].filename() - self.m_caldb = self["caldb"].string() - self.m_irf = self["irf"].string() - self.m_duration = self["duration"].real() - self.m_roi = self["rad"].real() - self.m_nbins = self["enumbins"].integer() - self.m_ts_thres = self["sigma"].real()*self["sigma"].real() - self.m_use_ts = self["ts_use"].boolean() - self.m_index = self["index"].real() - self.m_max_iter = self["max_iter"].integer() - self.m_num_avg = self["num_avg"].integer() - - # Set some fixed parameters - self.m_log = False # Logging in client tools - self.m_debug = False # Debugging in client tools - - # Return - return - - def execute(self): - """ - Execute the script. - """ - # Run the script - self.run() - - # Return - return - - 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() - - # Write input parameters into logger - if self.logTerse(): - self.log_parameters() - self.log("\n") - - # Initialise script - colnames = ['loge', 'emin', 'emax', 'crab', 'pflux', 'eflux'] - results = [] - - # Initialise models. Note that we centre the point source at the Galactic - # center as our observation is also centred at the Galactic centre, so - # we're onaxis. - bkg_model = GModels() - full_model = GModels() - bkg_model.append(self.set_bkg_model()) - full_model.append(self.set_bkg_model()) - full_model.append(self.set_src_model(0.0, 0.0, index=self.m_index)) - - # Write models into logger - if self.logTerse(): - self.log("\n") - self.log.header1("Models") - self.log.header2("Background model") - self.log(str(bkg_model)) - self.log("\n\n") - self.log.header2("Full model") - self.log(str(full_model)) - self.log("\n") - - # Write heder - if self.logTerse(): - self.log("\n") - self.log.header1("Sensitivity determination") - - # Loop over energy bands. The number of energy band is still - # fixed ... - for ieng in range(21): - - # Set energies - loge = -1.7 + ieng * 0.2 - emean = pow(10.0, loge) - emin = pow(10.0, loge-0.1) - emax = pow(10.0, loge+0.1) - - # Setup observation(s) - obs = self.set_obs(emin=emin, emax=emax) - - # Determine sensitivity - result = self.get_sensitivity(obs, bkg_model, full_model) - - # Write results - if ieng == 0: - f = open(self.m_outfile, 'w') - writer = csv.DictWriter(f, colnames) - writer.writerow(dict((_,_) for _ in colnames)) - writer.writerow(result) - f.close() - else: - f = open(self.m_outfile, 'a') - writer = csv.DictWriter(f, colnames) - writer.writerow(result) - f.close() - - # Append results - results.append(result) - - # Return - return - - def set_obs(self, lpnt=0.0, bpnt=0.0, emin=0.1, emax=100.0): - """ - Returns an observation container with a single CTA observation. - - Keywords: - lpnt - Galactic longitude of pointing [deg] (default: 0.0) - bpnt - Galactic latitude of pointing [deg] (default: 0.0) - emin - Minimum energy [TeV] (default: 0.1) - emax - Maximum energy [TeV] (default: 100.0) - """ - # Allocate observation container - obs = GObservations() - - # Set single pointing - pntdir = GSkyDir() - pntdir.lb_deg(lpnt, bpnt) - - # Create CTA observation - run = obsutils.set(pntdir, caldb=self.m_caldb, irf=self.m_irf, \ - duration=self.m_duration, \ - emin=emin, emax=emax, rad=self.m_roi) - - # Append observation to container - obs.append(run) - - # Return observation container - return obs - - def set_bkg_model(self, fitidx=False): - """ - Setup standard CTA background model. We use a simple power law here, - scaled to Konrad's E configuration performance table. - - Keywords: - fitidx - Fit spectral index (default: False) - """ - # Define radial component - radial = GCTAModelRadialGauss(3.0) - - # Define spectral component - spectrum = GModelSpectralPlaw(61.8, -1.85) - spectrum["Prefactor"].scale(1.0e-6) - spectrum["PivotEnergy"].value(1.0) - spectrum["PivotEnergy"].scale(1.0e6) - if fitidx: - spectrum["Index"].free() - else: - spectrum["Index"].fix() - - # Create background model - model = GCTAModelRadialAcceptance(radial, spectrum) - model.name("Background") - model.instruments("CTA") - - # Return background model - return model - - def set_src_model(self, l, b, flux=1.0, index=-2.48, \ - type="point", sigma=1.0, radius=1.0, width=0.1, \ - fitpos=False, fitidx=False): - """ - Returns a single source with Crab-like spectrum. The source flux - can be scaled in Crab units. The Crab spectrum is based on MAGIC - observations (Albert et al. 2008, ApJ, 674, 1037). - - Parameters: - l - Galactic longitude of source location [deg] - b - Galactic latitude of source location [deg] - Keywords: - flux - Source flux [Crabs] - index - Spectral index - type - Source type ("point", "gauss", "disk", "shell") - sigma - Gaussian sigma (for type="gauss") - radius - Disk or shell inner radius [deg] (for type="disk" and type="shell") - width - Shell width [deg] (for type="shell") - fitpos - Fit position? (default: True) - fitidx - Fit index? (default: True) - """ - # Set source location - location = GSkyDir() - location.lb_deg(l, b) - - # Set source spectrum - spectrum = GModelSpectralPlaw(flux, index) - spectrum["Prefactor"].scale(5.7e-16) - spectrum["PivotEnergy"].value(0.3) - spectrum["PivotEnergy"].scale(1.0e6) - if fitidx: - spectrum["Index"].free() - else: - spectrum["Index"].fix() - - # Set source - if type == "point": - spatial = GModelSpatialPtsrc(location) - if fitpos: - spatial[0].free() - spatial[1].free() - source = GModelPointSource(spatial, spectrum) - elif type == "gauss": - radial = GModelRadialGauss(location, sigma) - if fitpos: - radial[0].free() - radial[1].free() - source = GModelExtendedSource(radial, spectrum) - elif type == "disk": - radial = GModelRadialDisk(location, radius) - if fitpos: - radial[0].free() - radial[1].free() - source = GModelExtendedSource(radial, spectrum) - elif type == "shell": - radial = GModelRadialShell(location, radius, width) - if fitpos: - radial[0].free() - radial[1].free() - source = GModelExtendedSource(radial, spectrum) - else: - self.log("ERROR: Unknown source type '"+type+"'.\n") - return None - - # Set source name - source.name("Test") - - # Return source - return source - - def get_sensitivity(self, obs, bkg_model, full_model): - """ - Determine sensitivity for a given observations. - - Parameters: - obs - Observation container - bkg_model - Background model - full_model - Source model - """ - # Determine energy boundaries from first observation in - # the container - for run in obs: - emin = run.events().ebounds().emin() - emax = run.events().ebounds().emax() - loge = math.log10(math.sqrt(emin.TeV()*emax.TeV())) - break - - # Write header - if self.logTerse(): - self.log("\n") - self.log.header2("Energies: "+str(emin)+" - "+str(emax)) - - # Initialise loop - flux_value = [] - pflux_value = [] - eflux_value = [] - iter = 0 - test_flux = 0.01 # This is the initial test flux in Crab units - - # Loop until we break - while True: - - # Update iteration counter - iter += 1 - - # Write header - if self.logExplicit(): - self.log.header2("Iteation "+str(iter)) - - # Set test flux - full_model[1]['Prefactor'].value(test_flux) - obs.models(full_model) - - # Simulate events - sim = obsutils.sim(obs, nbins=self.m_nbins, seed=iter, \ - log=self.m_log, debug=self.m_debug) - - # Determine number of events in simulation - nevents = 0.0 - for run in sim: - nevents += run.events().number() - - # Write simulation results - if self.logExplicit(): - self.log.header3("Simulation") - self.log.parformat("Number of simulated events") - self.log(nevents) - self.log("\n") - - # Fit background only - sim.models(bkg_model) - like = obsutils.fit(sim, log=self.m_log, debug=self.m_debug) - result_bgm = like.obs().models().copy() - LogL_bgm = like.opt().value() - npred_bgm = like.obs().npred() - - # Store results - Pre_bgm = result_bgm[0]['Prefactor'].value() - ePre_bgm = result_bgm[0]['Prefactor'].error() - Inx_bgm = result_bgm[0]['Index'].value() - eInx_bgm = result_bgm[0]['Index'].error() - Sig_bgm = result_bgm[0]['Sigma'].value() - eSig_bgm = result_bgm[0]['Sigma'].error() - - # Write background fit results - if self.logExplicit(): - self.log.header3("Background model fit") - self.log.parformat("log likelihood") - self.log(LogL_bgm) - self.log("\n") - self.log.parformat("Number of predicted events") - self.log(npred_bgm) - self.log("\n") - for model in result_bgm: - self.log.parformat("Model") - self.log(model.name()) - self.log("\n") - for par in model: - self.log(str(par)+"\n") - - # Fit background and test source - sim.models(full_model) - like = obsutils.fit(sim, log=self.m_log, debug=self.m_debug) - result_all = like.obs().models().copy() - LogL_all = like.opt().value() - npred_all = like.obs().npred() - ts = 2.0*(LogL_bgm-LogL_all) - - # Get fitted Crab, photon and energy fluxes - cflux = result_all[0]['Prefactor'].value() - pflux = cast_GModelSky(result_all["Test"]).spectral().flux(emin, emax) - eflux = cast_GModelSky(result_all["Test"]).spectral().eflux(emin, emax) - - # Store results - Pre_all = result_all[0]['Prefactor'].value() - ePre_all = result_all[0]['Prefactor'].error() - Inx_all = result_all[0]['Index'].value() - eInx_all = result_all[0]['Index'].error() - Sig_all = result_all[0]['Sigma'].value() - eSig_all = result_all[0]['Sigma'].error() - SPre_all = result_all[1]['Prefactor'].value() - eSPre_all = result_all[1]['Prefactor'].error() - SInx_all = result_all[1]['Index'].value() - eSInx_all = result_all[1]['Index'].error() - - # Write background and test source fit results - if self.logExplicit(): - self.log.header3("Background and test source model fit") - self.log.parformat("Test statistics") - self.log(ts) - self.log("\n") - self.log.parformat("log likelihood") - self.log(LogL_all) - self.log("\n") - self.log.parformat("Number of predicted events") - self.log(npred_all) - self.log("\n") - self.log.parformat("Photon flux") - self.log(pflux) - self.log(" ph/cm2/s\n") - self.log.parformat("Energy flux") - self.log(eflux) - self.log(" erg/cm2/s\n") - self.log.parformat("Crab flux") - self.log(cflux*1000.0) - self.log(" mCrab\n") - for model in result_all: - self.log.parformat("Model") - self.log(model.name()) - self.log("\n") - for par in model: - self.log(str(par)+"\n") - elif self.logTerse(): - self.log.parformat("Iteration "+str(iter)) - self.log("TS=") - self.log(ts) - self.log(" ") - self.log(pflux) - self.log(" ph/cm2/s = ") - self.log(eflux) - self.log(" erg/cm2/s = ") - self.log(cflux*1000.0) - self.log(" mCrab\n") - - # Compute extrapolated fitted prefactor, photon and energy fluxes - correct = 0.0 - if self.m_use_ts: - if ts > 0: - correct = math.sqrt(self.m_ts_thres/ts) - else: - if SPre_all > 0 and eSPre_all > 0: - correct = math.sqrt(self.m_ts_thres)/(SPre_all/eSPre_all) - flux = correct * SPre_all - pflux = correct * pflux - eflux = correct * eflux - flux_value.append(flux) - pflux_value.append(pflux) - eflux_value.append(eflux) - - # Compute sliding average of extrapolated fitted prefactor, - # photon and energy flux. This damps out fluctuations and - # improves convergence - flux = 0.0 - pflux = 0.0 - eflux = 0.0 - num = 0.0 - for k in range(self.m_num_avg): - inx = iter - k - 1 - if inx >= 0: - flux += flux_value[inx] - pflux += pflux_value[inx] - eflux += eflux_value[inx] - num += 1.0 - flux /= num - pflux /= num - eflux /= num - - # Compare average flux to last average - if iter > self.m_num_avg: - if test_flux > 0: - ratio = flux/test_flux - if ratio >= 0.99 and ratio <= 1.01: - if self.logTerse(): - self.log(" Converged ("+str(ratio)+")\n") - break - else: - if self.logTerse(): - self.log(" Flux is zero.\n") - break - - # Use average for next iteration - test_flux = flux - - # Exit loop if number of trials exhausted - if (iter >= self.m_max_iter): - if self.logTerse(): - self.log(" Test ended after "+str(self.m_max_iter)+" iterations.\n") - break - - # Write fit results - if self.logTerse(): - self.log.header3("Fit results") - self.log.parformat("Test statistics") - self.log(ts) - self.log("\n") - self.log.parformat("Photon flux") - self.log(pflux) - self.log(" ph/cm2/s\n") - self.log.parformat("Energy flux") - self.log(eflux) - self.log(" erg/cm2/s\n") - self.log.parformat("Crab flux") - self.log(cflux*1000.0) - self.log(" mCrab\n") - self.log.parformat("Number of simulated events") - self.log(nevents) - self.log("\n") - self.log.header3("Background and test source model fitting") - self.log.parformat("log likelihood") - self.log(LogL_all) - self.log("\n") - self.log.parformat("Number of predicted events") - self.log(npred_all) - self.log("\n") - for model in result_all: - self.log.parformat("Model") - self.log(model.name()) - self.log("\n") - for par in model: - self.log(str(par)+"\n") - self.log.header3("Background model fit") - self.log.parformat("log likelihood") - self.log(LogL_bgm) - self.log("\n") - self.log.parformat("Number of predicted events") - self.log(npred_bgm) - self.log("\n") - for model in result_bgm: - self.log.parformat("Model") - self.log(model.name()) - self.log("\n") - for par in model: - self.log(str(par)+"\n") - - # Store result - result = {'loge': loge, 'emin': emin.TeV(), 'emax': emax.TeV(), \ - 'crab': flux, 'pflux': pflux, 'eflux': eflux} - - # Return result - return result - - -# ======================== # -# Main routine entry point # -# ======================== # -if __name__ == '__main__': - """ - CTA ctlike-based sensitivity estimator. - """ - # Create instance of application - app = cssens(sys.argv) - - # Run application - app.execute() - \ No newline at end of file diff --git a/scripts/cssens.py b/scripts/cssens.py new file mode 100755 index 0000000..8713bd5 --- /dev/null +++ b/scripts/cssens.py @@ -0,0 +1,654 @@ +#! /usr/bin/env python +# ========================================================================== +# This script computes the CTA sensitivity for a number of energy bins using +# ctlike. Crab spectra are fitted in narrow energy bins to simulated data, +# and the flux level is determined that leads to a particular significance. +# The significance can be either determined using the Test Statistic (which +# is defined as twice the likelihood difference between fitting with and +# without the test source) or using the source model scaling factor (or +# Prefactor) divided by its statistical error. The latter has been turned +# out to be more reliable, and is used as default parameter. +# +# Copyright (C) 2011 Jurgen Knodlseder +# +# 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 . +# +# ========================================================================== +from ctatools import * +from gammalib import * +import obsutils +import sys +import csv +import math + + +# ============ # +# cssens class # +# ============ # +class cssens(GApplication): + """ + This class implements the sensitivity computation script. It derives + from the GammaLib::GApplication class which provides support for parameter + files, command line arguments, and logging. In that way the Python + script behaves just as a regular ctool. + """ + def __init__(self): + """ + Void constructor. + """ + # Set name + self.name = "cssens" + self.version = "0.1.0" + + # Make sure that parfile exists + file = self.parfile() + + # Initialise application + GApplication.__init__(self, self.name, self.version) + + # Set logger properties + self.logFileOpen() + self.log_header() + self.log.date(True) + + # Return + return + + def __init__(self, argv): + """ + Command line constructor. + """ + # Set name + self.name = "cssens" + self.version = "0.1.0" + + # Make sure that parfile exists + file = self.parfile() + + # Initialise application + GApplication.__init__(self, self.name, self.version, argv) + + # Set logger properties + self.logFileOpen() + self.log_header() + self.log.date(True) + + # Return + return + + def __del__(self): + """ + Destructor. + """ + # Write separator into logger + if self.logTerse(): + self.log("\n") + + # Return + return + + def parfile(self): + """ + Check if parfile exists. If parfile does not exist then create a + default parfile. This kluge avoids shipping the cscript with a parfile. + """ + # Set parfile name + parfile = self.name+".par" + + try: + pars = GPars(parfile) + except: + # Signal if parfile was not found + print "Parfile "+parfile+" not found. Create default parfile." + + # Create default parfile + pars = GPars() + pars.append(GPar("outfile","f","h","sensitivity.dat","","","Output file name")) + pars.append(GPar("caldb","s","a","$GAMMALIB/share/caldb/cta","","","Calibration database")) + pars.append(GPar("irf","s","a","kb_E_50h_v3","","","Instrument response function")) + pars.append(GPar("duration","r","a","180000.0","","","Effective exposure time (s)")) + pars.append(GPar("rad","r","a","5.0","","","Radius of ROI (deg)")) + pars.append(GPar("enumbins","i","h","0","","","Number of energy bins (0=unbinned)")) + pars.append(GPar("npix","i","h","200","","","Number of pixels for binned")) + pars.append(GPar("binsz","r","h","0.05","","","Pixel size for binned (deg/pixel)")) + pars.append(GPar("sigma","r","h","5.0","","","Significance threshold")) + pars.append(GPar("ts_use","b","h","no","","","Use TS instead of Sigma?")) + pars.append(GPar("index","r","h","-2.48","","","Assumed spectral index")) + pars.append(GPar("max_iter","i","h","50","","","Maximum number of iterations")) + pars.append(GPar("num_avg","i","h","3","","","Number of iterations for sliding average")) + pars.append_standard() + pars.save(parfile) + + # Return + return + + def get_parameters(self): + """ + Get parameters from parfile. + """ + # Get parameters + self.m_outfile = self["outfile"].filename() + self.m_caldb = self["caldb"].string() + self.m_irf = self["irf"].string() + self.m_duration = self["duration"].real() + self.m_roi = self["rad"].real() + self.m_nbins = self["enumbins"].integer() + self.m_npix = self["npix"].integer() + self.m_binsz = self["binsz"].real() + self.m_ts_thres = self["sigma"].real()*self["sigma"].real() + self.m_use_ts = self["ts_use"].boolean() + self.m_index = self["index"].real() + self.m_max_iter = self["max_iter"].integer() + self.m_num_avg = self["num_avg"].integer() + + # Set some fixed parameters + self.m_log = False # Logging in client tools + self.m_debug = False # Debugging in client tools + + # Return + return + + def execute(self): + """ + Execute the script. + """ + # Run the script + self.run() + + # Return + return + + 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() + + # Write input parameters into logger + if self.logTerse(): + self.log_parameters() + self.log("\n") + + # Initialise script + colnames = ['loge', 'emin', 'emax', 'crab', 'pflux', 'eflux'] + results = [] + + # Initialise models. Note that we centre the point source at the Galactic + # center as our observation is also centred at the Galactic centre, so + # we're onaxis. + bkg_model = GModels() + full_model = GModels() + bkg_model.append(self.set_bkg_model()) + full_model.append(self.set_bkg_model()) + full_model.append(self.set_src_model(0.0, 0.0, index=self.m_index)) + + # Write models into logger + if self.logTerse(): + self.log("\n") + self.log.header1("Models") + self.log.header2("Background model") + self.log(str(bkg_model)) + self.log("\n\n") + self.log.header2("Full model") + self.log(str(full_model)) + self.log("\n") + + # Write heder + if self.logTerse(): + self.log("\n") + self.log.header1("Sensitivity determination") + + # Loop over energy bands. The number of energy band is still + # fixed ... + for ieng in range(21): + + # Set energies + loge = -1.7 + ieng * 0.2 + emean = pow(10.0, loge) + emin = pow(10.0, loge-0.1) + emax = pow(10.0, loge+0.1) + + # Setup observation(s) + obs = self.set_obs(emin=emin, emax=emax) + + # Determine sensitivity + result = self.get_sensitivity(obs, bkg_model, full_model) + + # Write results + if ieng == 0: + f = open(self.m_outfile, 'w') + writer = csv.DictWriter(f, colnames) + writer.writerow(dict((_,_) for _ in colnames)) + writer.writerow(result) + f.close() + else: + f = open(self.m_outfile, 'a') + writer = csv.DictWriter(f, colnames) + writer.writerow(result) + f.close() + + # Append results + results.append(result) + + # Return + return + + def set_obs(self, lpnt=0.0, bpnt=0.0, emin=0.1, emax=100.0): + """ + Returns an observation container with a single CTA observation. + + Keywords: + lpnt - Galactic longitude of pointing [deg] (default: 0.0) + bpnt - Galactic latitude of pointing [deg] (default: 0.0) + emin - Minimum energy [TeV] (default: 0.1) + emax - Maximum energy [TeV] (default: 100.0) + """ + # Allocate observation container + obs = GObservations() + + # Set single pointing + pntdir = GSkyDir() + pntdir.lb_deg(lpnt, bpnt) + + # Create CTA observation + run = obsutils.set(pntdir, caldb=self.m_caldb, irf=self.m_irf, \ + duration=self.m_duration, \ + emin=emin, emax=emax, rad=self.m_roi) + + # Append observation to container + obs.append(run) + + # Return observation container + return obs + + def set_bkg_model(self, fitidx=False): + """ + Setup standard CTA background model. We use a simple power law here, + scaled to Konrad's E configuration performance table. + + Keywords: + fitidx - Fit spectral index (default: False) + """ + # Define radial component + radial = GCTAModelRadialGauss(3.0) + + # Define spectral component + spectrum = GModelSpectralPlaw(61.8, -1.85) + spectrum["Prefactor"].scale(1.0e-6) + spectrum["PivotEnergy"].value(1.0) + spectrum["PivotEnergy"].scale(1.0e6) + if fitidx: + spectrum["Index"].free() + else: + spectrum["Index"].fix() + + # Create background model + model = GCTAModelRadialAcceptance(radial, spectrum) + model.name("Background") + model.instruments("CTA") + + # Return background model + return model + + def set_src_model(self, l, b, flux=1.0, index=-2.48, \ + type="point", sigma=1.0, radius=1.0, width=0.1, \ + fitpos=False, fitidx=False): + """ + Returns a single source with Crab-like spectrum. The source flux + can be scaled in Crab units. The Crab spectrum is based on MAGIC + observations (Albert et al. 2008, ApJ, 674, 1037). + + Parameters: + l - Galactic longitude of source location [deg] + b - Galactic latitude of source location [deg] + Keywords: + flux - Source flux [Crabs] + index - Spectral index + type - Source type ("point", "gauss", "disk", "shell") + sigma - Gaussian sigma (for type="gauss") + radius - Disk or shell inner radius [deg] (for type="disk" and type="shell") + width - Shell width [deg] (for type="shell") + fitpos - Fit position? (default: True) + fitidx - Fit index? (default: True) + """ + # Set source location + location = GSkyDir() + location.lb_deg(l, b) + + # Set source spectrum + spectrum = GModelSpectralPlaw(flux, index) + spectrum["Prefactor"].scale(5.7e-16) + spectrum["PivotEnergy"].value(0.3) + spectrum["PivotEnergy"].scale(1.0e6) + if fitidx: + spectrum["Index"].free() + else: + spectrum["Index"].fix() + + # Set source + if type == "point": + spatial = GModelSpatialPtsrc(location) + if fitpos: + spatial[0].free() + spatial[1].free() + source = GModelPointSource(spatial, spectrum) + elif type == "gauss": + radial = GModelRadialGauss(location, sigma) + if fitpos: + radial[0].free() + radial[1].free() + source = GModelExtendedSource(radial, spectrum) + elif type == "disk": + radial = GModelRadialDisk(location, radius) + if fitpos: + radial[0].free() + radial[1].free() + source = GModelExtendedSource(radial, spectrum) + elif type == "shell": + radial = GModelRadialShell(location, radius, width) + if fitpos: + radial[0].free() + radial[1].free() + source = GModelExtendedSource(radial, spectrum) + else: + self.log("ERROR: Unknown source type '"+type+"'.\n") + return None + + # Set source name + source.name("Test") + + # Return source + return source + + def get_sensitivity(self, obs, bkg_model, full_model): + """ + Determine sensitivity for a given observations. + + Parameters: + obs - Observation container + bkg_model - Background model + full_model - Source model + """ + # Determine energy boundaries from first observation in + # the container + for run in obs: + emin = run.events().ebounds().emin() + emax = run.events().ebounds().emax() + loge = math.log10(math.sqrt(emin.TeV()*emax.TeV())) + break + + # Write header + if self.logTerse(): + self.log("\n") + self.log.header2("Energies: "+str(emin)+" - "+str(emax)) + + # Initialise loop + flux_value = [] + pflux_value = [] + eflux_value = [] + iter = 0 + test_flux = 0.01 # This is the initial test flux in Crab units + + # Loop until we break + while True: + + # Update iteration counter + iter += 1 + + # Write header + if self.logExplicit(): + self.log.header2("Iteation "+str(iter)) + + # Set test flux + full_model[1]['Prefactor'].value(test_flux) + obs.models(full_model) + + # Simulate events + sim = obsutils.sim(obs, nbins=self.m_nbins, seed=iter, \ + binsz=self.m_binsz, npix=self.m_npix, \ + log=self.m_log, debug=self.m_debug) + + # Determine number of events in simulation + nevents = 0.0 + for run in sim: + nevents += run.events().number() + + # Write simulation results + if self.logExplicit(): + self.log.header3("Simulation") + self.log.parformat("Number of simulated events") + self.log(nevents) + self.log("\n") + + # Fit background only + sim.models(bkg_model) + like = obsutils.fit(sim, log=self.m_log, debug=self.m_debug) + result_bgm = like.obs().models().copy() + LogL_bgm = like.opt().value() + npred_bgm = like.obs().npred() + + # Store results + Pre_bgm = result_bgm[0]['Prefactor'].value() + ePre_bgm = result_bgm[0]['Prefactor'].error() + Inx_bgm = result_bgm[0]['Index'].value() + eInx_bgm = result_bgm[0]['Index'].error() + Sig_bgm = result_bgm[0]['Sigma'].value() + eSig_bgm = result_bgm[0]['Sigma'].error() + + # Write background fit results + if self.logExplicit(): + self.log.header3("Background model fit") + self.log.parformat("log likelihood") + self.log(LogL_bgm) + self.log("\n") + self.log.parformat("Number of predicted events") + self.log(npred_bgm) + self.log("\n") + for model in result_bgm: + self.log.parformat("Model") + self.log(model.name()) + self.log("\n") + for par in model: + self.log(str(par)+"\n") + + # Fit background and test source + sim.models(full_model) + like = obsutils.fit(sim, log=self.m_log, debug=self.m_debug) + result_all = like.obs().models().copy() + LogL_all = like.opt().value() + npred_all = like.obs().npred() + ts = 2.0*(LogL_bgm-LogL_all) + + # Get fitted Crab, photon and energy fluxes + cflux = result_all[0]['Prefactor'].value() + pflux = cast_GModelSky(result_all["Test"]).spectral().flux(emin, emax) + eflux = cast_GModelSky(result_all["Test"]).spectral().eflux(emin, emax) + + # Store results + Pre_all = result_all[0]['Prefactor'].value() + ePre_all = result_all[0]['Prefactor'].error() + Inx_all = result_all[0]['Index'].value() + eInx_all = result_all[0]['Index'].error() + Sig_all = result_all[0]['Sigma'].value() + eSig_all = result_all[0]['Sigma'].error() + SPre_all = result_all[1]['Prefactor'].value() + eSPre_all = result_all[1]['Prefactor'].error() + SInx_all = result_all[1]['Index'].value() + eSInx_all = result_all[1]['Index'].error() + + # Write background and test source fit results + if self.logExplicit(): + self.log.header3("Background and test source model fit") + self.log.parformat("Test statistics") + self.log(ts) + self.log("\n") + self.log.parformat("log likelihood") + self.log(LogL_all) + self.log("\n") + self.log.parformat("Number of predicted events") + self.log(npred_all) + self.log("\n") + self.log.parformat("Photon flux") + self.log(pflux) + self.log(" ph/cm2/s\n") + self.log.parformat("Energy flux") + self.log(eflux) + self.log(" erg/cm2/s\n") + self.log.parformat("Crab flux") + self.log(cflux*1000.0) + self.log(" mCrab\n") + for model in result_all: + self.log.parformat("Model") + self.log(model.name()) + self.log("\n") + for par in model: + self.log(str(par)+"\n") + elif self.logTerse(): + self.log.parformat("Iteration "+str(iter)) + self.log("TS=") + self.log(ts) + self.log(" ") + self.log(pflux) + self.log(" ph/cm2/s = ") + self.log(eflux) + self.log(" erg/cm2/s = ") + self.log(cflux*1000.0) + self.log(" mCrab\n") + + # Compute extrapolated fitted prefactor, photon and energy fluxes + correct = 0.0 + if self.m_use_ts: + if ts > 0: + correct = math.sqrt(self.m_ts_thres/ts) + else: + if SPre_all > 0 and eSPre_all > 0: + correct = math.sqrt(self.m_ts_thres)/(SPre_all/eSPre_all) + flux = correct * SPre_all + pflux = correct * pflux + eflux = correct * eflux + flux_value.append(flux) + pflux_value.append(pflux) + eflux_value.append(eflux) + + # Compute sliding average of extrapolated fitted prefactor, + # photon and energy flux. This damps out fluctuations and + # improves convergence + flux = 0.0 + pflux = 0.0 + eflux = 0.0 + num = 0.0 + for k in range(self.m_num_avg): + inx = iter - k - 1 + if inx >= 0: + flux += flux_value[inx] + pflux += pflux_value[inx] + eflux += eflux_value[inx] + num += 1.0 + flux /= num + pflux /= num + eflux /= num + + # Compare average flux to last average + if iter > self.m_num_avg: + if test_flux > 0: + ratio = flux/test_flux + if ratio >= 0.99 and ratio <= 1.01: + if self.logTerse(): + self.log(" Converged ("+str(ratio)+")\n") + break + else: + if self.logTerse(): + self.log(" Flux is zero.\n") + break + + # Use average for next iteration + test_flux = flux + + # Exit loop if number of trials exhausted + if (iter >= self.m_max_iter): + if self.logTerse(): + self.log(" Test ended after "+str(self.m_max_iter)+" iterations.\n") + break + + # Write fit results + if self.logTerse(): + self.log.header3("Fit results") + self.log.parformat("Test statistics") + self.log(ts) + self.log("\n") + self.log.parformat("Photon flux") + self.log(pflux) + self.log(" ph/cm2/s\n") + self.log.parformat("Energy flux") + self.log(eflux) + self.log(" erg/cm2/s\n") + self.log.parformat("Crab flux") + self.log(cflux*1000.0) + self.log(" mCrab\n") + self.log.parformat("Number of simulated events") + self.log(nevents) + self.log("\n") + self.log.header3("Background and test source model fitting") + self.log.parformat("log likelihood") + self.log(LogL_all) + self.log("\n") + self.log.parformat("Number of predicted events") + self.log(npred_all) + self.log("\n") + for model in result_all: + self.log.parformat("Model") + self.log(model.name()) + self.log("\n") + for par in model: + self.log(str(par)+"\n") + self.log.header3("Background model fit") + self.log.parformat("log likelihood") + self.log(LogL_bgm) + self.log("\n") + self.log.parformat("Number of predicted events") + self.log(npred_bgm) + self.log("\n") + for model in result_bgm: + self.log.parformat("Model") + self.log(model.name()) + self.log("\n") + for par in model: + self.log(str(par)+"\n") + + # Store result + result = {'loge': loge, 'emin': emin.TeV(), 'emax': emax.TeV(), \ + 'crab': flux, 'pflux': pflux, 'eflux': eflux} + + # Return result + return result + + +# ======================== # +# Main routine entry point # +# ======================== # +if __name__ == '__main__': + """ + CTA ctlike-based sensitivity estimator. + """ + # Create instance of application + app = cssens(sys.argv) + + # Run application + app.execute() + \ No newline at end of file -- libgit2 0.21.4