NAME

HiccdStitch

Stitch together the same HiRISE color-filter CCDs from an observation to create a single mosaicked image file. The mosaicked CCD file goes into the directory tree $HiRISE_ROOT/Data/

SYNOPSIS

HiccdStitch [-File <pathname> -Configuration <conf_file> -cat <catalog> -Id <Unique_Id>]

OPTIONS

-File <pathname>

The full pathname of the *.hiccdstitch.pvl

-Configuration <conf_file>

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

-catalog <catalog>

Specify the name of the HiRISE catalog. If none specified then HiRISE is used.

-Id <Unique_Id>

Optionally specify a unique ID for temporary file names created in the /tmp files.

DESCRIPTION

Stitch together the same HiRISE color-filter CCDs from an observation to create a single mosaicked image file. The ISIS mosaicked CCD file goes into the directory tree $HiRISE_ROOT/Data/HiccdStitch/...

The Jpeg2000, browse, and thumbnail products go into the directory tree $HiRISE_ROOT/Data/Extras/RDR/...

The file passed to the pipeline (*.hiccdstitch.pvl) contains a list of ISIS file names used to create the mosaicked CCD product. The file contains PVL keywords that specifies if the cubenorm processing is to occur (Cubnorm_Option) and a Cubenorm training area (Start_Line, End_Line). The Porduct_File parameters identifies the channel filest to stitch together.

If the *.hiccdstitch.pvl file is not found then the script will terminate with an error.

The script uses the ISIS program "hiccdstitch" for mosaicking the CCDs together. See the ISIS documentation for details.

The pipeline is trained to see if an existing "shiftdef" file (with extenstion .hiccdstitch.def) is located in the directory tree. This enables the hiccdstitch program to use a shiftdef file if one was previously created in prior processing.

Environment Variables

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

Configuration file

HiccdStitch must have a configuration file. It can be optionally specified with the -Configruation parameter. HiccdStitch adds the output file name to the next pipeline in the sequence. If not specified in the command line, HiccdStitch looks for the file $HiRISE_ROOT/Configuration/HiccdStitch/HiccdStitch.conf. Consult the configuration file for details.

Please note:

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

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 *.HiccdStitch.pvl file
5;  # File does not exists
6;  # Can not delete file
7;  # ISIS program 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; # Error in ISIS crop program
13; # Error in Isis2jp2 script
14; # Can not delete the lockfile
15; # Problem with accessing a ISIS cube file
16; # Problem with crop program
17; # Problem with stats program
18; # Problem with algebra program
19; # Problem with perl copy function

Author

Eric Eliason UA/LPL

Copyright

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

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.54 2023/10/18 20:29:46