Commit fb442d35 authored by Adam Paquette's avatar Adam Paquette
Browse files

Fixed documentation errors in hicolormos. Fixes #4019.

git-svn-id: http://subversion.wr.usgs.gov/repos/prog/isis3/trunk@7051 41f8697f-d340-4b68-9986-7bafba869bb8
parent dfc3357e
Loading
Loading
Loading
Loading
+55 −42
Original line number Diff line number Diff line
@@ -2,33 +2,43 @@

<application name="hicolormos" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://isis.astrogeology.usgs.gov/Schemas/Application/application.xsd">
  <brief>
    Create a color mosaic of a HiRISE cubes from an observation and update labels required by hirdrgen.
    Create a color mosaic of HiRISE cubes and update labels (required by hirdrgen).
  </brief>

  <description>
  <p> 
  ** The output from this program is required by hirdrgen ** <br/>
  If the final product wil not be an RDR, mapmos or automos can be used to produce a mosaic.  
  This program produces a mosaic and adds keywords to the label group "Mosaic" that are required 
  by hirdrgen. <br/>
  This program, hicolormos, produces a mosaic and adds keywords to the "Mosaic" label group of an
  ISIS cube. You need only input a FROM1 parameter, a TO parameter, and select a PRIORITY. The
  FROM2 parameter is not required to run the hicolormos application. Although the new group
  called Mosaic is added, the OriginalLabel blob is also propagated from the FROM1 input file to
  the TO output file.<br/>
  <p>
    Here are a few points to keep in mind:
  </p>
  
  <ul>
    <li>
      The output from hicubeit  (used to stack individual CCDs into a multi band cube) is required as 
      input for hicolormos  and the output of hicolormos is used as input to hirdrgen.
    </li>
    <li>
      The  input cubes  to this program must be from the same observation,  stacked by hicubeit, and 
  map projected.<br/>
      map projected.
    </li>
    <li>
      The input file cannot be a RDR file or be the output file created by mapmos or automos.
    </li>
  </ul>
  
  the CCDs of the HiRISE instrument are arranged in a way that color products can only be produced in two 
  positions of the CCD array.  The CCDs that overlap for a color product are RED4, IR10, and
  BG12 or RED5, IR11, and BG13.  The program hicubeit is used to stack the individual CCDs into 
  a multi band cube.  The output from hicubeit is the required input for hicolormos.  The from1 and 
  from2 parameters allow these two CCD stacks to be input.  The program hicolormos can also be run 
  with only the from1 parameter.<br/>  

   A new label group, that is required by hirdrgen, called "Mosaic"  is added to the image labels of 
   the output cube.  The original label blob is also propagated from the from1 input file.
  The CCDs of the HiRISE instrument are arranged such that color products can only be produced in two 
  positions within the CCD array.  The CCDs that overlap for a color product are RED4, IR10, and
  BG12 or RED5, IR11, and BG13.  The data from two selected bands are input using the FROM1 and FROM2
  parameters.<br/>
  </p>

<p>
  <b> processing sequence for color products that will become RDRs </b><br/>
         <b>Slither</b> -  match the blue-green and/or the infer-red to the red CCD.<br/>
  Here is a quick look at the <b>Processing sequence</b> for color products that will become RDRs<br/>
         <b>slither</b> -  match the blue-green and/or the infered to the red CCD.<br/>
         <b>hicubeit</b> - stack the matching CCDs to make a three band cube.<br/>
         <b>cam2map</b> - project the cube.  hicolormos requiers a map projected cube.<br/>
         <b>hicolormos</b> - mosaic files and add keywords to the mosaic group.<br/>
@@ -42,10 +52,10 @@

  <history>
    <change name="Robert Sucharski" date="2006-07-19">
      Original version,
      Original version.
    </change>
    <change name="Elizabeth Miller" date="2007-02-20">
      Changed OriginalLabel name to IsisCube
      Changed OriginalLabel name to IsisCube.
    </change>
    <change name="Robert Sucharski" date="2007-04-12">
      Added keywords SubSolarAzimuth, NorthAzimuth, and SpecialProcessingFlag to mosaic group in output labels.
@@ -53,16 +63,19 @@
    <change name="Robert Sucharski" date="2007-06-26">
      Fixed a bug, needed to add traverse when looking for PVL group archive.
    </change>
    <change name="Rovert Sucharski" date="2007-10-18">
      Added code to get the avg line and sample for gathering camera infomation if using the avg latitude and longitude fails.
      We contine to use the latitude and logitude so that we are backwards compatible.  We added this new code because 
      the camera could not find an itersect for some images (polar) if we used projection latitude and longitude to "setGround".
    <change name="Robert Sucharski" date="2007-10-18">
      Added code to get the avg. line and sample for gathering camera infomation if using the avg latitude and longitude fails.
      We continue to use the latitude and longitude so that we are backwards compatible.  We added this new code because 
      the camera could not find an intersect for some images (polar) if we used projection latitude and longitude to "setGround".
     </change>
    <change name="Debbie A. Cook" date="2012-07-06">
       Updated Spice members to be more compliant with Isis coding standards. References #972.
    </change>
    <change name="Tracie Sucharski" date="2012-12-06">
      Changed to use TProjection instead of Projection.  References #775
      Changed to use TProjection instead of Projection.  References #775.
    </change>
    <change name="Adam Paquette" date="2016-06-21">
      Minor spelling/capitalization corrections in the documentation. Fixes #4019.
    </change>
  </history>

@@ -76,7 +89,7 @@
        </brief>
        <description>
          The first file that will be added to a color mosaic. This file is also used to propagate
          the Original label blob.     This file must be the output file from hicubeit and map projected.
          the OriginalLabel blob. This file must be the output file from hicubeit and must be map projected.
        </description>
        <filter>
          *.cub
@@ -87,11 +100,11 @@
        <fileMode>input</fileMode>
        <internalDefault>None</internalDefault>
        <brief>
          Second input file. this file is not required.
          Second input file (This file is not required)
        </brief>
        <description>
          This is the second cube that will be added to a color masaic.  This file should be the output
          from hicubeit and map projected.  This input file is not required.
          This is the second cube that will be added to a color mosaic.  This file should be the output
          from hicubeit and map-projected. (This input file is not required)
        </description>
        <filter>
          *.cub
@@ -102,11 +115,11 @@
        <type>cube</type>
        <fileMode>output</fileMode>
        <brief>
          The name of the output cube
          The name of the output cube.
        </brief>
        <description>
          This is the name that will be given to the output cube.  this cube is a mosaic of the two
           from files and has the new group "mosaic' added.
          This is the name that will be given to the output cube. This cube is a mosaic of the two
          FROM files and has the new group "Mosaic" added.
        </description>
        <filter>
          *.cub
@@ -118,24 +131,24 @@
        <default>
          <item>ONTOP</item>
        </default>
        <brief>The priority of pixel placement</brief>
        <brief>The priority of pixel placement.</brief>
        <description>
          This parameter is used to select one of two ways to masaic the
          This parameter is used to select one of two ways to mosaic the
          pixels in areas of overlap.
        </description>

        <list>
          <option value="ONTOP">
            <brief>Input cube will be placed on top of the mosaic </brief>
            <brief>Input cube will be placed on top of the mosaic. </brief>
            <description>
              When the input pixel is not Null, the input pixel
              value will be written to the output cube.
            </description>
          </option>
          <option value="BENEATH">
            <brief>Input cube will be placed beneath the mosaic</brief>
            <brief>Input cube will be placed beneath the mosaic.</brief>
            <description>
              When the mosaic pixel is not Null it will be left unchanged.
              When the mosaic pixel is not Null, it will be left unchanged.
            </description>
          </option>
        </list>