NAMFRM ( frame NAMe to FRaMe id )
ENTRY NAMFRM ( FRNAME, FRCODE )
Look up the frame ID code associated with a string.
VARIABLE I/O DESCRIPTION
-------- --- --------------------------------------------------
FRNAME I The name of some reference frame
FRCODE O The SPICE ID code of the frame.
FRNAME is a character string that stands for some
reference frame (either inertial or non-inertial).
Leading blanks in FRNAME are ignored. And the
case of the letters in FRNAME are insignificant.
Note that all legitimate frame names contain
26 or fewer characters.
FRCODE is the SPICE integer code used for internal
representation of the named reference frame.
If the name input through FRNAME is not recognized
FRCODE will be returned with a value of zero.
1) If the input name is not recognized, FRCODE will be
returned with a value of 0.
This is a low level interface routine intended primarily for
use within the SPK and CK systems to assist in the transformation
to user specified reference frames.
The routine first consults a stored list of reference frame
names in an attempt to determine the appropriate reference
If this search is unsuccessful, the routine then examines the
kernel pool to determine whether or not a variable of the
'FRAME_' // FRNAME
(where leading blanks of FRNAME are ignored)
is present. If it is and the number of values associated with the
name is 1, this value is taken to be the frame ID code.
Note: It is NOT possible to override the default names and
ID codes stored locally in this routine by placing an
appropriately variable in the kernel pool with a different
ID code. The predefined values always take precedence.
Consult the FRAMES required reading document for more details
about constructing your own frame definitions.
Suppose that you needed to find the SPICE ID code for the
bodyfixed reference frame for Mars as modeled by the
IAU cartographic working group. Use the following code
to perform this task.
CALL NAMFRM ( 'IAU_MARS', FRCODE )
WRITE (*,*) 'The SPICE code for the Mars bodyfixed frame is: ',
W.L. Taber (JPL)
B.V. Semenov (JPL)
E.D. Wright (JPL)
SPICELIB Version 3.1.0, 08-AUG-2012 (BVS)
The routine was updated to be more efficient by using hashes
instead kernel POOL look-ups for kernel POOL frames and by
using hases instead of ordered array searches for built-in
SPICELIB Version 3.0.2, 17-MAR-2009 (EDW)
Typo correction in Required_Reading, changed FRAME to FRAMES.
SPICELIB Version 3.0.1, 25-JUN-1999 (WLT)
Extended documentation of entry point CNMFRM and
corrected example for that entry point.
SPICELIB Version 3.0.0, 03-JUN-1997 (WLT)
The entry points CIDFRM and CNMFRM were added so that
user's may determine the frame-id and name to associated
with a planetary object.
SPICELIB Version 2.0.0, 04-APR-1997 (WLT)
The routine was upgraded to reflect that a block of
frame ID codes have been reserved for use by the DSN.
ID codes 13001 to 13999 have been set aside for DSN
models for the orientation of the earth. These frames
are all PCK frames. Moreover, the PCK ID code to
use with these frames is simply the Frame-Code minus 10000.
All of these frames are centered at the earth (body 399).
SPICELIB Version 1.1.0, 14-OCT-1996 (WLT)
The values NINERT and NNINRT are included instead of
being declared locally.
SPICELIB Version 1.0.0, 18-SEP-1995 (WLT)