ttools: rename cdsskymatch parameter sr->radius

Units are different from coneskymatch sr parameter, so it's a good idea to have different names. Also clarify units (arcsec) in usage message.
Starlink · Jul 4, 2014 · 51afc0b · 51afc0b
1 parent ac5819b
commit 51afc0b
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/ttools/src/docs/sun256.xml b/ttools/src/docs/sun256.xml
@@ -4174,7 +4174,7 @@ the following acknowledgement:
 
 <dt><verbatim>
 stilts cdsskymatch cdstable=II/246/out find=all
-                   in=dr5qso.fits ra=RA dec=DEC sr=1 out=qso_2mass.fits
+                   in=dr5qso.fits ra=RA dec=DEC radius=1 out=qso_2mass.fits
 </verbatim></dt>
 <dd><p>Matches a local catalogue <code>dr5qso.fits</code> against the
     VizieR table <code>II/246/out</code> (the 2MASS Point Source Catalogue).
@@ -4184,7 +4184,7 @@ stilts cdsskymatch cdstable=II/246/out find=all
 
 <dt><verbatim>
 stilts cdsskymatch cdstable=simbad find=best
-                   in=sources.txt ifmt=ascii ra=RAJ2000 dec=DEJ2000 sr=8.5
+                   in=sources.txt ifmt=ascii ra=RAJ2000 dec=DEJ2000 radius=8.5
                    blocksize=1000 icmd=progress omode=topcat
 </verbatim></dt>
 <dd><p>This finds the closest object in the SIMBAD database within 8.5 arcsec

diff --git a/ttools/src/main/uk/ac/starlink/ttools/cone/SkyConeMatch2.java b/ttools/src/main/uk/ac/starlink/ttools/cone/SkyConeMatch2.java
@@ -85,7 +85,7 @@ public SkyConeMatch2( String purpose, Coner coner, int maxParallel ) {
         paramList.add( decParam_ );
 
         srParam_ = new Parameter( "sr" );
-        srParam_.setUsage( "<expr>" );
+        srParam_.setUsage( "<expr/deg>" );
         srParam_.setPrompt( "Search radius in degrees" );
         srParam_.setDescription( new String[] {
             "<p>Expression which evaluates to the search radius in degrees",

diff --git a/ttools/src/main/uk/ac/starlink/ttools/task/CdsUploadSkyMatch.java b/ttools/src/main/uk/ac/starlink/ttools/task/CdsUploadSkyMatch.java
@@ -72,13 +72,14 @@ public CdsUploadSkyMatch() {
             SkyCoordParameter.createDecParameter( "dec", system, inDescrip );
         paramList.add( decParam_ );
 
-        srParam_ = new DoubleParameter( "sr" );
+        srParam_ = new DoubleParameter( "radius" );
         srParam_.setPrompt( "Search radius value in arcsec (0-180)" );
+        srParam_.setUsage( "<value/arcsec>" );
         srParam_.setDescription( new String[] {
             "<p>Maximum distance from the local table (ra,dec) position",
             "at which counterparts from the remote table will be identified.",
             "This is a fixed value is given in arcseconds,",
-            "and must be in the range 0&lt;=<code>sr</code>&gt;=180",
+            "and must be in the range [0,180]",
             "(this limit is currently enforced by the CDS Xmatch service).",
             "</p>",
         } );
@@ -232,7 +233,7 @@ public CdsUploadSkyMatch() {
             "large (multi-million-row?) multi-block matches,",
             "where both local and remote catalogues are spread over",
             "a significant fraction of the sky.",
-            "But feel free to experiment",
+            "But feel free to experiment.",
             "</p>",
         } );
         presortParam_.setDefault( Boolean.FALSE.toString() );