Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: general/spice/

Contents

.pro files

naif_file_source.pro
q_angular_velocity.pro

Function: q_angular_velocity av = q_angular_velocity(t,q)Purpose: Computer angular velocity of a rotation quaternionReference: http://www.euclideanspace.com/physics/kinematics/angularvelocity/QuaternionDifferentiation2.pdf Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

qderiv.pro

Function: qderiv gets derivative of quaternion - assumes sign ambiguity has been fixedPurpose: ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

spice_body_att.pro

Function: spice_body_attPurpose: 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: $

spice_body_pos.pro

Function: SPICE_BODY_POSPurpose: Returns the position of an object relative to an observer.

spice_body_vel.pro

Function: SPICE_BODY_POSPurpose: Returns the position of an object relative to an observer.

spice_crib.pro

Program: SPICE_CRIBPurpose: This crib sheet is currently for testing/demonstration purposes only ;Usage: .run spice_crib Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

spice_file_source.pro

NAME: spice_file_sourcePURPOSE: Provides a structure that contains information pertinent to the locaton (and downloading) of SPICE data filesCALLING 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.

spice_get_ck_coverage.pro
spice_install.pro

program: SPICE_INSTALLPurpose: Installs SPICE dlm and binary object modules.

spice_kernel_info.pro

Function: spice_kernel_infoPurpose: returns info on all load spice kernelsKeywords: None Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

spice_kernel_load.pro
spice_m2q.pro

Function: spice_m2qPurpose: 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: $

spice_position_to_tplot.pro

procedure: spice_position_to_tplotUsage: object= 'Earth' Observer='Sun' spice_postion_to_tplot,object,observer,frame=frame,Purpose: ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

spice_qrot_to_tplot.pro

Procedure: spice_qrot_to_tplot,from_frame,to_framePurpose: Obtains a unit (rotation) quaternion that can be used to rotate from one frame to anotherPurpose: ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

spice_standard_kernels.pro

NAME: SPICE_STANDARD_KERNELsUSAGE: files = spice_standard_kernels(/load)PURPOSE: Provides fully resolved standard spice kernel filenames.

spice_test.pro

Function: spice_testPurpose: Tests whether the SPICE (idl/icy) module is installed Provides installation message if not installedKeywords: VERBOSE (see "DPRINT")Returns: 1 on success; 0 on failureExample: if(spice_test() eq 0) then returnNotes: Should be called in all idl spice wrapper routinessee also: "SPICE_INSTALL" "SPICE_STANDARD_KERNELS" "SPICE_CRIB" Author: Davin Larson (based on icy_test.pro by Peter S.) $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

spice_valid_times.pro

Function:Purpose: ; Author: Davin Larson $LastChangedBy: $ $LastChangedDate: $ $LastChangedRevision: $ $URL: $

spice_vector_rotate.pro

Function: SPICE_VECTOR_ROTATEPurpose: Rotate a vector from one frame to another frameUsage: 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 FRAMEOutput: 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: $

spice_vector_rotate_tplot.pro

Procedure: SPICE_VECTOR_ROTATE_TPLOTPurpose: TPLOT wrapper routine for the function SPICE_VECTOR_ROTATEUsage: SPICE_VECTOR_ROTATE_TPLOT,TPLOTNAME,TO_FRAMEInputs: TPLOTNAME: string(s) - valid tplot name(s) TO_FRAME: string or id - valid SPICE FRAMEOutput: 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: $

time_ephemeris.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 loadedAuthor: Davin Larson