Unverified Commit 8b605fcb authored by acpaquette's avatar acpaquette Committed by GitHub
Browse files

PDS2ISIS Docs Update (#3800) 

* Update to pds2isis docs regarding zero values in 8bit images

* Updated docs with recommended verbage.

* Updated pds2isis docs based on feedback round 2

* Fixed special pixels link

* Fixed a few other special pixels links

* Added in missing comma

* Fixed typo
parent d55c615b

isis/src/base/apps/pds2isis/pds2isis.xml

+83 −70
Original line number Diff line number Diff line
@@ -36,27 +36,40 @@ xsi:noNamespaceSchemaLocation= 
      </ol>

      </blockquote>

      If any incoming <def link="Digital Number">pixel value</def> falls within

      two different special pixel types, the <def link="Special Pixel">special 

      two different special pixel types, the <def link="Special Pixels">special

      pixel</def> with the higher priority is assigned.  The user may also

      specify a range of pixel values to be assigned to the different special pixels.

      If the range of pixel values defined by the user for the different special

      pixels overlap, the special pixel with the highest priority is assigned.  For

      example, if NULLMIN=0.0, NULLMAX=3.0, LISMIN=3.0, and LISMAX=5.0, the actual

      raw value 3.0 can be assigned as a NULL or LIS, but is translated to NULL because

      NULL has a higher priority than LIS.  The conversion of images from ISIS2 to 

      ISIS3 follows the same rules as PDS images, except that the label information 

      NULL has a higher priority than LIS.

    </p>

    <p>

      It should be noted if any incoming <def link="Digital Number">pixel values</def>

      are equal to one of the ISIS <def link="Special Pixels">special pixel</def>

      values for the corresponding bit type, those pixels will be special in the

      output cube. The special pixel values for each bit type can be found

      <a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/SpecialPixels">here</a>.

      This is most commonly an issue with 8-bit data. If you are working with

      an 8-bit image and need either 0 or 255, either convert the data to 16-bit

      or use Stretch after ingestion.

    </p>

    <p>

      The conversion of images from ISIS2 to ISIS3

      follows the same rules as PDS images, except that the label information

      is propagated to the output file.

     </p>

     <p>

      The best option to convert files from ISIS2 to ISIS3 is to maintain all the

      input file settings, and do not change the <def link="Bit Type">bit type</def>

      or change any incoming pixel values to special pixels.  When an ISIS2 

      <def>Level1</def> image is imported into ISIS3, it is important to note the 

      label information is not propagated from the ISIS2 to the ISIS3 cube file.  

      For an ISIS2 <def>Level2</def> image or mosaic file, a limited set of label 

      information is transferred to the ISIS3 labels that include the "Instrument," 

      "<def link="Band">BandBin</def>," and "<def link="Map Projection">Mapping</def>" 

      groups.

      or change any incoming pixel values to <def link="Special Pixels">special pixels</def>.

      When an ISIS2 <def>Level1</def> image is imported into ISIS3, it is

      important to note the label information is not propagated from the ISIS2 to

      the ISIS3 cube file. For an ISIS2 <def>Level2</def> image or mosaic file,

      a limited set of label information is transferred to the ISIS3 labels that

      include the "Instrument," "<def link="Band">BandBin</def>," and

      "<def link="Map Projection">Mapping</def>" groups.

    </p>

  </description>