Home

User Documentation

Getting Started
Learn More
Explore in Detail
Get Inspired

Contributor Documentation

Getting Started
Learn More
Explore in Detail
Get Inspired

Quick Links

Software Manual
AstroDiscuss
GitHub
API Reference

Documentation Versions


ISIS 2

Documentation
Tutorials
Technical Documents
USGS

ISIS Application Documentation


spiceserver

Printer Friendly View | TOC | Home

Spiceinit Server

Overview Parameters

Description

This is the server-side program to handle spiceinit web requests. The input is the spiceinit program's hex-encoded message (POSTED to a web server). The output file is what needs to be sent back to the client. This program is generally run by a web server and not by hand. The script: "isis/src/base/apps/spiceserver/assets/spiceinit.cgi" is an example of a perl script wrapper for running a spice server and using this program.

Categories


History

Steven Lambright and Jai Rideout2011-09-02 Original Version
Debbie A. Cook2012-07-06 Updated Spice members to be more compliant with Isis coding standards. References #972.
Steven Lambright2012-09-05 Added parameter CHECKVERSION in order to increase the testability of this program.
Jeannie Backer2013-02-26 Added ability to load multiple ck database files from the system using a conf file. Changed methods to lower camel case and added "g_" prefix to global variables to comply with Isis3 standards. References #924.
Stuart Sides2013-07-11 Modified so the kernel quality parameters from XML are tested as case insensitive. This change was made in a branch of ISIS, but was not yet moved to the publice version yet.
Kimberly Oyama2014-04-28 Instead of opening $base/testdata/isisTruth.cub spiceserver now creates a cube from the label information that it receives from spiceinit. This change was made because the camera classes (Camera, CameraFactory, Sensor, Spice,...) now take a cube as input to their constructors instead of a pvl. The isisTruth.cub dimensions did not match the dimensions in the label (from spiceinit), causing spiceserver to return an incorrect end time for the spice information. Added TEMPFILE parameter for testing purposes. Fixes #2030.
Makayla Shepherd2015-09-08 Modified to open the temporary cube correctly. Fixes #2213.
Tyler Wilson2019-02-11 Modified the version check. Now all versions of ISIS3 >= 3.5.*.* will be acceptable to the application.
Adam Paquette2021-08-10 Removed commented out debugging code that should be run in SpiceClient/spiceinit.

Parameter Groups

Input Files

Name Description
FROM The input hex file POSTed by spiceinit
TO The output hex file to be sent back to spiceinit.

Options

Name Description
CHECKVERSION Verify the input hex-encoded file reports the same Isis version as the current version of Isis (requester's version matches server's version).
TEMPFILE Location of temp cube
X

Input Files: FROM


Description

This is the content of the request sent by spiceinit. It contains cube labels and parameters used for initializing naif kernels to get camera information. There is no personally identifiable information in this file.

Type filename
File Mode input
Filter *.dat
Close Window
X

Input Files: TO


Description

The output hex file which contains the necessary information for spiceinit to complete. This contains binary data with Isis compressed SPICE data, labels, and source file names.

Type filename
File Mode output
Filter *.dat
Close Window
X

Options: CHECKVERSION


Description

The input file (which comes from spiceinit's SpiceClient) contains the version of Isis that the requester is running. No guarantees can be made for the validity/usability of the results of the Isis versions of the client and server don't match. This option causes spiceserver to throw an error if the versions of Isis do not match.

Type boolean
Default true
Close Window
X

Options: TEMPFILE


Description

This parameter was added for testing purposes only. The spice server has access to the default location but the app tests will use their own output directory as the temp cube location.

Type filename
File Mode output
Default /tmp/spice_web_service/inputLabels.cub
Filter *.cub
Close Window