Table of contents
CSPICE_DSKI02 fetches integer data from a type 2 DSK segment.
Given:
handle the handle of a DSK file containing a type 2 segment
from which data are to be fetched.
[1,1] = size(handle); int32 = class(handle)
dladsc the DLA descriptor associated with the segment from
which data are to be fetched.
[SPICE_DLA_DSCSIZ,1] = size(dladsc)
int32 = class(dladsc)
item an integer "keyword" parameter designating the integer
data item to fetch.
[1,1] = size(item); int32 = class(item)
Names, values, and meanings of keyword parameters
supported by this routine are shown below.
Use of the names shown here is enabled by calling
the MiceDSK parameter definition routine as shown:
MiceDSK
This call must be made before the parameter names
are referenced. See the example program below.
Name Value Description
---- ----- ----------
SPICE_DSK02_KWNV 1 Number of vertices in model.
SPICE_DSK02_KWNP 2 Number of plates in model.
SPICE_DSK02_KWNVXT 3 Total number of voxels in fine
grid.
SPICE_DSK02_KWVGRX 4 Voxel grid extent. This extent is
an array of three integers
indicating the number of
voxels in the X, Y, and Z
directions in the fine voxel
grid.
SPICE_DSK02_KWCGSC 5 Coarse voxel grid scale. The
extent of the fine voxel grid is
related to the extent of the
coarse voxel grid by this scale
factor.
SPICE_DSK02_KWVXPS 6 Size of the voxel-to-plate
pointer list.
SPICE_DSK02_KWVXLS 7 Voxel-plate correspondence list
size.
SPICE_DSK02_KWVTLS 8 Vertex-plate correspondence list
size.
SPICE_DSK02_KWPLAT 9 Plate array. For each plate, this
array contains the indices of the
plate's three vertices. The
ordering of the array members is:
Plate 1 vertex index 1
Plate 1 vertex index 2
Plate 1 vertex index 3
Plate 2 vertex index 1
...
The vertex indices in this
array start at 1 and end at
NV, the number of vertices
in the model.
SPICE_DSK02_KWVXPT 10 Voxel-plate pointer list. This
list contains pointers that map
fine voxels to lists of plates
that intersect those voxels. Note
that only fine voxels belonging
to non-empty coarse voxels are in
the domain of this mapping.
SPICE_DSK02_KWVXPL 11 Voxel-plate correspondence list.
This list contains lists of
plates that intersect fine
voxels. (This list is the data
structure into which the
voxel-to-plate pointers point.)
This list can contain empty
lists. Plate IDs in this list
start at 1 and end at NP, the
number of plates in the model.
SPICE_DSK02_KWVTPT 12 Vertex-plate pointer list. This
list contains pointers that map
vertices to lists of plates to
which those vertices belong.
Note that the size of this list
is always NV, the number of
vertices. Hence there's no need
for a separate keyword for the
size of this list.
SPICE_DSK02_KWVTPL 13 Vertex-plate correspondence list.
This list contains, for each
vertex, the indices of the plates
to which that vertex belongs.
Plate IDs in this list start at 1
and end at NP, the number of
plates in the model.
SPICE_DSK02_KWCGPT 14 Coarse voxel grid pointers. This
is an array of pointers mapping
coarse voxels to lists of
pointers in the voxel-plate
pointer list. Each non-empty
coarse voxel maps to a list of
pointers; every fine voxel
contained in a non-empty coarse
voxel has its own pointers. Grid
elements corresponding to empty
coarse voxels contain
non-positive values.
start the start index within specified data item from which
data are to be fetched.
[1,1] = size(start); int32 = class(start)
The index of the first element of each data item is 1.
This convention applies uniformly to all data. For example,
the plate ID range starts at 1 (this fact is
language-independent), but a caller would use a `start'
value of 1 to fetch the vertex indices of the first plate.
room the amount of room in the output array.
[1,1] = size(room); int32 = class(room)
It is permissible to provide an output array that has too
little room to fetch an item in one call. `room' has units of
integers: for example, the room required to fetch one plate
is 3.
the call:
[values] = cspice_dski02( handle, dladsc, item, start, room )
returns:
values a contiguous set of elements of the item designated by
`item'.
[1,n] = size(values); int32 = class(values)
The correspondence of `values' with the elements of the data
item is:
values(1) item(start)
... ...
values(n) item(start+n-1)
If an error occurs on the call, `values' is undefined.
Note, room >= n.
See the parameter definitions file
MiceDLA.m
for declarations of DLA descriptor sizes and documentation of the
contents of DLA descriptors.
See the parameter definitions file
MiceDSK.m
for declarations of DSK descriptor sizes and documentation of the
contents of DSK descriptors.
See the parameter definitions file
MiceDSK.m
for declarations of DSK data type 2 (plate model) parameters.
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) Look up all the vertices associated with each plate
of the model contained in a specified type 2 segment.
For the first 5 plates, display the plate's vertices.
For this example, we'll show the context of this look-up:
opening the DSK file for read access, traversing a trivial,
one-segment list to obtain the segment of interest.
Example code begins here.
function dski02_ex1( )
%
% MiceUser globally defines DSK parameters.
% For more information, please see MiceDSK.m.
%
MiceUser
%
% Set the dimensions of the array `vrtces', which
% will be used later.
%
vrtces = zeros(3,3);
%
% 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, treating the file as a DLA.
% In this example, it's a very short
% search.
%
[dladsc, found] = cspice_dlabfs( handle );
if ~found
%
% We arrive here only if the kernel
% contains no segments. This is
% unexpected, but we're prepared for it.
%
fprintf( 'No segments found in DSK file %s\n', fname )
return
end
%
% If we made it this far, `dladsc' is the
% DLA descriptor of the first segment.
%
%
% Find the number of plates in the model.
%
ival = cspice_dski02( handle, dladsc, SPICE_DSK02_KWNP, 1, 1 );
fprintf( 'Number of plates: %d\n', ival(1));
%
% For the first 5 plates, look up the desired data.
% Note that plate numbers range from 1 to np.
%
np = min(ival(1), 5);
for i = 1:np
%
% For the Ith plate, find the associated
% vertex IDs. We must take into account
% the fact that each plate has three
% vertices when we compute the start
% index.
%
start = 3*(i-1) + 1;
%
% Fetch the ith plate.
%
vrtids = cspice_dski02( handle, dladsc, SPICE_DSK02_KWPLAT, ...
start, 3 );
for j = 1:3
%
% Fetch the jth vertex of the ith plate.
%
start = (vrtids(j)-1) * 3 +1;
vtemp = cspice_dskd02( handle, dladsc, SPICE_DSK02_KWVERT, ...
start, 3 );
vrtces(j,:) = vtemp;
end
%
% Display the vertices of the ith plate:
%
fprintf( '\n' )
fprintf( 'Plate number: %d\n', i )
for j = 1:3
fprintf( 'Vertex %d: (%14.6e %14.6e %14.6e)\n', ...
j, vrtces(j,:) )
end
end
%
% Close the DSK.
%
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 plates: 3145728
Plate number: 1
Vertex 1: ( -6.774440e+00 6.268150e+00 6.011490e+00)
Vertex 2: ( -6.762380e+00 6.257280e+00 6.025560e+00)
Vertex 3: ( -6.757100e+00 6.277540e+00 6.020960e+00)
Plate number: 2
Vertex 1: ( -6.774440e+00 6.268150e+00 6.011490e+00)
Vertex 2: ( -6.779730e+00 6.247900e+00 6.016100e+00)
Vertex 3: ( -6.762380e+00 6.257280e+00 6.025560e+00)
Plate number: 3
Vertex 1: ( -6.779730e+00 6.247900e+00 6.016100e+00)
Vertex 2: ( -6.767680e+00 6.237010e+00 6.030190e+00)
Vertex 3: ( -6.762380e+00 6.257280e+00 6.025560e+00)
Plate number: 4
Vertex 1: ( -6.779730e+00 6.247900e+00 6.016100e+00)
Vertex 2: ( -6.784990e+00 6.227620e+00 6.020700e+00)
Vertex 3: ( -6.767680e+00 6.237010e+00 6.030190e+00)
Plate number: 5
Vertex 1: ( -6.784990e+00 6.227620e+00 6.020700e+00)
Vertex 2: ( -6.772990e+00 6.216740e+00 6.034820e+00)
Vertex 3: ( -6.767680e+00 6.237010e+00 6.030190e+00)
Most user applications will not need to call this routine. The
routines
cspice_dskz02
cspice_dskp02
cspice_dskv02
have simpler interfaces and may be used to fetch the plates
and vertex counts, and the plates and vertices themselves,
from a type DSK segment. See the documentation of those
routines for code examples.
DSK files are built using the DLA low-level format and
the DAS architecture; DLA files are a specialized type of DAS
file in which data are organized as a doubly linked list of
segments. Each segment's data belong to contiguous components of
character, double precision, and integer type.
Note that the DSK descriptor for the segment is not needed by this
routine; the DLA descriptor contains the base address and size
information for the integer, double precision, and character
components of the segment, and these suffice for the purpose of
fetching data.
1) If the input handle is invalid, an error is signaled by a
routine in the call tree of this routine.
2) If a file read error occurs, the error is signaled by a
routine in the call tree of this routine.
3) If the input DLA descriptor is invalid, the effect of this
routine is undefined. The error *may* be diagnosed by
routines in the call tree of this routine, but there are no
guarantees.
4) If `room' is non-positive, the error SPICE(VALUEOUTOFRANGE)
is signaled by a routine in the call tree of this routine.
5) If the coarse voxel scale read from the designated segment is
less than 1, the error SPICE(VALUEOUTOFRANGE) is signaled by a
routine in the call tree of this routine.
6) If the input keyword parameter is not recognized, the error
SPICE(NOTSUPPORTED) is signaled by a routine in the call tree
of this routine.
7) If `start' is less than 1 or greater than the size of the
item to be fetched, the error SPICE(INDEXOUTOFRANGE) is
signaled by a routine in the call tree of this routine.
8) If any of the input arguments, `handle', `dladsc', `item',
`start' or `room', is undefined, an error is signaled by the
Matlab error handling system.
9) If any of the input arguments, `handle', `dladsc', `item',
`start' or `room', is not of the expected type, or it does not
have the expected dimensions and size, an error is signaled by
the Mice interface.
See input argument `handle'.
1) This routine uses discovery check-in to boost
execution speed. However, this routine is in
violation of NAIF standards for use of discovery
check-in: routines called from this routine may
signal errors. If errors are signaled in called
routines, this routine's name will be missing
from the traceback message.
DAS.REQ
DSK.REQ
MICE.REQ
None.
N.J. Bachman (JPL)
J. Diaz del Rio (ODC Space)
E.D. Wright (JPL)
-Mice Version 1.1.0, 26-NOV-2021 (EDW) (JDR)
Edited the -Examples section to comply with NAIF standard. Updated
code example to prompt for the input DSK file and reduce the
number of plates whose vertices are shown on output.
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.0, 28-NOV-2016 (NJB) (EDW)
fetch integer data from a type 2 DSK segment
|