NAME

HiStitch

Stitch together two HiRISE channel files to create a single CCD image file. The resulting file goes into the directory tree $HiRISE_ROOT/Data/HiStitch


SYNOPSIS

HiStitch -File <pathname> -Cat <catalog> -Configuration <conf_file> -Id <Unique_Id>

-File <pathname>

The full pathname of *.histitch.pvl file that contains a list of the two channel files used to create a stitched CCD image.

-Catalog <catalog>

The HiRISE catalog system (default: HiCat)

-Configuration <conf_file>

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

-Id <Unique_id>

Optional specification used to uniquely identify temporary working files created in the /tmp directory.


DESCRIPTION

HiStitch is the pipeline subsystem for generating a HiRISE CCD image file from two radiometrically corrected channel files. The pipeline also does a furrow normalization for the high image-average CCD products.

The file passed to the pipeline (*.histitch.pvl) contains the file names of the two files used to constructed the CCD product. If the *.histitch.pvl file is not found then the script will terminate with an error.

The script uses the ISIS program "histitch" to put together the channel files to form a HiRISE CCD image file.

Environment Variables

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

Configuration file

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

See the HiStitch.conf file for details on the configuration parameters for this pipeline.

Please note:

Because the HiStitch 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 HiStitch:

 0;  # Success value
 1;  # Command line error parameter
 2;  # Can not create a directory file
 3;  # Can not create subdirectory specifation with Data_Location
 4;  # Something wrong with the *.histitch.pvl file
 5;  # First input file does not exist
 6;  # Second input file does not exist
 7;  # ISIS histitch failure
 8;  # HiRISE_ROOT environment variable not defined
 9;  # Error in configuration parameter
 10; # Error in ISIS reduce program
 11; # Error in Isis2jpeg script
 12; # Can not delete the lockfile
 14; # Problem with a statistics file
 15; # Error in ISIS algebra program
 16; # Can not delete the channel 1 balance file
 17; # Can not delete a file
 18; # Error in ISIS lowpass program
 19; # Error in ISIS enlarge program
 20; # Error in HiFurrow_Fix


Author

Eric Eliason UA/LPL


Copyright

Copyright(C) 2016 Arizona Board of Regents on behalf of the Lunar and Planetary Laboratory at the University of Arizona.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


Version

1.23 2016/08/04 21:10:52