Index of Functions: A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 
Index Page
cspice_dasopr

Table of contents
Abstract
I/O
Parameters
Examples
Particulars
Exceptions
Files
Restrictions
Required_Reading
Literature_References
Author_and_Institution
Version
Index_Entries

Abstract


   CSPICE_DASOPR opens a DAS file for reading.

I/O


   Given:

      fname    is the name of a DAS file to be opened with read
               access.

               [1,c1] = size(fname); char = class(fname)

                  or

               [1,1] = size(fname); cell = class(fname)

   the call:

      [handle] = cspice_dasopr( fname )

   returns:

      handle   is the handle that is  associated with the file. This
               handle is used to identify the file in subsequent
               calls to other DAS routines.

               [1,1] = size(handle); int32 = class(handle)

Parameters


   None.

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.

   1) Dump several parameters from the first DLA segment of
      a DSK file. The segment is assumed to be of type 2.

      Example code begins here.


      function dasopr_ex1( )

         %
         % Prompt for the name of the file to search.
         %
         fname = input( 'Name of DSK file > ', 's' );

         %
         % Open the DSK file for read access. We use the
         % DAS-level interface for this function.
         %
         handle = cspice_dasopr( fname );

         %
         % Begin a forward search through the kernel. In
         % this example, it's a very short search.
         %
         [ dladsc, found] = cspice_dlabfs( handle );

         if ~found

            txt = sprintf( ...
               'SPICE(NOSEGMENT): No segment found in file %s.', ...
               dsk);

            error(txt)

         end

         %
         % Loop over each segment.
         %
         while found

            %
            % If we made it this far, DLADSC is the
            % DLA descriptor of the first segment.
            % Read and display type 2 bookkeeping data.
            %
            [ nv, np, nvxtot, vtxbds, voxsiz, voxori, vgrext, ...
            cgscal, vtxnpl, voxnpt, voxnpl] = cspice_dskb02( handle, dladsc);

            fprintf( ['\n'                                              ...
                     'Number of vertices:                 %ld\n'        ...
                     'Number of plates:                   %ld\n'        ...
                     'Number of voxels:                   %ld\n'        ...
                     'Vertex bounds in X direction (km):  %f : %f\n'    ...
                     'Vertex bounds in Y direction (km):  %f : %f\n'    ...
                     'Vertex bounds in Z direction (km):  %f : %f\n'    ...
                     'Voxel edge length (km):             %f\n'         ...
                     'Voxel grid origin (km):           ( %f %f %f )\n' ...
                     'Voxel grid extents:                 %ld %ld %ld\n'...
                     'Coarse voxel grid scale:            %ld\n'        ...
                     'Size of vertex-plate list:          %ld\n'        ...
                     'Size of voxel-plate pointer array:  %ld\n'        ...
                     'Size of voxel-plate list:           %ld\n'],      ...
                     nv,                              ...
                     np,                              ...
                     nvxtot,                          ...
                     vtxbds(1,1), vtxbds(2,1),        ...
                     vtxbds(1,2), vtxbds(2,2),        ...
                     vtxbds(1,3), vtxbds(2,3),        ...
                     voxsiz,                          ...
                     voxori(1), voxori(2), voxori(3), ...
                     vgrext(1), vgrext(2), vgrext(3), ...
                     cgscal,                          ...
                     vtxnpl,                          ...
                     voxnpt,                          ...
                     voxnpl )

               %
               % Search for the segment after that described by `dladsc'.
               % `found' returns as false if no such segment located.
               %
               [nxtdsc, found] = cspice_dlafns( handle, dladsc);

               dladsc = nxtdsc;

            end

         %
         % Close the kernel. This frees program and system resources.
         %
         cspice_dascls( handle );


      When this program was executed on a Mac/Intel/Octave6.x/64-bit
      platform, using the DSK file named phobos512.bds, the output
      was:


      Name of DSK file > phobos512.bds

      Number of vertices:                 1579014
      Number of plates:                   3145728
      Number of voxels:                   11914500
      Vertex bounds in X direction (km):  -13.440030 : 12.762800
      Vertex bounds in Y direction (km):  -11.520650 : 12.061140
      Vertex bounds in Z direction (km):  -9.570780 : 10.055000
      Voxel edge length (km):             0.104248
      Voxel grid origin (km):           ( -14.073520 -11.988554 -9.903588 )
      Voxel grid extents:                 260 235 195
      Coarse voxel grid scale:            5
      Size of vertex-plate list:          11010050
      Size of voxel-plate pointer array:  1151500
      Size of voxel-plate list:           6419540


Particulars


   Most DAS files require only read access. If you do not need to
   change the contents of a file, you should open it using cspice_dasopr.

Exceptions


   1)  If the input filename is blank, the error SPICE(BLANKFILENAME)
       is signaled by a routine in the call tree of this routine.

   2)  If the specified file does not exist, the error
       SPICE(FILENOTFOUND) is signaled by a routine in the call tree
       of this routine.

   3)  If the specified file has already been opened for read
       access, the handle already associated with the file is
       returned.

   4)  If the specified file has already been opened for write
       access, the error SPICE(DASRWCONFLICT) is signaled by a
       routine in the call tree of this routine.

   5)  If the specified file has already been opened by a non-DAS
       routine, the error SPICE(DASIMPROPOPEN) is signaled by a
       routine in the call tree of this routine.

   6)  If the specified file cannot be opened without exceeding the
       maximum allowed number of open DAS files, the error
       SPICE(DASFTFULL) is signaled by a routine in the call tree of
       this routine.

   7)  If the named file cannot be opened properly, an error is
       signaled by a routine in the call tree of this routine.

   8)  If the file record cannot be read, the error
       SPICE(FILEREADFAILED) is signaled by a routine in the call
       tree of this routine.

   9)  If the specified file is not a DAS file, as indicated by the
       file's ID word, an error is signaled by a routine in the call
       tree of this routine.

   10) If no logical units are available, an error is signaled
       by a routine in the call tree of this routine.

   11) If the input argument `fname' is undefined, an error is
       signaled by the Matlab error handling system.

   12) If the input argument `fname' is not of the expected type, or
       it does not have the expected dimensions and size, an error is
       signaled by the Mice interface.

Files


   See argument `fname'.

Restrictions


   None.

Required_Reading


   MICE.REQ
   DAS.REQ
   DSK.REQ

Literature_References


   None.

Author_and_Institution


   N.J. Bachman        (JPL)
   J. Diaz del Rio     (ODC Space)
   E.D. Wright         (JPL)

Version


   -Mice Version 1.1.0, 10-AUG-2021 (EDW) (JDR)

       Edited the -Examples section to comply with NAIF standard. Added
       complete example code based on example in cspice_dskb02.

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections.

       Eliminated use of "lasterror" in rethrow.

   -Mice Version 1.0.0, 28-APR-2014 (NJB) (EDW)

Index_Entries


   open a DAS file for reading
   open a DAS file for read access


Fri Dec 31 18:44:23 2021