Index Page
cspice_srfs2c
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_SRFS2C translates a surface string, together with a body string,
   to the corresponding surface ID code. The input strings may contain
   names or integer ID codes.

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

I/O


   Given:

      srfstr     is a string designating a surface. `srfstr' may contain
                 a surface name or a string representation of the
                 surface's integer ID code.

                 Case and leading and trailing blanks in a surface name
                 are not significant. Sequences of consecutive embedded
                 blanks are considered equivalent to a single blank. For
                 example, all of the strings below are considered to be
                 equivalent:

                    'MGS MOLA 128 PIXEL/DEG'
                    'MGS MOLA 128 pixel/deg'
                    'MGS MOLA 128 PIXEL/DEG   '
                    'MGS MOLA 128    PIXEL/DEG'
                    '   MGS MOLA 128 PIXEL/DEG'

                 However,

                    'MGSMOLA 128PIXEL/DEG'

                 is not equivalent to the names above.

      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. The treatment of blanks in `bodstr' is the
                 same as for `srfstr'.

   the call:

      cspice_srfs2c, srfstr, bodstr, code, found

   returns:

      code       is integer ID code of the surface designated by `srfstr',
                 for the body designated by `bodstr', if for this body an
                 association exists between the input surface string and a
                 surface ID code. `code' is defined if and only if the
                 output flag `found' is true.

      found      is a logical flag that is true if a surface code
                 corresponding to the input strings was found and
                 false otherwise.

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 SRFS2C_T
      
         bodstr = [ 'MARS', 'PHOBOS', 'MARS', $
                    '499',  'PHOBOS', '499',  $
                     'MARS', 'ZZZ' ]
         srfstr = [ 'MGS MOLA  64 pixel/deg', $
                    'PHOBOS GASKELL Q512',    $
                    'MGS MOLA 128 pixel/deg', $
                    'MGS MOLA  64 pixel/deg', $
                    '1',   $
                    '2',   $
                    'ZZZ', $
                    '1' ]
      
         tf     = [ 'false', 'true' ]
         meta   = 'srfc2s_t1.tm';
      
         cspice_furnsh, meta
      
         for i= 0, n_elements( srfstr )-1 do begin
      
            surfid  = -1
      
            cspice_srfs2c, srfstr[i], bodstr[i], surfid, found
      
            print, 'surface string   = ', srfstr[i]
            print, 'body string      = ', bodstr[i]
            print, 'surface ID found = ', tf[ long(found) ]
            
            if (found) then print, 'surface ID       = ', surfid
            
            print
      
         endfor
      
      END

   IDL outputs:

      surface string   = MGS MOLA  64 pixel/deg
      body string      = MARS
      surface ID found = true
      surface ID       =            1
      
      surface string   = PHOBOS GASKELL Q512
      body string      = PHOBOS
      surface ID found = true
      surface ID       =            1
      
      surface string   = MGS MOLA 128 pixel/deg
      body string      = MARS
      surface ID found = true
      surface ID       =            2
      
      surface string   = MGS MOLA  64 pixel/deg
      body string      = 499
      surface ID found = true
      surface ID       =            1
      
      surface string   = 1
      body string      = PHOBOS
      surface ID found = true
      surface ID       =            1
      
      surface string   = 2
      body string      = 499
      surface ID found = true
      surface ID       =            2
      
      surface string   = ZZZ
      body string      = MARS
      surface ID found = false
      
      surface string   = 1
      body string      = ZZZ
      surface ID found = false

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_srfs2c 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, 20-DEC-2016, ML (JPL), EDW (JPL)

Index_Entries


   surface string and body string to surface ID code



Wed Apr  5 17:58:04 2017