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

Table of contents
Abstract
I/O
Parameters
Examples
Particulars
Exceptions
Files
Restrictions
Required_Reading
Literature_References
Author_and_Institution
Version
Index_Entries


Abstract


   CSPICE_SRFC2S translates a surface ID code, together with a body
   ID code, to the corresponding surface name. If no such name exists,
   return a string representation of the surface ID code.

I/O


   Given:

      code     an integer code for a surface associated with a body.

               help, code
                  LONG = Scalar

      bodyid   an integer code for the body associated with the surface
               designated by `code'.

               help, bodyid
                  LONG = Scalar

               The combination of `code' and `bodyid' is to be mapped to a
               surface name.

   the call:

      cspice_srfc2s, code, bodyid, srfstr, isname

   returns:

      srfstr   the name of the surface identified by `code', for the body
               designated by `bodyid', if an association exists between this
               pair of ID codes and a surface name.

               help, srfstr
                  STRING = Scalar

               If `code' has more than one translation, then the most
               recently defined surface name corresponding to `code' is
               returned. `srfstr' will have the exact format (case and
               embedded blanks) used in the definition of the
               name/code association.

               If the input pair of codes does not map to a surface
               name, `srfstr' is set to the string representation of
               `code'.

      isname   a logical flag that is True if a surface name corresponding to
               the input ID codes was found and False otherwise.

               help, isname
                  BOOLEAN = Scalar

               When `isname' is False, the output string `srfstr' contains a
               string representing the integer `code'.

Parameters


   None.

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.

   1) Supposed a text kernel has been loaded that contains
      the following assignments:

         NAIF_SURFACE_NAME += ( 'MGS MOLA  64 pixel/deg',
                                'MGS MOLA 128 pixel/deg',
                                'PHOBOS GASKELL Q512'     )
         NAIF_SURFACE_CODE += (   1,   2,    1 )
         NAIF_SURFACE_BODY += ( 499, 499,  401 )

      Translate each surface and body ID code pair to the
      associated surface name. Also perform a translation
      for a surface ID having no matching name.

      Use the meta-kernel shown below to define the required SPICE
      kernel variables.


         KPL/MK

         File: srfc2s_ex1.tm

         This meta-kernel is intended to support operation of SPICE
         example programs. The file contents shown here should not be
         assumed to contain adequate or correct versions of data
         required by SPICE-based user applications.


         \begindata

         NAIF_SURFACE_NAME += ( 'MGS MOLA  64 pixel/deg',
                                'MGS MOLA 128 pixel/deg',
                                'PHOBOS GASKELL Q512'     )
         NAIF_SURFACE_CODE += (   1,   2,    1 )
         NAIF_SURFACE_BODY += ( 499, 499,  401 )

         \begintext

         End of meta-kernel


      Example code begins here.


      PRO srfc2s_ex1

         bodyid = [  499L, 401, 499, 499, -1 ]
         surfid = [  1L,   1,   2,   3,  1  ]
         tf     = [ 'false', 'true' ]
         meta   = 'srfc2s_ex1.tm';

         cspice_furnsh, meta

         for i= 0, n_elements( bodyid )-1L do begin

            cspice_srfc2s, surfid[i], bodyid[i], srfnam, isname

            print, 'surface ID       = ', surfid[i]
            print, 'body ID          = ', bodyid[i]
            print, 'name found       = ', tf[ long(isname) ]
            print, 'surface string   = ', srfnam
            print

         endfor

         ;;
         ;; It's always good form to unload kernels after use,
         ;; particularly in IDL due to data persistence.
         ;;
         cspice_kclear

      END


      When this program was executed on a Mac/Intel/IDL8.x/64-bit
      platform, the output was:


      surface ID       =            1
      body ID          =          499
      name found       = true
      surface string   = MGS MOLA  64 pixel/deg

      surface ID       =            1
      body ID          =          401
      name found       = true
      surface string   = PHOBOS GASKELL Q512

      surface ID       =            2
      body ID          =          499
      name found       = true
      surface string   = MGS MOLA 128 pixel/deg

      surface ID       =            3
      body ID          =          499
      name found       = false
      surface string   = 3

      surface ID       =            1
      body ID          =           -1
      name found       = false
      surface string   = 1


Particulars


   Surfaces are always associated with bodies (which usually are
   ephemeris objects). For any given body, a mapping between surface
   names and surface ID codes can be established.

   Bodies serve to disambiguate surface names and ID codes: the set
   of surface names and surface ID codes for a given body can be
   thought of as belonging to a name space. A given surface ID code
   or surface name may be used for surfaces of multiple bodies,
   without conflict.

   Associations between surface names and ID codes are always made
   via kernel pool assignments; there are no built-in associations.

   cspice_srfc2s is one of four related procedures:

      cspice_srfs2c    Surface string and body string to surface ID code
      cspice_srfscc    Surface string and body ID code to surface ID code
      cspice_srfc2s    Surface ID code and body ID code to surface string
      cspice_srfcss    Surface ID code and body string to surface string

   cspice_srfs2c, cspice_srfc2s, cspice_srfscc, and cspice_srfcss perform
   translations between surface strings and their corresponding
   integer ID codes.

   Refer to naif_ids.req for details concerning adding new surface
   name/code associations at run time by loading text kernels.

Exceptions


   1)  If the input surface ID code cannot be mapped to a name, the
       output `srfstr' is set to a string representation of the code.
       The input body ID is ignored. The output `isname' is set to
       False.

       This case is not treated as an error.

   2)  If any of the input arguments, `code' or `bodyid', is
       undefined, an error is signaled by the IDL error handling
       system.

   3)  If any of the input arguments, `code' or `bodyid', is not of
       the expected type, or it does not have the expected dimensions
       and size, an error is signaled by the Icy interface.

   4)  If any of the output arguments, `srfstr' or `isname', is not a
       named variable, an error is signaled by the Icy interface.

Files


   Surface name-to-ID mappings may be defined at run time by loading
   text kernels containing kernel variable assignments of the form

      NAIF_SURFACE_NAME += ( <surface name 1>, ... )
      NAIF_SURFACE_CODE += ( <surface code 1>, ... )
      NAIF_SURFACE_BODY += ( <body code 1>,    ... )

   Above, the ith elements of the lists on the assignments' right
   hand sides together define the ith surface name/ID mapping.

   The same effect can be achieved using assignments formatted as
   follows:

      NAIF_SURFACE_NAME += <surface name 1>
      NAIF_SURFACE_CODE += <surface code 1>
      NAIF_SURFACE_BODY += <body code 1>

      NAIF_SURFACE_NAME += <surface name 2>
      NAIF_SURFACE_CODE += <surface code 2>
      NAIF_SURFACE_BODY += <body code 2>

         ...

   Note the use of the

      +=

   operator; this operator appends to rather than overwrites the
   kernel variable named on the left hand side of the assignment.

Restrictions


   None.

Required_Reading


   DSK.REQ
   ICY.REQ
   NAIF_IDS.REQ

Literature_References


   None.

Author_and_Institution


   J. Diaz del Rio     (ODC Space)
   M. Liukis           (JPL)
   E.D. Wright         (JPL)

Version


   -Icy Version 1.0.1, 01-JUN-2021 (JDR)

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections.

       Edited the header to comply with NAIF standard.

       Removed reference to the routine's corresponding CSPICE header from
       -Abstract section.

       Added arguments' type and size information in the -I/O section.

   -Icy Version 1.0.0, 15-DEC-2016 (ML) (EDW)

Index_Entries


   surface ID code and body ID code to surface string



Fri Dec 31 18:43:07 2021