Table of contents
MICE_BODS2C translates a string containing a body name or
ID code to the corresponding integer code.
Given:
name containing the name or ID code of a body or object, such as a
planet, satellite, comet, asteroid, barycenter, DSN station,
spacecraft, or instrument.
[n,m] = size(name); char = class(name)
or
[1,n] = size(name); cell = class(name)
If `name' contains the name of a body or object, that name
must be "known" to the SPICE system, whether through
hard-coded registration or run-time registration in the SPICE
kernel pool.
Case and leading and trailing blanks in `name' are not
significant. However when a name is made up of more than one
word, they must be separated by at least one blank. That is,
all of the following strings are equivalent names:
'JUPITER BARYCENTER'
'Jupiter Barycenter'
'JUPITER BARYCENTER '
'JUPITER BARYCENTER'
' JUPITER BARYCENTER'
However, 'JUPITERBARYCENTER' is not equivalent to the names
above.
If `name' is a string representation of an integer, for
example
'399'
the string will be translated to the equivalent integer datum.
The input integer need not be one recognized by the SPICE
system: the integer need not be a built-in NAIF ID code, nor
need it be associated with a name via run-time registration.
the call:
[ID] = mice_bods2c( name )
returns:
ID the structure(s) associating a body name with a corresponding
SPICE ID.
[1,n] = size(ID); struct = class(ID)
Each structure consists of the fields:
name the "name" of a particular body.
[1,c1] = size(ID.name); char = class(ID.name)
If a mapping does not exist, the `name' field
returns as NULL.
code the SPICE code assigned either by SPICE or the
user to `name'.
If a mapping does not exist, the `code' field
returns as 0.
[1,1] = size(ID.code); int32 = class(ID.code)
found true if `name' has a translation or represents an
integer within the bounds of representable
integers as defined by the Mice routines
cspice_intmax and cspice_intmin.
[1,1] = size(ID.found); logical = class(ID.found)
`ID' returns with the same vectorization measure, N, as
`name'.
MAXL is the maximum allowable length of a body name. The
current value of this parameter is 36.
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.
1) Apply the mice_bods2c call to several body names to retrieve
their associated NAIF IDs included in the default SPICE ID-name
lists, a name not included in that list, a string representing a
positive integer and another representing a negative integer.
Example code begins here.
function bods2c_ex1()
%
% Retrieve the NAIF ID associated to a body name.
%
disp( 'Scalar:' )
name = 'Hyperion';
ID = mice_bods2c( name );
%
% Output the mapping if it exists.
%
if ( ID.found )
txt = sprintf( 'String %s maps to ID %i', ID.name, ID.code );
disp(txt)
end
disp(' ')
%
% Create an array of strings. Include one string not an integer
% and unknown to the SPICE system.
%
disp( 'Vector:' )
name = strvcat( 'Cassini', '399', 'Planet Bob', ...
'MARS', '-123456', '987654' );
ID = mice_bods2c( name );
n_elements = size(ID,2);
%
% Loop over the output array.
%
for i=1:n_elements(1)
%
% Check for a valid name/ID mapping.
%
if( ID(i).found )
txt = sprintf( 'String %s maps to ID %i', ...
ID(i).name, ID(i).code );
disp(txt)
else
txt = sprintf( 'Unknown string ID %s', name(i,:) );
disp(txt)
end
end
When this program was executed on a Mac/Intel/Octave6.x/64-bit
platform, the output was:
Scalar:
String Hyperion maps to ID 607
Vector:
String Cassini maps to ID -82
String 399 maps to ID 399
Unknown string ID Planet Bob
String MARS maps to ID 499
String -123456 maps to ID -123456
String 987654 maps to ID 987654
A sister version of this routine exists named cspice_bods2c that returns
the structure field data as separate arguments.
mice_bods2c is one of three related subroutines,
mice_bods2c Body string to code
mice_bodc2s Body code to string
mice_bodn2c Body name to code
mice_bods2c, mice_bodc2s, and mice_bodn2c perform translations between
body names and their corresponding integer ID codes which are used in
SPICE files and routines.
mice_bods2c is a slightly more general version of mice_bodn2c:
support for strings containing ID codes in string format enables a caller
to identify a body using a string, even when no name is associated with
that body.
Refer to naif_ids.req for the list of name/code associations built
into SPICE, and for details concerning adding new name/code
associations at run time by loading text kernels.
1) If there is any problem with the body name-ID mapping kernel
variables present in the kernel pool, an error is signaled by
a routine in the call tree of this routine.
2) Body name strings are upper-cased, their leading and trailing
blanks removed, and embedded blanks are compressed out, after
which they get truncated to the maximum body name length MAXL.
Therefore, two body names that differ only after that maximum
length are considered equal.
3) If the input argument `name' is undefined, an error is
signaled by the Matlab error handling system.
4) If the input argument `name' is not of the expected type, or
it does not have the expected dimensions and size, an error is
signaled by the Mice interface.
Body-name mappings may be defined at run time by loading text
kernels containing kernel variable assignments of the form
NAIF_BODY_NAME += ( <name 1>, ... )
NAIF_BODY_CODE += ( <code 1>, ... )
See naif_ids.req for details.
1) See exception <2>.
MICE.REQ
NAIF_IDS.REQ
None.
J. Diaz del Rio (ODC Space)
E.D. Wright (JPL)
-Mice Version 1.1.0, 10-AUG-2021 (EDW) (JDR)
Edited the header to comply with NAIF standard. Extended the
-Particulars section. Corrected description of ID output argument
structure. Fixed bug on example code.
Added -Parameters, -Exceptions, -Files, -Restrictions,
-Literature_References and -Author_and_Institution sections.
Eliminated use of "lasterror" in rethrow.
Removed reference to the function's corresponding CSPICE header from
-Required_Reading section.
-Mice Version 1.0.1, 01-DEC-2014 (EDW)
Edited -I/O section to conform to NAIF standard for Mice
documentation.
-Mice Version 1.0.0, 22-NOV-2005 (EDW)
body name to code
|