implement plotting

knodlseder
1 parent a30f58c8
Showing 1 changed file with 274 additions and 71 deletions
test/example_binned.py
 #! /usr/bin/env python
 # ===========================================================================================#
-# This script illustrates how to build a binned analysis chain using CTAtools.
+# This script illustrates how to build a binned analysis pipeline using CTAtools.
 #
-# If matplotlib is installed, the spectrum will be displayed on the screen. 
+# If matplotlib is installed, a counts spectrum and an offset histogram will be displayed. 
 # ===========================================================================================#
 from ctatools import *
+from gammalib import *
 from math import *
+import os
+import glob
  
  
-# =================== #
-# Processing pipeline #
-# =================== #
-def process():
+# ============================= #
+# Analysis pipeline - version 1 #
+# ============================= #
+def pipeline_v1():
 	"""
-	Binned analysis processing pipeline.
+	Binned analysis pipeline - save intermediate results.
+    
+    This function implements an analysis pipeline that successively calls
+    ctobssim, ctbin and ctlike by saving the intermediate results as FITS
+    files on disk. This replicates the way how the analysis would be done
+    in a ftools-like approach.
 	"""
 	# Set script parameters
 	model_name  = "data/crab.xml"
@@ -42,6 +50,7 @@ def process():
  
 	# Simulate events
 	sim = ctobssim()
+	sim.logFileOpen()  # We need this to explicitely open the log file in Python mode
 	sim["infile"].filename(model_name)
 	sim["outfile"].filename(events_name)
 	sim["caldb"].string(caldb)
@@ -53,7 +62,7 @@ def process():
 	sim["tmax"].real(tstop)
 	sim["emin"].real(emin)
 	sim["emax"].real(emax)
-	sim.run()
+	sim.execute()
 	print "Simulated events ("+str(sim.celapse())+" CPU seconds)"
  
 	# Update timing
@@ -62,6 +71,7 @@ def process():
  
 	# Bin events into counts map
 	bin = ctbin()
+	bin.logFileOpen()  # We need this to explicitely open the log file in Python mode
 	bin["evfile"].filename(events_name)
 	bin["outfile"].filename(cntmap_name)
 	bin["emin"].real(emin)
@@ -74,7 +84,7 @@ def process():
 	bin["xref"].real(ra)
 	bin["yref"].real(dec)
 	bin["proj"].string(proj)
-	bin.run()
+	bin.execute()
 	print "Binned events into counts map ("+str(bin.celapse())+" CPU seconds)"
  
 	# Update timing
@@ -83,6 +93,7 @@ def process():
  
 	# Perform maximum likelihood fitting
 	like = ctlike()
+	like.logFileOpen()  # We need this to explicitely open the log file in Python mode
 	like["cntmap"].filename(cntmap_name)
 	like["srcmdl"].filename(model_name)
 	like["outmdl"].filename(result_name)
@@ -90,7 +101,7 @@ def process():
 	like["stat"].string("POISSON")
 	like["caldb"].string(caldb)
 	like["irf"].string(irf)
-	like.run()
+	like.execute()
 	print "Maximum likelihood fitting ("+str(like.celapse())+" CPU seconds)"
  
 	# Update timing
@@ -105,74 +116,242 @@ def process():
 	return
  
  
-# ============ #
-# Show photons #
-# ============ #
-def show_photons(photons, xmlname, e_min, e_max, area, duration, ebins=30):
+# ============================= #
+# Analysis pipeline - version 2 #
+# ============================= #
+def pipeline_v2():
 	"""
-	Show photons using matplotlib (if available).
+	Binned analysis pipeline - keep intermediate results in memory.
+    
+    This function implements an analysis pipeline that successively calls
+    ctobssim, ctbin and ctlike without saving the intermediate results as
+	FITS files on disk. All data are hold in memory.
+	
+	At the end, results are plotted (if matplotlib is installed)
+	"""
+	# Set script parameters
+	model_name  = "data/crab.xml"
+	caldb       = "irf"
+	irf         = "kb_E_50h_v3"
+	ra          =   83.63
+	dec         =   22.01
+	rad_sim     =   10.0
+	tstart      =    0.0
+	tstop       = 1800.0
+	emin        =    0.1
+	emax        =  100.0
+	enumbins    =   20
+	nxpix       =  200
+	nypix       =  200
+	binsz       =    0.02
+	coordsys    = "CEL"
+	proj        = "CAR"
+
+	# Initialise timing
+	wall_seconds = 0.0
+	cpu_seconds  = 0.0
+
+	# Simulate events
+	sim = ctobssim()
+	sim["infile"].filename(model_name)
+	sim["caldb"].string(caldb)
+	sim["irf"].string(irf)
+	sim["ra"].real(ra)
+	sim["dec"].real(dec)
+	sim["rad"].real(rad_sim)
+	sim["tmin"].real(tstart)
+	sim["tmax"].real(tstop)
+	sim["emin"].real(emin)
+	sim["emax"].real(emax)
+	sim.run()
+	print "Simulated events ("+str(sim.celapse())+" CPU seconds)"
+
+	# Update timing
+	wall_seconds += sim.telapse()
+	cpu_seconds  += sim.celapse()
+
+	# Bin events into counts map
+	bin = ctbin(sim.obs())
+	bin["emin"].real(emin)
+	bin["emax"].real(emax)
+	bin["enumbins"].integer(enumbins)
+	bin["nxpix"].integer(nxpix)
+	bin["nypix"].integer(nypix)
+	bin["binsz"].real(binsz)
+	bin["coordsys"].string(coordsys)
+	bin["xref"].real(ra)
+	bin["yref"].real(dec)
+	bin["proj"].string(proj)
+	bin.run()
+	print "Binned events into counts map ("+str(bin.celapse())+" CPU seconds)"
+
+	# Update timing
+	wall_seconds += bin.telapse()
+	cpu_seconds  += bin.celapse()
+
+	# Perform maximum likelihood fitting
+	like = ctlike(bin.obs())
+	like.run()
+	print "Maximum likelihood fitting ("+str(like.celapse())+" CPU seconds)"
+
+	# Update timing
+	wall_seconds += like.telapse()
+	cpu_seconds  += like.celapse()
+		
+	# Show total times
+	print "Total wall time elapsed: "+str(wall_seconds)+" seconds"
+	print "Total CPU time used ...: "+str(cpu_seconds)+" seconds"
+
+	# Show model fitting results
+	#print like.obs().models()
+
+	# Plot counts
+	plot_counts(bin.obs())
+	
+	# Return
+	return
+
+
+# =========== #
+# Plot counts #
+# =========== #
+def plot_counts(observations):
+	"""
+	Plot counts.
 	"""
 	# Only proceed if matplotlib is available
 	try:
 		# Import matplotlib
 		import matplotlib.pyplot as plt
  
-		# Create figure
-		plt.figure(1)
-		plt.title("MC simulated photon spectrum ("+str(e_min)+'-'+str(e_max)+" TeV)")
+		# Set legend fontsize
+		params = {'legend.fontsize': 10}
+		plt.rcParams.update(params)
+
+		# Set plot styles
+		styles = ['b-', 'g-', 'y-', 'n-']
+
+		# Dump header
+		print ""
+		print "Make plots (using matplotlib):"
+		print "=============================="
  
-		# Setup energy range covered by data
-		emin = GEnergy()
-		emax = GEnergy()
-		emin.TeV(e_min)
-		emax.TeV(e_max)
-		ebds = GEbounds()
-		ebds.setlog(emin, emax, ebins)
+		# Create figure 1
+		plt.figure(1,figsize=(12,6))
+		plt.subplots_adjust(hspace=.7)
+
+		# Create subplot 1
+		plt.subplot(121)
+		plt.title("Spectrum (summed over all pixels)")
+		
+		# Loop over observations
+		for obs in observations:
  
-		# Create energy axis
-		energy = []
-		for i in range(ebds.size()):
-			energy.append(ebds.elogmean(i).TeV())
-
-		# Fill histogram
-		counts = [0.0 for i in range(ebds.size())]
-		for photon in photons:
-			index         = ebds.index(photon.energy())
-			counts[index] = counts[index] + 1.0
-
-		# Create error bars
-		error = [sqrt(c) for c in counts]
-
-		# Get model values
-		models = GModels(xmlname)
-		crab   = cast_GModelSky(models[0])
-		model = []
-		d = GSkyDir()
-		d.radec_deg(83.6331, 22.0145)
-		t = GTime()
-		for i in range(ebds.size()):
-			eval   = ebds.elogmean(i)
-			ewidth = ebds.emax(i) - ebds.emin(i)
-			f      = crab.value(d, eval, t) * area * duration * ewidth.MeV()
-			model.append(f)
-
-		# Plot data
-		plt.loglog(energy, counts, 'ro')
-		plt.errorbar(energy, counts, error, fmt=None, ecolor='r')
-
-		# Plot model
-		plt.plot(energy, model, 'b-')
-
-		# Set axes
+			# Get event cube
+			cube = cast_GCTAEventCube(obs.events())
+			
+			# Create energy axis
+			energy  = []
+			ebounds = cube.ebounds()
+			for i in range(ebounds.size()):
+				energy.append(ebounds.elogmean(i).TeV())
+
+			# Create spectrum
+			print "Extract data:"
+			counts = [0.0 for i in range(ebounds.size())]
+			for bin in cube:
+				index         = ebounds.index(bin.energy())
+				counts[index] = counts[index] + bin.counts()
+
+			# Create error bars
+			error = [sqrt(c) for c in counts]
+
+			# Plot spectrum
+			plt.loglog(energy, counts, 'ro', label='data')
+			plt.errorbar(energy, counts, error, fmt=None, ecolor='r')
+
+			# Extract models
+			print "Extract models:"
+			sum_model = [0.0 for i in range(ebounds.size())]
+			for k, m in enumerate(observations.models()):
+				print "- "+m.name()
+				model = [0.0 for i in range(ebounds.size())]
+				for bin in cube:
+					index        = ebounds.index(bin.energy())
+					prob         = m.eval(bin, obs)
+					model[index] = model[index] + prob * bin.size()
+				for i in range(ebounds.size()):
+					sum_model[i] = sum_model[i] + model[i]
+				plt.loglog(energy, model, styles[k], label=m.name())
+			plt.loglog(energy, sum_model, 'r-', label='total')
+
+		# Put labels
 		plt.xlabel("Energy (TeV)")
-		plt.ylabel("Number of incident photons")
+		plt.ylabel("Counts")
+		plt.legend(loc="lower left")
+
+		# Create subplot 2
+		plt.subplot(122)
+		plt.title("Offset (summed over all energies)")
+
+		# Set Crab direction
+		crab = GSkyDir()
+		crab.radec_deg(83.63, 22.01)
+		
+		# Loop over observations
+		for obs in observations:
+		
+			# Get event cube
+			cube = cast_GCTAEventCube(obs.events())
+			
+			# Create offset histogram
+			print "Extract data:"
+			nx       = 30
+			doffset2 = 0.01
+			offset2  = [(i+0.5)*doffset2 for i in range(nx)]
+			counts   = [0.0  for i in range(nx)]
+			for bin in cube:
+				off   = bin.dir().dist_deg(crab)
+				off2  = off*off
+				index = int(off2/doffset2)
+				if index < nx:
+					counts[index] = counts[index] + bin.counts()
+
+			# Create error bars
+			error = [sqrt(c) for c in counts]
  
-		# Allocate histogram
-		# Show plot
+			# Plot distribution
+			plt.semilogy(offset2, counts, 'ro', label='data')
+
+			# Extract models
+			print "Extract models:"
+			sum_model = [0.0 for i in range(nx)]
+			for k, m in enumerate(observations.models()):
+				print "- "+m.name()
+				model = [0.0 for i in range(nx)]
+				for bin in cube:
+					off   = bin.dir().dist_deg(crab)
+					off2  = off*off
+					index = int(off2/doffset2)
+					if index < nx:
+						prob         = m.eval(bin, obs)
+						model[index] = model[index] + prob * bin.size()
+				for i in range(nx):
+					sum_model[i] = sum_model[i] + model[i]
+				plt.plot(offset2, model, styles[k], label=m.name())
+			plt.plot(offset2, sum_model, 'r-', label='total')
+			plt.ylim(ymin=0.1)
+
+		# Put labels
+		plt.xlabel("Offset (deg^2)")
+		plt.ylabel("Counts")
+		plt.legend(loc="upper right")
+
+		# Show counts spectra
 		plt.show()
  
 	except:
-		print "Matplotlib is not (correctly) installed on your system. No data are shown."
+		print "Matplotlib is not (correctly) installed on your system. No counts spectra are shown."
  
 	# Return
 	return
@@ -190,14 +369,38 @@ if __name__ == &#39;__main__&#39;:
 	- Event simulation
 	- Event binning
 	- Binned maximum likelihood fitting
+	
+	Two variations of the script are implemented. One that calls the classes
+	like executables, storing the intermediate results on disk, and a second
+	that uses the results of the precedent class directly without storing
+	any data on disk.
+	
+	The second variation will also show a counts spectrum of the data after
+	fitting (only if matplotlib is available on your system). Note that the
+	counts spectrum is summed over the entire data space, i.e. no event selection
+	around the Crab has been performed.
 	"""
 	# Dump header
-	print "*****************************"
-	print "* CTA binned analysis script *"
-	print "*****************************"
+	print "*************************************"
+	print "*    CTA binned analysis scripts    *"
+	print "*************************************"
+	print "... this script will take 1-2 minutes"
  
-	# Process data
-	process()
+	# Remove any existing result files
+	list = [glob.glob("*.fits"), glob.glob("*.log"), glob.glob("*.xml")]
+	for files in list:
+		for file in files:
+			os.remove(file)
  
-	# Show photons
-	#show_photons(photons, xmlname, e_min, e_max, area, duration)
+	# Save intermediate results on disk
+	print ""
+	print "Executable analysis pipeline:"
+	print "============================="
+	pipeline_v1()
+
+	# Do analysis in memory
+	print ""
+	print "In memory analysis pipeline:"
+	print "============================"
+	pipeline_v2()
+	print ""