Index Page
cspice_srfcss
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_SRFCSS translates a surface ID code, together with a body
   string, to the corresponding surface name. If no such surface name exists,
   return a string representation of the surface ID code.

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

I/O


   Given:

      code     is an integer ID code for a surface associated with a
               specified body.

      bodstr   is a string designating the body associated with the
               input surface ID code. `bodstr' may contain a body name
               or a string representation of the body's integer ID
               code.

               For example, `bodstr' may contain

                  "1000012"

               instead of

                  '67P/CHURYUMOV-GERASIMENKO (1969 R1)'

               Case and leading and trailing blanks in a name are not
               significant. Sequences of consecutive embedded blanks
               are considered equivalent to a single blank. That is,
               all of the following strings are equivalent names:

                  '67P/CHURYUMOV-GERASIMENKO (1969 R1)'
                  '67P/Churyumov-Gerasimenko (1969 R1)'
                  '67P/CHURYUMOV-GERASIMENKO (1969 R1)   '
                  '67P/CHURYUMOV-GERASIMENKO    (1969 R1)'
                  '   67P/CHURYUMOV-GERASIMENKO (1969 R1)'

               However, '67P/CHURYUMOV-GERASIMENKO(1969R1)'
               is not equivalent to the names above.

   the call:

      cspice_srfcss, code, bodstr, srfstr, isname

   returns:

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

               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 surface ID code and body name do not map
               to a surface name, `srfstr' is set to the string
               representation of `code'.

     isname    is a logical flag that is true if a surface name
               corresponding to the input ID codes was found and
               false otherwise. When `isname' is false, the
               output string `srfstr' contains a string representing the
               integer `code'.

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.

   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_t1.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


      PRO SRFCSS_T
      
         bodstr = [ 'MARS', 'PHOBOS', '499', 'MARS', 'ZZZ' ]
         surfid = [  1L,   1,   2,   3,  1 ]
         tf     = [ 'false', 'true' ]
         meta   = 'srfc2s_t1.tm'
      
         cspice_furnsh, meta
      
         for i= 0, n_elements( bodstr )-1L do begin
      
            cspice_srfcss, surfid[i], bodstr[i], srfnam, isname
      
            print, 'surface ID       = ', surfid[i]
            print, 'body string      = ', bodstr[i]
            print, 'name found       = ', tf[ long(isname) ]
            print, 'surface string   = ', srfnam
            print
      
         endfor
      
      END

   IDL outputs:

      surface ID       =            1
      body string      = MARS
      name found       = true
      surface string   = MGS MOLA  64 pixel/deg
      
      surface ID       =            1
      body string      = PHOBOS
      name found       = true
      surface string   = PHOBOS GASKELL Q512
      
      surface ID       =            2
      body string      = 499
      name found       = true
      surface string   = MGS MOLA 128 pixel/deg
      
      surface ID       =            3
      body string      = MARS
      name found       = false
      surface string   = 3
      
      surface ID       =            1
      body string      = ZZZ
      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_srfcss is one of four related subroutines:

      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.

Required Reading


   ICY.REQ
   DSK.REQ
   NAIF_IDS.REQ

Version


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

Index_Entries


   surface ID code and body string to surface string



Wed Apr  5 17:58:04 2017