NAME

HiCal

Generate radiometrically corrected HiRISE Channel products in directory: $HiRISE_ROOT/Data/HiCal

SYNOPSIS

HiCal -File <pathname> -Catalog <catalog> -Id <Unique_Id> -Configuration <conf_file>

-File <pathname>

The full pathname of the ISIS cube file containing a raw HiRISE channel image

-Configuration <conf_file>

Specify the name of the configuration file such as HiCal.conf. If this is not specified then the default is $HiRISE_ROOT/Configuration/HiCal/HiCal.conf

-Catalog <catalog>

Specify the catalog to use (default HiCat). The HiCal pipeline extrats information from the EDR_Products, Planned_Observations, and Planned_CCD_Parameters tables.

-Id <Unique_Id>

Unique Id given to temporary files located in the /tmp directory.

DESCRIPTION

HiCal is the pipeline subsystem for generating radiometrically corrected HiRISE images. The input is a raw HiRISE channel image. The output will be a radiometrically corrected channel image.

This procedure continues to go through considerable evolution as the instrument calibration procedures are improved.

Environment Variables

HiCal expects the HiRISE_ROOT environment variable specifying the root directory of the HiRISE directory tree. HiCal terminates if this environment variable does not exist.

Configuration file

HiCal must have a configuration file. It can be optionaly specified with the -Configruation parameter. HiCal adds the output file name to the next pipeline in the sequence. If not specified in the command line, HiCal looks for the file $HiRISE_ROOT/Configuration/HiCal/HiCal.conf. If the configuration file can not be found then HiCal will terminate.

Refer to HiCal.conf file for details on the description of the configuration parameters used by HiCal.

Please note:

Because the HiCal pipeline uses ISIS, its peferences file should be set for pipeline processing.

 Group=UserInterface
   HistoryPath        = $PWD
   HistoryRecording   = Off
 EndGroup

 Group = SessionLog
  TerminalOutput = On
  FileOutput     = Off
 EndGroup


 Group=ErrorFacility
  FileLine = on
  Format = PVL
 EndGroup

Return Codes

The following codes are returned by HiCal:

   0;   # Success value
   1;   # Command line error parameter
   2;   # Input list file does not exist
   3;   # Input Cube file(s) do not exit
   4;   # Could not create a directory
   5;   # ISIS processing error
   6;   # configuration file does not exists
   7;   # configuration parameter not found
   8;   # Data_Location failed
   9;   # Environment variable not set
   10;  # Can't make entry to next pipeline
   11;  # Can not delete a file
   12;  # File does not exist
   13;  # Version number in catalog and ISIS file do not match
   14;  # UpdateExtrasProducts fails
   15;  # Error returned from CubeNorm
   16;  # Database error
   17;  # External program failed

Author

Eric Eliason UA/LPL Richard Leis UA/LPL Audrie Fennema UA/LPL

Copyright

Copyright (C) 2004-2020 Arizona Board of Regents on behalf of the Lunar and Planetary Laboratory at the University of Arizona. Copyright 2020 Ross A. Beyer, SETI Institute

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Version

1.71 2022/09/07 22:29:03