This page was created by the IDL library routine
mk_html_help2.
Last modified: Fri Sep 19 14:20:01 2014.
Function: qderiv gets derivative of quaternion - assumes sign ambiguity has been fixed Purpose: ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/qderiv.pro)
Function: q_angular_velocity av = q_angular_velocity(t,q) Purpose: Computer angular velocity of a rotation quaternion Reference: http://www.euclideanspace.com/physics/kinematics/angularvelocity/QuaternionDifferentiation2.pdf Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/q_angular_velocity.pro)
Function: spice_body_att Purpose: retrieve the rotation (array or quaternion) to transfer from one frame to another frame Note: time is in the last dimension (not like tplot storage) ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/spice_body_att.pro)
Function: SPICE_BODY_POS Purpose: Returns the position of an object relative to an observer. This is a wrapper to the cspice routine: CSPICE_SPKPOS Keywords: check_objects: frame or body name that the routine will check for valid times to prevent crashing. Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/spice_body_pos.pro)
Program: SPICE_CRIB
Purpose: This crib sheet is currently for testing/demonstration purposes only ;
Usage:
.run spice_crib
Author: Davin Larson
$LastChangedBy: $
$LastChangedDate: $
$LastChangedRevision: $
$URL: $
(See general/spice/spice_crib.pro)
NAME: spice_file_source PURPOSE: Provides a structure that contains information pertinent to the locaton (and downloading) of SPICE data files CALLING SEQUENCE: source=spice_file_source() TYPICAL USAGE: pathname = 'MAVEN/kernels/sclk/MVN_SCLKSCET.?????.tsc'' sclk_kernel = file_retrieve(pathname,_extra = spice_file_source() ,/last_version) INPUT: None required. If default_source is provided then the relevant structure elements are copied and used in the output KEYWORDS: SET : If set, then the values in DEFAULT_SOURCE are made permanent. OUTPUT: Structure: see FILE_RETRIEVE for a description of the elements $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/spice_file_source.pro)
program: SPICE_INSTALL Purpose: Installs SPICE dlm and binary object modules. Note: This routine has not been tested on all platforms. (But should be safe) Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/spice_install.pro)
Function: spice_kernel_info
Purpose: returns info on all load spice kernels
Keywords:
None
Author: Davin Larson
$LastChangedBy: $
$LastChangedDate: $
$LastChangedRevision: $
$URL: $
(See general/spice/spice_kernel_info.pro)
Function: SPICE_BOD2S
Purpose: returns true name (string) of a body given either the CODE or an alias string
usage:
name = spice_bod2s(-202)
name = spice_bod2s('MAVEN_SC_BUS') ; name set to 'MAVEN_SPACECRAFT'
(See general/spice/spice_kernel_load.pro)
Function: spice_m2q Purpose: Convert rotation matrix (matrices) to quaternion(s) Note: time is in the last dimension (not like tplot storage) ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/spice_m2q.pro)
procedure: spice_position_to_tplot Usage: object= 'Earth' Observer='Sun' spice_postion_to_tplot,object,observer,frame=frame, Purpose: ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/spice_position_to_tplot.pro)
Procedure: spice_qrot_to_tplot,from_frame,to_frame Purpose: Obtains a unit (rotation) quaternion that can be used to rotate from one frame to another Purpose: ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/spice_qrot_to_tplot.pro)
NAME: SPICE_STANDARD_KERNELs
USAGE: files = spice_standard_kernels(/load)
PURPOSE:
Provides fully resolved standard spice kernel filenames. files are downloaded if needed.
NOTE: this routine is in development still.
NAIF specifies a few "standard" files that must typically be loaded in before for any calculations can be performed. These are:
Leap second kernel: (naif????.tls) Contains times of leap seconds. ???? contains the version number and increments by 1 with every new leap second.
PCK kernel: (pck?????.tpc) Contains spin axis and size of most solar system bodies.
SPK kernel: (de???.bsp) Contains ephemeris data for the planets. Mars (499) is NOT included in most recent version!
The file names and locations (and even contents) of these kernels is not standard and will change with each new release.
KEYWORDS:
MARS:
CALLING SEQUENCE:
files=spice_standard_kernels(/load)
TYPICAL USAGE:
INPUT:
none
KEYWORDS:
LOAD: Set keyword to retrieve and load file
OUTPUT:
fully qualified kernel filename(s)
$LastChangedBy: $
$LastChangedDate: $
$LastChangedRevision: $
$URL: $
(See general/spice/spice_standard_kernels.pro)
Function: spice_test
Purpose: Tests whether the SPICE (idl/icy) module is installed
Provides installation message if not installed
Keywords:
VERBOSE (see "DPRINT")
Returns: 1 on success; 0 on failure
Example:
if(spice_test() eq 0) then return
Notes:
Should be called in all idl spice wrapper routines
see also:
"SPICE_INSTALL"
"SPICE_STANDARD_KERNELS"
"SPICE_CRIB"
Author: Davin Larson (based on icy_test.pro by Peter S.)
$LastChangedBy: $
$LastChangedDate: $
$LastChangedRevision: $
$URL: $
(See general/spice/spice_test.pro)
Function: Purpose: ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $
(See general/spice/spice_valid_times.pro)
Function: SPICE_VECTOR_ROTATE
Purpose: Rotate a vector from one frame to another frame
Usage: vector_prime = spice_vector_rotate(vector,ut,from_frame,to_frame, check_objects='Frame')
Inputs: VECTOR: 3xN array
UT: N array of unix times
FROM_FRAME: String or id - valid SPICE FRAME
TO_FRAME: string or id - valid SPICE FRAME
Output: VECTOR_PRIME: 3xN array - vector as measured in the TO_FRAME
Note: time is in the last dimension (not like tplot storage)
Author: Davin Larson
$LastChangedBy: $
$LastChangedDate: $
$LastChangedRevision: $
$URL: $
(See general/spice/spice_vector_rotate.pro)
Procedure: SPICE_VECTOR_ROTATE_TPLOT
Purpose: TPLOT wrapper routine for the function SPICE_VECTOR_ROTATE
Usage: SPICE_VECTOR_ROTATE_TPLOT,TPLOTNAME,TO_FRAME
Inputs: TPLOTNAME: string(s) - valid tplot name(s)
TO_FRAME: string or id - valid SPICE FRAME
Output: VECTOR_PRIME: 3xN array - vector as measured in the TO_FRAME
Note: time is in the last dimension (not like tplot storage)
Author: Davin Larson
$LastChangedBy: $
$LastChangedDate: $
$LastChangedRevision: $
$URL: $
(See general/spice/spice_vector_rotate_tplot.pro)
function: time_ephemeris(t) Purpose: conversion between unix time and ephemeris time Usage: et = time_ephemeris(ut) ; Converts from UT (unix/posix time) to ephemeris time Or: ut = time_ephemeris(et,/et2ut) ; Converts from ephemeris time to UT double precision (UNIX time) Does NOT require the ICY DLM to be loaded Author: Davin Larson
(See general/spice/time_ephemeris.pro)