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_spklef

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

Abstract


   CSPICE_SPKLEF loads an ephemeris file for use by the readers. It returns
   that file's handle, to be used by other SPK routines to refer to the
   file.

I/O


   Given:

      fname    a string containing the name of the file to be loaded.

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

                  or

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

   the call:

      [handle] = cspice_spklef( fname )

   returns:

      handle   an integer handle assigned to the file upon loading.

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

               Almost every other SPK routine will subsequently use this
               number to refer to the file.

Parameters


   FTSIZE      is the maximum number of SPK files that may
               be loaded simultaneously under any circumstances.
               FTSIZE is currently set to match the maximum number
               of DAF files that may be loaded simultaneously.

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) Load a planetary ephemeris SPK; then look up a series of
      geometric states of the Earth relative to the solar system
      barycenter, referenced to the J2000 frame.

      Use the SPK kernel below to load the required ephemerides
      for the Earth and the Earth Barycenter relative to the solar
      system barycenter.

         de405.bsp


      Example code begins here.


      function spklef_ex1()

         %
         % Local constants.
         %
         MAXITR   = 5;
         ET0      = -315576000.0;
         STEP     = 3600.0;

         ABCORR   = 'NONE';
         FRAME    = 'J2000';
         OBSERVER = 'SOLAR SYSTEM BARYCENTER';
         SPK      = 'de405.bsp';
         TARGET   = 'EARTH';

         %
         % Load the SPK file.
         %
         [handle] = cspice_spklef( SPK );

         %
         % Step through a series of epochs, looking up a state vector
         % at each one.
         %
         for i=0:MAXITR-1

            et =  ET0 + i*STEP;

            [state, lt] = cspice_spkezr( TARGET,  et,     ...
                                         FRAME,   ABCORR, ...
                                         OBSERVER         );

            fprintf( '\n' )
            fprintf( 'et = %20.10f\n', et )
            fprintf( '\n' )
            fprintf( 'J2000 x-position (km):   %20.10f\n', state(1) )
            fprintf( 'J2000 y-position (km):   %20.10f\n', state(2) )
            fprintf( 'J2000 z-position (km):   %20.10f\n', state(3) )
            fprintf( 'J2000 x-velocity (km/s): %20.10f\n', state(4) )
            fprintf( 'J2000 y-velocity (km/s): %20.10f\n', state(5) )
            fprintf( 'J2000 z-velocity (km/s): %20.10f\n', state(6) )
            fprintf( '\n' )

         end

         %
         % Unload the SPK kernel. This isn't necessary in a stand-
         % alone program, but it's good practice in functions
         % because it frees program and system resources.
         %
         cspice_spkuef( handle );


      When this program was executed on a Mac/Intel/Octave6.x/64-bit
      platform, the output was:


      et = -315576000.0000000000

      J2000 x-position (km):   -26772058.9514643848
      J2000 y-position (km):   132760135.1677220613
      J2000 z-position (km):    57557579.2735445350
      J2000 x-velocity (km/s):       -29.7772753957
      J2000 y-velocity (km/s):        -5.0656884328
      J2000 z-velocity (km/s):        -2.1979102802


      et = -315572400.0000000000

      J2000 x-position (km):   -26879249.7439419106
      J2000 y-position (km):   132741862.7243705541
      J2000 z-position (km):    57549651.2066062242
      J2000 x-velocity (km/s):       -29.7731620671
      J2000 y-velocity (km/s):        -5.0856683968
      J2000 z-velocity (km/s):        -2.2065710777


      et = -315568800.0000000000

      J2000 x-position (km):   -26986425.6981768459
      J2000 y-position (km):   132723518.3595090210
      J2000 z-position (km):    57541691.9637668282
      J2000 x-velocity (km/s):       -29.7690319295
      J2000 y-velocity (km/s):        -5.1056448242
      J2000 z-velocity (km/s):        -2.2152302239


      et = -315565200.0000000000

      J2000 x-position (km):   -27093586.7536762133
      J2000 y-position (km):   132705102.0859030634
      J2000 z-position (km):    57533701.5509854183
      J2000 x-velocity (km/s):       -29.7648849936
      J2000 y-velocity (km/s):        -5.1256176961
      J2000 z-velocity (km/s):        -2.2238877108


      et = -315561600.0000000000

      J2000 x-position (km):   -27200732.8499865979
      J2000 y-position (km):   132686613.9163857996
      J2000 z-position (km):    57525679.9742503539
      J2000 x-velocity (km/s):       -29.7607212708
      J2000 y-velocity (km/s):        -5.1455869940
      J2000 z-velocity (km/s):        -2.2325435301


Particulars


   Loading an SPK file makes the file's data accessible to the Mice
   SPK readers cspice_spkezr and cspice_spkez.

   The maximum number of SPK files that may be loaded at any time is
   given by the parameter FTSIZE. After this limit it reached, it is
   necessary to unload an SPK file before another can be loaded. The
   function cspice_spkuef is provided to unload files from the SPK system.

Exceptions


   1)  If an attempt is made to open more DAF files than is specified by the
       parameter FTSIZE in the DAF subsystem, an error is signaled by a
       routine in the call tree of this routine.

   2)  If an attempt is made to load more files than is specified by
       the local parameter FTSIZE, and if the DAF system has room to
       load another file, the error SPICE(SPKFILETABLEFULL) is
       signaled by a routine in the call tree of this routine. The
       current setting of FTSIZE does not allow this situation to
       arise: the DAF system will trap the error before this routine
       has the chance.

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

   4)  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


   A file specified by `fname', to be loaded. The file is assigned a
   handle by cspice_spklef, which will be used by most other routines to
   refer to it.

Restrictions


   None.

Required_Reading


   MICE.REQ
   SPK.REQ

Literature_References


   None.

Author_and_Institution


   J. Diaz del Rio     (ODC Space)

Version


   -Mice Version 1.0.0, 26-AUG-2021 (JDR)

Index_Entries


   load SPK ephemeris file


Fri Dec 31 18:44:27 2021