Table of contents
CSPICE_EKOPR opens an existing E-kernel file for reading.
Given:
fname the name of an existing E-kernel file to be opened for read
access.
help, fname
STRING = Scalar
the call:
cspice_ekopr, fname, handle
returns:
handle the EK file handle of the file designated by `fname'.
help, handle
LONG = Scalar
This handle is used to identify the file to other EK routines.
SPICE_DAS_FTSIZE
is the maximum number of DAS files that a user can
have open simultaneously. This includes any files used
by the DAS system.
See the parameter definitions file IcyDAS.pro for the actual
value of this parameter.
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) Open an EK for read access and find the number of segments in
it.
Use the EK kernel below as test input file for loading the
experiment database. This kernel contains the Deep
Impact spacecraft sequence data based on the integrated
Predicted Events File covering the whole primary mission,
split into two segments.
dif_seq_050112_050729.bes
Example code begins here.
PRO ekopr_ex1
;;
;; Open the EK file, returning the file handle
;; associated with the open file to the variable named
;; `handle'.
;;
cspice_ekopr, 'dif_seq_050112_050729.bes', handle
;;
;; Return the number of segments in the EK.
;;
nseg = cspice_eknseg( handle )
print, format='(A,I3)', 'Number of segments =', nseg
;;
;; Close the file.
;;
cspice_ekcls, handle
END
When this program was executed on a Mac/Intel/IDL8.x/64-bit
platform, the output was:
Number of segments = 2
This routine should be used to open an EK file for read access.
EKs opened for read access may not be modified.
Opening an EK file with this routine makes the EK accessible to
the Icy EK readers
cspice_ekrcec
cspice_ekrced
cspice_ekrcei
all of which expect an EK file handle as an input argument. These
readers allow a caller to read individual EK column entries.
To make an EK available to the EK query system, the file must be
loaded via cspice_eklef, rather than by this routine. See the EK
Required Reading for further information.
1) If the indicated file cannot be opened, an error is signaled
by a routine in the call tree of this routine.
2) If the indicated file has the wrong architecture version, an
error is signaled by a routine in the call tree of this
routine.
3) If an i/o error occurs while reading the indicated file, the
error is signaled by a routine in the call tree of this
routine.
4) If the input argument `fname' is undefined, an error is
signaled by the IDL error handling system.
5) 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 Icy interface.
6) If the output argument `handle' is not a named variable, an
error is signaled by the Icy interface.
See the EK Required Reading ek.req for a discussion of the EK file
format.
1) No more than SPICE_DAS_FTSIZE DAS files may be opened simultaneously.
See the parameter definitions file IcyDAS.pro for the value of
SPICE_DAS_FTSIZE.
EK.REQ
ICY.REQ
None.
J. Diaz del Rio (ODC Space)
E.D. Wright (JPL)
-Icy Version 1.0.2, 10-AUG-2021 (JDR)
Edited the header to comply with NAIF standard. Updated the -Abstract
section to remove a paragraph that belongs in the -Particulars section.
Added complete code example.
Added -Parameters, -Exceptions, -Files, -Restrictions,
-Literature_References and -Author_and_Institution sections, and
completed -Particulars section.
Removed reference to the routine's corresponding CSPICE header from
-Abstract section.
Added arguments' type and size information in the -I/O section.
-Icy Version 1.0.1, 09-DEC-2005 (EDW)
Added -Examples section.
-Icy Version 1.0.0, 16-JUN-2003 (EDW)
open EK for reading
|