Index Page
cspice_frmnam
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_FRMNAM retrieves the name of a reference frame associated with a
   SPICE frame ID code.

I/O


   Given:

     frcode   value defining a SPICE reference frame ID code.

              [1,n] = size(frcode); int32 = class(frcode)

   the call:

      frmname = cspice_frmnam( frcode )

   returns:

      frmnam   the frame name corresponding to the 'frcode' code.

               [n,m] = size(frmnam); char = class(frmnam)

               If frcode is not recognized as the name of a known reference
               frame, 'frname' will be returned as an empty string.

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.

      %
      % Retrieve frame information for a scalar code.
      %
      disp('Scalar' )
      code = 13000;

      %
      % Output the frame name corresponding to 'code'.
      %
      frmname = cspice_frmnam( code )


      %
      % Retrieve frame information for a vector of codes.
      %
      disp('Vector' )
      codes = [1:5];

      %
      % Output the frame names corresponding to the 'codes'.
      %
      frmname = cspice_frmnam( codes )

   MATLAB outputs:

      Scalar

      frmname =

      ITRF93

      Vector

      frmname =

      J2000
      B1950
      FK4
      DE-118
      DE-96

Particulars


   This routine retrieves the name of a reference frame associated
   with a SPICE frame ID code.

   The ID codes stored locally are scanned for a match with frcode.
   If a match is found, the name stored locally will be returned
   as the name for the frame.

   If frcode is not a member of the list of internally stored
   ID codes, the kernel pool will be examined to see if the
   variable

      FRAME_idcode_NAME

   is present (where idcode is the decimal character equivalent
   of frcode).  If the variable is located and it has both
   character type and dimension 1, the string value of the
   kernel pool variable is returned as the name of the reference
   frame.

   Note that because the local information is always examined
   first and searches of the kernel pool are performed only
   after exhausting local information, it is not possible to
   override the local name for any reference frame that is
   known by this routine.

Required Reading


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

   MICE.REQ
   FRAMES.REQ

Version


   -Mice Version 1.0.0, 12-MAR-2012, EDW (JPL), SCK (JPL)

Index_Entries


   frame ID code to frame name translation


Wed Apr  5 18:00:31 2017