Index Page
cspice_dskgtl
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 

Abstract
I/O
Examples
Particulars
Required Reading
Version
Index_Entries

Abstract


   CSPICE_DSKGTL retrieves the value of a specified DSK tolerance
   or margin parameter.

   For important details concerning this module's function, please refer to
   the CSPICE routine dskgtl_c.

I/O


   Given:

      keywrd    is an integer code specifying the parameter to
                retrieve. See the include file dsktol.m for
                a description of the possible keywords.

   the call:

      cspice_dskgtl, keywrd, dpval

   returns:

      dpval    is the value of the parameter specified by `keywrd'.

Examples


   Any numerical results shown for this example may differ between
   platforms as the results depend on the SPICE kernels used as input
   and the machine specific arithmetic implementation.

      PRO DSKGTL_T

         ;;
         ;; Retrieve the DSK tolerance keys and corresponding values.
         ;;
         @IcyUser

         ;;
         ;; Define an array of keys, and an array of key names.
         ;;
         dskkeys = [ SPICE_DSK_KEYXFR, SPICE_DSK_KEYSGR,  $
                     SPICE_DSK_KEYSPM, SPICE_DSK_KEYPTM,  $
                     SPICE_DSK_KEYAMG, SPICE_DSK_KEYLAL ]

         knames = [ 'SPICE_DSK_KEYXFR', 'SPICE_DSK_KEYSGR',  $
                    'SPICE_DSK_KEYSPM', 'SPICE_DSK_KEYPTM',  $
                    'SPICE_DSK_KEYAMG', 'SPICE_DSK_KEYLAL' ]


         ;;
         ;; Output the tolerance keys and values.
         ;;
         for i= 0, ( n_elements(dskkeys) -1 ) do begin

            cspice_dskgtl, dskkeys[i], dpval

           print, 'Key ', knames[i]
           print, '   key value ', dskkeys[i]
           print, '   parameter value ',dpval

         endfor

         print
         ;;
         ;; Alter the values of the parameters. Note, you cannot change
         ;; parameters SPICE_DSK_KEYAMG and SPICE_DSK_KEYLAL.
         ;; Confirm the change.
         ;;
         for i=0, 3 do begin

            cspice_dskstl, dskkeys[i], i*10
            cspice_dskgtl, dskkeys[i], dpval

           print, 'Key ', knames[i]
           print, '   key value ', dskkeys[i]
           print, '   new parameter value ',dpval

         endfor

      END

   IDL outputs:

      IDL> dskgtl_t
      Key SPICE_DSK_KEYXFR
         key value        1
         parameter value    1.0000000e-10
      Key SPICE_DSK_KEYSGR
         key value        2
         parameter value    1.0000000e-08
      Key SPICE_DSK_KEYSPM
         key value        3
         parameter value    1.0000000e-10
      Key SPICE_DSK_KEYPTM
         key value        4
         parameter value    1.0000000e-07
      Key SPICE_DSK_KEYAMG
         key value        5
         parameter value    1.0000000e-12
      Key SPICE_DSK_KEYLAL
         key value        6
         parameter value    1.0000000e-12

      Key SPICE_DSK_KEYXFR
         key value        1
         new parameter value        0.0000000
      Key SPICE_DSK_KEYSGR
         key value        2
         new parameter value        10.000000
      Key SPICE_DSK_KEYSPM
         key value        3
         new parameter value        20.000000
      Key SPICE_DSK_KEYPTM
         key value        4
         new parameter value        30.000000

Particulars


   The DSK tolerance routines centralize numeric tolerance and margin
   values used by the DSK subsystem. The DSK subsystem retrieves values
   from the DSK tolerance subsystem to use at run time.

   The DSK tolerance access functions are

      cspice_dskgtl {DSK, get tolerance value}
      cspice_dskstl {DSK, set tolerance value}

   To minimize run time overhead, the "keywords" used by these routines
   to identify parameters are actually integer codes.

   SPICE users may override certain values maintained by this subsystem;
   others values are fixed. It is recommended that any change to the
   tolerance values made at run time be performed only by expert SPICE
   users.

Required Reading


   ICY.REQ
   DAS.REQ
   DSK.REQ

Version


   -Icy Version 1.0.0, 13-DEC-2016, ML (JPL), EDW (JPL)

Index_Entries


   retrieve dsk tolerance or margin parameters



Wed Apr  5 17:58:00 2017