From cff2eacba9bb52313e880f53a364559b3ce405a8 Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Mon, 12 Dec 2016 13:00:20 +0100 Subject: [PATCH] Rename ds9file into outds9file --- ChangeLog | 3 ++- NEWS | 4 +++- cscripts/csmodelinfo.par | 5 ++--- cscripts/csmodelinfo.py | 4 ++-- cscripts/csobsinfo.par | 5 ++--- cscripts/csobsinfo.py | 6 +++--- doc/source/users/reference_manual/csmodelinfo.rst | 6 +++--- doc/source/users/reference_manual/csobsinfo.rst | 8 ++++---- test/test_csmodelinfo.py | 20 ++++++++++---------- test/test_csobsinfo.py | 32 ++++++++++++++++---------------- 10 files changed, 47 insertions(+), 46 deletions(-) diff --git a/ChangeLog b/ChangeLog index dc8250b..fd1b10b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,8 +1,9 @@ -2016-12-01 +2016-12-12 * Version 1.2.0 released ======================== + Change ds9file parameter to outds9file Add cssrcdetect script (#1617) Add background subtraction to ctskymap tool (#1882) Add csobsselect script (#1881) diff --git a/NEWS b/NEWS index 5a73fd4..45e4473 100644 --- a/NEWS +++ b/NEWS @@ -1,6 +1,6 @@ New Features and Important Changes in ctools 1.2.0 -1 December 2016 +12 December 2016 Introduction @@ -232,6 +232,8 @@ definition XML file (#1881). Add cssrcdetect script to detect sources in a sky map (#1617). +The "ds9file" parameters were changed to "outds9file" to be consistent with +the naming conventions. Examples diff --git a/cscripts/csmodelinfo.par b/cscripts/csmodelinfo.par index 5506773..b78a3ae 100644 --- a/cscripts/csmodelinfo.par +++ b/cscripts/csmodelinfo.par @@ -5,7 +5,6 @@ # ------------------------------------------------------------------------- # # # # File: csmodelinfo.par # -# Version: 1.1.0 # # # # Author: Michael Mayer # # michael.mayer@physik.hu-berlin.de # @@ -17,8 +16,8 @@ # # Input and output parameters #============================ -inmodel, f, a, model.xml,,, "Input model XML file" -ds9file, f, h, NONE,,, "Output DS9 region file containing models" +inmodel, f, a, model.xml,,, "Input model definition XML file" +outds9file, f, a, ds9.reg,,, "Output DS9 region file" # # Script parameters diff --git a/cscripts/csmodelinfo.py b/cscripts/csmodelinfo.py index ed2bf22..d60026a 100755 --- a/cscripts/csmodelinfo.py +++ b/cscripts/csmodelinfo.py @@ -79,7 +79,7 @@ class csmodelinfo(ctools.cscript): # Query ahead DS9 filename if self._read_ahead(): - self["ds9file"].filename() + self['outds9file'].filename() # Write input parameters into logger self._log_parameters(gammalib.TERSE) @@ -249,7 +249,7 @@ class csmodelinfo(ctools.cscript): Save models to ds9 region file """ # Get output filename - ds9file = self['ds9file'].filename() + ds9file = self['outds9file'].filename() # Check if DS9 file is valid if ds9file != '' and ds9file != 'NONE': diff --git a/cscripts/csobsinfo.par b/cscripts/csobsinfo.par index ac66a73..5969d98 100644 --- a/cscripts/csobsinfo.par +++ b/cscripts/csobsinfo.par @@ -5,7 +5,6 @@ # ------------------------------------------------------------------------- # # # # File: csobsinfo.par # -# Version: 1.1.0 # # # # Author: Michael Mayer # # michael.mayer@physik.hu-berlin.de # @@ -17,8 +16,8 @@ # # Input and output parameters #============================ -inobs, f, a, obs.xml,,, "Input event list, counts cube, or observation definition XML file" -ds9file, f, h, NONE,,, "Output DS9 region file containing pointings" +inobs, f, a, obs.xml,,, "Input event list, counts cube, or observation definition XML file" +outds9file, f, a, ds9.reg,,, "Output DS9 region file" # # Script parameters diff --git a/cscripts/csobsinfo.py b/cscripts/csobsinfo.py index 8931de1..f93aee8 100755 --- a/cscripts/csobsinfo.py +++ b/cscripts/csobsinfo.py @@ -84,7 +84,7 @@ class csobsinfo(ctools.cscript): # Read ahead DS9 filename if self._read_ahead(): - self['ds9file'].filename() + self['outds9file'].filename() # Write input parameters into logger self._log_parameters(gammalib.TERSE) @@ -327,11 +327,11 @@ class csobsinfo(ctools.cscript): This method saves all pointing directions that are found in the observation container into a DS9 region file. If "NONE" is - specified for the "ds9file" parameter the method does nothing. + specified for the "outds9file" parameter the method does nothing. """ # Get output filename in case it was not read ahead - ds9file = self['ds9file'].filename() + ds9file = self['outds9file'].filename() # Check if DS9 file is valid if ds9file.url() != 'NONE': diff --git a/doc/source/users/reference_manual/csmodelinfo.rst b/doc/source/users/reference_manual/csmodelinfo.rst index 2acce45..99eb69b 100644 --- a/doc/source/users/reference_manual/csmodelinfo.rst +++ b/doc/source/users/reference_manual/csmodelinfo.rst @@ -30,8 +30,8 @@ General parameters ``inmodel [file]`` Event list, counts cube, or observation definition file -``(ds9file = NONE) [file]`` - Output DS9 region file containing models +``outds9file [file]`` + Output DS9 region file containing soucre positions ``(pnt_type=cross) [string]`` Marker type for point sources @@ -98,4 +98,4 @@ Standard parameters Related tools or scripts ------------------------ -None \ No newline at end of file +None diff --git a/doc/source/users/reference_manual/csobsinfo.rst b/doc/source/users/reference_manual/csobsinfo.rst index 6d1ef78..9374a6b 100644 --- a/doc/source/users/reference_manual/csobsinfo.rst +++ b/doc/source/users/reference_manual/csobsinfo.rst @@ -41,6 +41,9 @@ General parameters ``inobs [file]`` Event list, counts cube, or observation definition file +``outds9file [file]`` + DS9 region file containing pointing directions + ``(offset = no) [file]`` Compute offset from target to pointing positions @@ -50,9 +53,6 @@ General parameters ``dec [real]`` Target declination for offset computation (only queried if offset=yes) -``(ds9file = NONE) [file]`` - DS9 region file containing pointings - Standard parameters ------------------- @@ -85,4 +85,4 @@ Standard parameters Related tools or scripts ------------------------ -None \ No newline at end of file +None diff --git a/test/test_csmodelinfo.py b/test/test_csmodelinfo.py index b41186f..4038364 100755 --- a/test/test_csmodelinfo.py +++ b/test/test_csmodelinfo.py @@ -74,7 +74,7 @@ class Test(test): # Setup csmodelinfo command cmd = csmodelinfo+' inmodel="'+self._models_spec+'"'+ \ - ' ds9file="csmodelinfo_cmd1.reg"'+ \ + ' outds9file="csmodelinfo_cmd1.reg"'+ \ ' logfile="csmodelinfo_cmd1.log" chatter=1' # Check if execution of wrong command fails @@ -90,7 +90,7 @@ class Test(test): # Setup csmodelinfo command cmd = csmodelinfo+' inmodel="model_that_does_not_exist.xml"'+ \ - ' ds9file="csmodelinfo_cmd2.reg"'+ \ + ' outds9file="csmodelinfo_cmd2.reg"'+ \ ' logfile="csmodelinfo_cmd2.log"' # Check if execution failed @@ -107,10 +107,10 @@ class Test(test): """ # Set-up csmodelinfo modelinfo = cscripts.csmodelinfo() - modelinfo['inmodel'] = self._models_spat - modelinfo['ds9file'] = 'csmodelinfo_py1.reg' - modelinfo['logfile'] = 'csmodelinfo_py1.log' - modelinfo['chatter'] = 2 + modelinfo['inmodel'] = self._models_spat + modelinfo['outds9file'] = 'csmodelinfo_py1.reg' + modelinfo['logfile'] = 'csmodelinfo_py1.log' + modelinfo['chatter'] = 2 # Run csmodelinfo script and save DS9 file modelinfo.logFileOpen() # Make sure we get a log file @@ -122,10 +122,10 @@ class Test(test): # Set-up csmodelinfo modelinfo = cscripts.csmodelinfo() - modelinfo['inmodel'] = self._models_spec - modelinfo['ds9file'] = 'csmodelinfo_py2.reg' - modelinfo['logfile'] = 'csmodelinfo_py2.log' - modelinfo['chatter'] = 3 + modelinfo['inmodel'] = self._models_spec + modelinfo['outds9file'] = 'csmodelinfo_py2.reg' + modelinfo['logfile'] = 'csmodelinfo_py2.log' + modelinfo['chatter'] = 3 # Execute csmodelinfo script modelinfo.execute() diff --git a/test/test_csobsinfo.py b/test/test_csobsinfo.py index 1012e65..6819201 100755 --- a/test/test_csobsinfo.py +++ b/test/test_csobsinfo.py @@ -73,7 +73,7 @@ class Test(test): # Setup csobsinfo command cmd = csobsinfo+' inobs="'+self._inobs+'"'+ \ - ' ds9file="csobsinfo_cmd1.reg"'+ \ + ' outds9file="csobsinfo_cmd1.reg"'+ \ ' offset=yes ra=83.63 dec=22.01'+ \ ' logfile="csobsinfo_cmd1.log" chatter=1' @@ -90,7 +90,7 @@ class Test(test): # Setup csobsinfo command cmd = csobsinfo+' inobs="obs_definition_that_does_not_exist.xml"'+ \ - ' ds9file="csobsinfo_cmd2.reg"'+ \ + ' outds9file="csobsinfo_cmd2.reg"'+ \ ' offset=yes ra=83.63 dec=22.01'+ \ ' logfile="csobsinfo_cmd2.log"' @@ -108,13 +108,13 @@ class Test(test): """ # Set-up csobsinfo obsinfo = cscripts.csobsinfo() - obsinfo['inobs'] = self._inobs - obsinfo['ds9file'] = 'csobsinfo_py1.reg' - obsinfo['offset'] = True - obsinfo['ra'] = 83.63 - obsinfo['dec'] = 22.01 - obsinfo['logfile'] = 'csobsinfo_py1.log' - obsinfo['chatter'] = 2 + obsinfo['inobs'] = self._inobs + obsinfo['outds9file'] = 'csobsinfo_py1.reg' + obsinfo['offset'] = True + obsinfo['ra'] = 83.63 + obsinfo['dec'] = 22.01 + obsinfo['logfile'] = 'csobsinfo_py1.log' + obsinfo['chatter'] = 2 # Run csobsinfo script and save XML file obsinfo.logFileOpen() # Make sure we get a log file @@ -126,13 +126,13 @@ class Test(test): # Set-up csobsinfo obsinfo = cscripts.csobsinfo() - obsinfo['inobs'] = self._inobs - obsinfo['ds9file'] = 'csobsinfo_py2.reg' - obsinfo['offset'] = True - obsinfo['ra'] = 83.63 - obsinfo['dec'] = 22.01 - obsinfo['logfile'] = 'csobsinfo_py2.log' - obsinfo['chatter'] = 3 + obsinfo['inobs'] = self._inobs + obsinfo['outds9file'] = 'csobsinfo_py2.reg' + obsinfo['offset'] = True + obsinfo['ra'] = 83.63 + obsinfo['dec'] = 22.01 + obsinfo['logfile'] = 'csobsinfo_py2.log' + obsinfo['chatter'] = 3 # Execute csobsinfo script obsinfo.execute() -- libgit2 0.21.4