Table of contents
CSPICE_BODC2N returns the body name corresponding to an input numeric
ID value.
Given:
code SPICE code(s) for a set of bodies: planets, satellites,
barycenters, DSN stations, spacecraft, asteroids, comets,
or other ephemeris object.
[1,n] = size(code); int32 = class(code)
the call:
[name, found] = cspice_bodc2n( code )
returns:
name the name(s) corresponding to `code' if a mapping between
`code' and a body name exists within SPICE, assigned either
in SPICE or by the user.
[n,c1] = size(name); char = class(name)
If `code' has more than one translation, then the most
recently defined `name' corresponding to `code' is returned.
`name' will have the exact format (case and blanks) as when
the name/code pair was defined.
found flag(s) indicating if the kernel subsystem translated `code'
to a corresponding `name'.
[1,n] = size(found); logical = class(found)
`found' and `name' return with the same vectorization
measure, N, as `code'.
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 cspice_bodc2n call to several IDs representing codes
included in the default SPICE ID-name lists and codes not
included in the list.
Example code begins here.
function bodc2n_ex1()
%
% Retrieve the current body name associated to a given NAIF ID.
%
disp( 'Scalar:' )
naif_id = 501;
[name, found] = cspice_bodc2n( naif_id );
%
% Output the mapping if it exists.
%
if ( found )
fprintf( 'Body ID %i maps to name %s\n', naif_id, name );
end
disp( ' ' )
%
% Create an array of IDs. Include one unknown ID.
%
disp( 'Vector:' )
naif_id = [ 502, 503, 504, 505, 5006 ];
[name, found] = cspice_bodc2n( naif_id );
n_elements = size(found,2);
%
% Loop over the output array.
%
for n=1:n_elements
%
% Check for a valid name/ID mapping.
%
if( found(n) )
fprintf( 'Body ID %i maps to name %s\n', naif_id(n), ...
name(n,:) );
else
fprintf( 'Unknown body ID %i\n', naif_id(n) );
end
end
When this program was executed on a Mac/Intel/Octave6.x/64-bit
platform, the output was:
Scalar:
Body ID 501 maps to name IO
Vector:
Body ID 502 maps to name EUROPA
Body ID 503 maps to name GANYMEDE
Body ID 504 maps to name CALLISTO
Body ID 505 maps to name AMALTHEA
Unknown body ID 5006
A sister version of this routine exists named mice_bodc2n that returns
the output arguments as fields in a single structure.
cspice_bodc2n is one of five related subroutines,
cspice_bods2c Body string to code
cspice_bodc2s Body code to string
cspice_bodn2c Body name to code
cspice_bodc2n Body code to name
cspice_boddef Body name/code definition
cspice_bods2c, cspice_bodc2s, cspice_bodn2c, and cspice_bodc2n
perform translations between body names and their corresponding
integer ID codes which are used in SPICE files and routines.
cspice_bods2c is a slightly more general version of cspice_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.
cspice_bodc2s is a general version of cspice_bodc2n; the routine returns
either the name assigned in the body ID to name mapping or a string
representation of the 'code' value if no mapping exists.
cspice_boddef assigns a body name to ID mapping. The mapping has
priority in name-to-ID and ID-to-name translations.
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) If the input argument `code' is undefined, an error is
signaled by the Matlab error handling system.
3) If the input argument `code' 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.
None.
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.
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.2, 28-OCT-2014 (EDW)
Edited -I/O section to conform to NAIF standard for Mice
documentation.
-Mice Version 1.0.1, 16-MAY-2009 (EDW)
Edit to -Particulars section to document the cspice_bodc2s routine.
Extended argument descriptions in the -I/O section.
Corrected typo in usage string.
-Mice Version 1.0.0, 22-NOV-2005 (EDW)
body id code to name
|