Index Page
cspice_dskobj
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_DSKOBJ returns the set of body ID codes of all objects
   for which topographic data are provided in specified DSK files.

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

I/O


   Given:

      dsk     SPICE DSK file name.

      bodids  is an initialized Icy cell data structure.

              `bodids' optionally may contain a set of body ID
              codes on input; on output, the data already
              present in `bodids' will be combined with ID code
              set found for the file `dsk'.

              The cell is initialized to cardinality zero, and
              defined size on creation.

   the call:

      cspice_dskobj, dsk, bodids

   returns:

      bodids   is an Icy set data structure that contains the
               union of its contents upon input with the set of
               body ID codes of segments in the indicated DSK
               file.

               The elements of Icy sets are unique; each ID
               code in `bodids' appears only once, even if the DSK
               file contains multiple segments for that ID code.

               The user must create 'bodids' using cspice_celli. (Note:
               a set is a type of cell).

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.

      PRO dskobj_t, dsk

         MAXID  = 1000L

         ;;
         ;; Find the set of objects in the dsk file.
         ;;
         bodids = cspice_celli(MAXID)
         srfids = cspice_celli(MAXID)

         cspice_dskobj, dsk, bodids

         for i=0, cspice_card( bodids ) - 1 do begin

            obj = bodids.base[ bodids.data + i ]

            print, 'Body ID:     '  , obj

            ;;
            ;; Get the surface IDs for the Ith body.
            ;;
            cspice_dsksrf, dsk, obj, srfids

            for i=0, cspice_card( srfids ) - 1 do begin

               srf = srfids.base[ srfids.data + i ]

               print, '   Surface ID:  '  , srf

            endfor

         endfor

      END

   IDL outputs:

      IDL> dsksrf_t, 'phobos_3_3_3seg.bds'
      Body ID:              401
         Surface ID:             1
         Surface ID:             2
         Surface ID:             3

Particulars


   This routine provides an API via which applications can determine 
   the set of objects for which there are topographic data in a 
   specified DSK file. 
 

Required Reading


   ICY.REQ
   DAS.REQ
   DSK.REQ
   SETS.REQ
   NAIF_IDS.REQ

Version


   -Icy Version 1.0.0, 14-DEC-2016, ML (JPL), EDW (JPL)

Index_Entries


   find id codes of ephemeris objects in dsk file
   find id codes of bodies in dsk file



Wed Apr  5 17:58:00 2017