Add documentation for csviscube and update change log and News

Jürgen Knödlseder
1 parent db97908e
Showing 4 changed files with 99 additions and 3 deletions
ChangeLog
NEWS
doc/source/users/reference_manual/csviscube.rst
doc/source/users/reference_manual/index.rst
-2016-10-04
+2016-10-05
  
         * Version 1.2.0 released
         ========================
  
+        Add csviscube script (#1853)
         Add zenith and azimuth angle information to IRF caldb (#1853)
         Fix ctbin segfault bug for varying energy thresholds (#1850)
         Make csresmap enumbins parameter hidden (#1844)
 New Features and Important Changes in ctools 1.2.0
  
-4 October 2016
+5 October 2016
  
  
 Introduction
@@ -193,7 +193,12 @@ removed the obsolete functions fit(), cterror(), cntmap() and modmap() from the
 "obsutils" module (#1830).
  
 The csroot2caldb script now takes the zenith and azimuth angles as parameters
-and writes them into the calibration database.
+and writes them into the calibration database (#1835).
+
+Added a csviscube script that computes the visibility cube providing the number
+of hours that a given position on the sky is observable under a given zenith
+angle by an IACT array during a given time period. The tool implements so far
+a Sun constraint, but no Moon constraint (#1835).
  
  
 Examples
+.. _csviscube:
+
+csviscube
+=========
+
+Computes visibility cube for a given IACT array and time period.
+
+
+Synopsis
+--------
+
+This script computes a visibility cube which is a sky cube spanned by Right
+Ascension, Declination and zenith angle that provides the number of hours
+that a given position on the sky is observable under a given zenith angle
+by an IACT array during a given time period.
+
+For the moment, the script takes into account a Sun constraint, specified as
+a minimum zenith angle of the Sun for observations (hidden parameter ``sunzenith``).
+No Moon constraint has been implemented so far.
+
+On output, the script will provide a FITS file containing the visibility cube.
+
+
+General parameters
+------------------
+
+``tmin [real]``
+    Start time of the observation.
+
+``tmax [real]``
+    Stop time of the observation.
+
+``geolon [real]``
+    Geographic longitude of the IACT array in degrees.
+
+``geolat [real]``
+    Geographic latitude of the IACT array in degrees.
+
+``(sunzenith = 105.0) [real]``
+    Minimum Sun zenith angle for observations in degrees.
+
+``(moonzenith = 90.0) [real]``
+    Minimum Moon zenith angle for observations in degrees.
+
+``outfile [file]``
+    Output visibility cube file.
+
+``(binsz = 1.0) [real]``
+    Visibility cube pixel size in degrees/pixel.
+
+``(dz = 1.0) [real]``
+    Visibility cube zenith angle bin size in degrees.
+
+``(zmax = 60.0) [real]``
+    Maximum zenith angle of the visibility cube in degrees.
+
+
+Standard parameters
+-------------------
+
+``(chatter = 2) [integer]``
+    Verbosity of the executable:
+     chatter = 0: no information will be logged
+     
+     chatter = 1: only errors will be logged
+     
+     chatter = 2: errors and actions will be logged
+     
+     chatter = 3: report about the task execution
+     
+     chatter = 4: detailed report about the task execution
+ 	 	 
+``(clobber = yes) [boolean]``
+    Specifies whether an existing visibility cube file should be overwritten.
+ 	 	 
+``(debug = no) [boolean]``
+    Enables debug mode. In debug mode the executable will dump any log file output to the console.
+ 	 	 
+``(mode = ql) [string]``
+    Mode of automatic parameters (default is "ql", i.e. "query and learn").
+
+``(logfile = csviscube.log) [filename]``
+    Log filename.
+
+
+Related tools or scripts
+------------------------
+
+None
@@ -40,6 +40,7 @@ cscripts
    :maxdepth: 1
  
    cscaldb --- Lists available instrument response functions <cscaldb>
+   csviscube --- Computes visibility cube <csviscube>
    cslightcrv --- Computes lightcurve <cslightcrv>
    csmodelinfo --- Shows model container content <csmodelinfo>
    csmodelmerge --- Merges several model containers into one file <csmodelmerge>