NEWS

New Features and Important Changes in ctools 2.1.0

12 May 2023


Introduction
------------
This document briefly summarizes the changes that have been made in this
ctools release with respect to the precedent release.


Configuration
-------------
None


Documentation
-------------
None


Python interface
----------------
The distutils module was replace by the sysconfig and setuptools modules
in setup.py, with a fallback to distutils in case that either the
sysconfig or setuptools modules are not available. Furthermore, the
production of an egg file with the setuptools was prevented (#4223).


Support model
-------------
None


Base classes
------------
None


ctbin - CTA event binning
-------------------------
None


ctbkgcube - CTA background cube generation
------------------------------------------
None


ctbutterfly - Generate butterfly diagrams
-----------------------------------------
Avoid not a number (NaN) errors in butterfly computation (#4069).


ctcubemask - CTA cube filtering
-------------------------------
None


ctedispcube - CTA energy dispersion cube generation
---------------------------------------------------
None


cterror - Likelihood profile error computation
----------------------------------------------
None


ctexpcube - CTA exposure cube generation
----------------------------------------
None


ctfindvar - Variability search
------------------------------
None


ctlike - Maximum likelihood fitting
-----------------------------------
None


ctmapcube - CTA map cube generation
-----------------------------------
None


ctmodel - CTA counts cube modelling
-----------------------------------
None


ctobssim - CTA observation simulation
-------------------------------------
None


ctphase - Event phase computation
---------------------------------
None


ctprob - Event probability computation
--------------------------------------
None


ctpsfcube - CTA point spread function cube generation
-----------------------------------------------------
None


ctselect - CTA event selection
------------------------------
None


ctskymap - CTA sky mapping
--------------------------
None


cttsmap - Generation of Test Statistic map
------------------------------------------
Optionally write fitted null hypothesis model into log file.


ctulimit - Compute upper limit
------------------------------
None


support - Support classes
-------------------------
None


csadd2caldb - Adds CTA response function to calibration database
----------------------------------------------------------------
None


csbkgmodel - Generate background model for 3D analysis
------------------------------------------------------
None


cscaldb - Inspect calibration database
--------------------------------------
None


csebins - Generate energy boundaries
------------------------------------
None


csfindobs - Find IACT observations
----------------------------------
None


csfootprint - Generates carbon footprint report
-----------------------------------------------
Display now dates instead of days since start for daily statistic (#4299).


csiactcopy - Copy IACT observations
-----------------------------------
None


csiactdata - Inspect IACT data store
------------------------------------
None


csiactobs - Inspect IACT observation definition XML file
--------------------------------------------------------
None


cslightcrv - Generate light curve
---------------------------------
None


csmodelinfo - Return model information
--------------------------------------
None


csmodelmerge - Merge models
---------------------------
None


csmodelselect - Select models
-----------------------------
None


csmodelsois - Puts selected sources in diffuse model cube
---------------------------------------------------------
None


csobs2caldb - Generate calibration database entry for an IACT observation
-------------------------------------------------------------------------
None


csobsdef - Generate observation definition XML file
---------------------------------------------------
None


csobsinfo - Return observation definition information
-----------------------------------------------------
None


csobsselect - Select observations
---------------------------------
None


csphagen - Generate On/Off observations
---------------------------------------
None


csphasecrv - Generate phase curve
---------------------------------
None


cspull - Generate pull distributions
------------------------------------
None


csresmap - Generate residual map
--------------------------------
None


csresspec - Generate residual spectrum
--------------------------------------
None


csroot2caldb - Generates calibration database from ROOT file
------------------------------------------------------------
None


csscs - Spectral component separation
-------------------------------------
None


cssens - Computes sensitivity curve
-----------------------------------
None


csspec - Generates Spectral Energy Distribution
-----------------------------------------------
None


cssrcdetect - Detects sources in sky map
----------------------------------------
None


cstsdist - Computes Test Statistic distribution
-----------------------------------------------
None


cstsmapmerge - Merge Test Statistic maps
----------------------------------------
None


cstsmapsplit - Prepare split Test Statistic computation
-------------------------------------------------------
None


csviscube - Generate visibility cube
------------------------------------
None


csworkflow - Execute workflow
-----------------------------
None


calutils - Calibration utilities
--------------------------------
None


ioutils - Input/Output utilities
--------------------------------
None


modutils - Model utilities
--------------------------
None


mputils - Multiprocessing utilities
-----------------------------------
None


obsutils - Observation utilities
--------------------------------
None


comgendb - Generate COMPTEL database
------------------------------------
Add collection of HKD datasets to script and assure that each HKD datasets
is covered by an OAD dataset. OAD datasets for which no HKD dataset exists
will be removed in the XML file (#4209).


comlixfit - COMPTEL maximum likelihood fitting using SRCLIX algorithm
---------------------------------------------------------------------
None


comlixmap - Generation of COMPTEL Test Statistic map using SRCLIX algorithm
---------------------------------------------------------------------------
The script prefits now the models without test source before entering the TS
map computation. This may lead to a speed-up as fewer SRCLIX iterations will
be needed for each test source position (#4201).

Added an "inmap" parameter to allow restart the computations from an existing
TS map without recomputation of values that exist. The script now also writes
parameter uncertainties in the resulting TS map FITS file (#4187).


comobsadd - Combine COMPTEL observations
----------------------------------------
Added DRW Phibar normalisation step by taking into account the sky model
components of the input model definition file (#4263).

Added DRW to the cubes that will be combined by the script. The combination
will be done using a simple addition, alike the combination of the DRB cubes
(#4209).


comobsback - Generate background model for COMPTEL observations
---------------------------------------------------------------
Added BGDLIXF background generation method that makes use of the DRW instead
a DRG for background modelling. Set "outfolder" parameter to automatic (#4209).


comobsbin - Bin COMPTEL observations
------------------------------------
Add CONST method for DRW computation that generates solid angle multiplied and
DRE normalised DRW datasets from the DRG data (#4254)

Implement computation of weighting cubes (DRW) for improved background modelling.
Added "timebin" parameter to provide control over the time binning used for
DRW computation (#4209).


comobsconv - Convolve models with COMPTEL response
--------------------------------------------------
New script that convolves celestial model with the COMPTEL response (#4159).


comobsmodel - Generate model for binned COMPTEL observations
------------------------------------------------------------
None


comobsres - Generate residuals of COMPTEL observations
------------------------------------------------------
None


comobsselect - Select observations from COMPTEL database
--------------------------------------------------------
None


comobssim - Simulate COMPTEL observations
-----------------------------------------
None


compulbin - Generate pulsar pulse profile
-----------------------------------------
None


comsrcdetect - Detect source in Test Statistic map
--------------------------------------------------
None


Examples
--------
None


caldb
-----
None


models
------
None