| srfs2c |
|
Table of contents
Procedure
SRFS2C ( Surface and body strings to surface ID code )
SUBROUTINE SRFS2C ( SRFSTR, BODSTR, CODE, FOUND )
Abstract
Translate a surface string, together with a body string, to the
corresponding surface ID code. The input strings may contain
names or integer ID codes.
Required_Reading
DSK
NAIF_IDS
Keywords
CONVERSION
DSK
ID
NAME
STRING
SURFACE
Declarations
IMPLICIT NONE
CHARACTER*(*) SRFSTR
CHARACTER*(*) BODSTR
INTEGER CODE
LOGICAL FOUND
Brief_I/O
VARIABLE I/O DESCRIPTION
-------- --- --------------------------------------------------
SRFSTR I Surface name or ID string.
BODSTR I Body name or ID string.
CODE O Integer surface ID code.
FOUND O Flag indicating whether surface ID was found.
Detailed_Input
SRFSTR is a string designating a surface. SRFSTR may contain
a surface name or a string representation of the
surface's integer ID code.
If, for the body specified by BODSTR, multiple surface
names are associated with one surface ID code, then any
of these names may be used as the value of SRFSTR.
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 string. 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.
Detailed_Output
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.
Parameters
None.
Exceptions
1) If the input surface string does not map to an ID code
and does not represent an integer, the output CODE is
undefined and the output FOUND is set to .FALSE.
This case is not treated as an error.
2) If the input body string does not map to an ID code and does
not represent an integer, the output CODE is undefined and
the output FOUND is set to .FALSE.
This case is not treated as an error.
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.
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.
SRFS2C is one of four related subroutines:
SRFS2C Surface string and body string to surface ID code
SRFSCC Surface string and body ID code to surface ID code
SRFC2S Surface ID code and body ID code to surface string
SRFCSS Surface ID code and body string to surface string
SRFS2C, SRFC2S, SRFSCC, and 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.
Examples
The formatting of the results shown for this example may differ
across platforms.
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 string pair to the
associated surface ID code. Also perform a translation
for a surface name having no matching ID and for
a body string having no matching body ID code.
Use the meta-kernel shown below to define the required SPICE
kernel variables.
KPL/MK
File: srfs2c_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
Example code begins here.
PROGRAM SRFS2C_EX1
IMPLICIT NONE
INCLUDE 'srftrn.inc'
INTEGER FILSIZ
PARAMETER ( FILSIZ = 255 )
INTEGER NCASE
PARAMETER ( NCASE = 8 )
INTEGER BDNMLN
PARAMETER ( BDNMLN = 36 )
CHARACTER*(BDNMLN) BODSTR ( NCASE )
CHARACTER*(FILSIZ) META
CHARACTER*(SFNMLN) SRFSTR ( NCASE )
INTEGER I
INTEGER SURFID
LOGICAL FOUND
DATA ( SRFSTR(I), BODSTR(I), I = 1, NCASE ) /
.
. 'MGS MOLA 64 pixel/deg', 'MARS',
. 'PHOBOS GASKELL Q512', 'PHOBOS',
. 'MGS MOLA 128 pixel/deg', 'MARS',
. 'MGS MOLA 64 pixel/deg', '499',
. '1', 'PHOBOS',
. '2', '499',
. 'ZZZ', 'MARS',
. '1', 'ZZZ' /
META = 'srfs2c_ex1.tm'
CALL FURNSH ( META )
WRITE (*,*) ' '
DO I = 1, NCASE
CALL SRFS2C ( SRFSTR(I), BODSTR(I),
. SURFID, FOUND )
WRITE (*,*) 'surface string = ', SRFSTR(I)
WRITE (*,*) 'body string = ', BODSTR(I)
WRITE (*,*) 'surface ID found = ', FOUND
IF ( FOUND ) THEN
WRITE (*,*) 'surface ID = ', SURFID
END IF
WRITE (*,*) ' '
END DO
END
When this program was executed on a Mac/Intel/gfortran/64-bit
platform, the output was:
surface string = MGS MOLA 64 pixel/deg
body string = MARS
surface ID found = T
surface ID = 1
surface string = PHOBOS GASKELL Q512
body string = PHOBOS
surface ID found = T
surface ID = 1
surface string = MGS MOLA 128 pixel/deg
body string = MARS
surface ID found = T
surface ID = 2
surface string = MGS MOLA 64 pixel/deg
body string = 499
surface ID found = T
surface ID = 1
surface string = 1
body string = PHOBOS
surface ID found = T
surface ID = 1
surface string = 2
body string = 499
surface ID found = T
surface ID = 2
surface string = ZZZ
body string = MARS
surface ID found = F
surface string = 1
body string = ZZZ
surface ID found = F
Restrictions
None.
Literature_References
None.
Author_and_Institution
N.J. Bachman (JPL)
J. Diaz del Rio (ODC Space)
B.V. Semenov (JPL)
E.D. Wright (JPL)
Version
SPICELIB Version 1.0.1, 22-OCT-2021 (JDR) (NJB)
Edited the header to comply with NAIF standard.
Updated description of SRFSTR to indicate that any
surface name alias may be used.
SPICELIB Version 1.0.0, 14-JAN-2016 (NJB) (EDW) (BVS)
|
Fri Dec 31 18:36:56 2021