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.

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.

                 [1,1] = size(keywrd); int32 = class(keywrd)

   the call:

      dpval = cspice_dskgtl( keywrd )

   returns:

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

                 [1,1] = size(dpval); double = class(dpval)

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.

   Example(1):

      function dskgtl_t

         %
         % Retrieve the DSK tolerance keys and corresponding values.
         %
         MiceUser


         %
         % 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=1:numel( dskkeys )

            dpval = cspice_dskgtl( dskkeys(i) );

            fprintf( 'Key %s, key value %d, parameter value %d\n', ...
                             char( knames(i) ), dskkeys(i), dpval )

         end

         fprintf( '\n' )
         %
         % Alter the values of the parameters. Note, you cannot change
         % parameters SPICE_DSK_KEYAMG and SPICE_DSK_KEYLAL.
         % Confirm the change.
         %
         for i=[1:4]

            cspice_dskstl( dskkeys(i), i*10 );
            dpval = cspice_dskgtl( dskkeys(i) );

            fprintf( 'Key %s, key value %d, new parameter value %d\n', ...
                             char( knames(i) ), dskkeys(i), dpval )
         end

   Matlab outputs:

      Key SPICE_DSK_KEYXFR, key value 1, parameter value 1.000000e-10
      Key SPICE_DSK_KEYSGR, key value 2, parameter value 1.000000e-08
      Key SPICE_DSK_KEYSPM, key value 3, parameter value 1.000000e-10
      Key SPICE_DSK_KEYPTM, key value 4, parameter value 1.000000e-07
      Key SPICE_DSK_KEYAMG, key value 5, parameter value 1.000000e-12
      Key SPICE_DSK_KEYLAL, key value 6, parameter value 1.000000e-12

      Key SPICE_DSK_KEYXFR, key value 1, new parameter value 10
      Key SPICE_DSK_KEYSGR, key value 2, new parameter value 20
      Key SPICE_DSK_KEYSPM, key value 3, new parameter value 30
      Key SPICE_DSK_KEYPTM, key value 4, new parameter value 40

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


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

   MICE.REQ
   DAS.REQ
   DSK.REQ

Version


   -Mice Version 1.0.0, 10-MAR-2016, EDW (JPL), NJB (JPL)

Index_Entries


   retrieve dsk tolerance or margin parameters


Wed Apr  5 18:00:30 2017