ISIS Application Documentation
    Normalize bands in a cube
  
 
          Description
        
    
    The program accomplishes the fairly straightforward task of taking an input
    cube and outputting normalized values. 
     
    Normalization may be done with respect to each band or the entire cube.
    If the user were to normalize by band, the program would take a pass through
    the data in order to determine the average of each band. Bandnorm will then
    pass through each band again and normalize each one based on the average
    of the given band.  If normalizing by the entire cube, the first pass would compute
    the average of the cube, and the second pass would normalize each band using
    this average.  Bandnorm can use a text file as the input for the average 
    value of each band. 
     
   
 
          Categories
        
 
Applications
 
              History
          
| Elizabeth Miller | 2006-07-18 | 
      Original version
     | 
 
| Chris Austin | 2007-12-27 | 
      Added Spectral Pencil option.
     | 
 
| Chris Austin | 2008-01-23 | 
      Modified Spectral Pencil option to be more flexible with the structure of 
      its Spectral files, namely, allowing for more than one column, and 
      specifying which column to use durring normilization.
     | 
 
| Steven Lambright | 2008-05-12 | 
      Removed references to CubeInfo 
     | 
 
| Kimberly Oyama | 2013-05-22 | 
      Cleaned up memory so bandnorm runs correctly with batchlists. Fixes #754.
     | 
 
 
 | 
 
 
                Parameter Groups
            
Files
| 
                    Name
                     | 
                    Description
                     | 
 
| FROM | 
          Input cube
         | 
 
| TO | 
          Output cube
         | 
 
 
Normalization option
| 
                    Name
                     | 
                    Description
                     | 
 
| AVERAGE | Direction in which statistics and operations operate | 
 
| SPECTRUM | Spectral Pencil | 
 
| METHOD | The mothod used to determine desired column | 
 
| NUMBER | Specifies column used by number | 
 
| NAME | Specifies column used by name | 
 
 
 | 
 
Files:
                        FROM
                         Description
                       
          This file will be the input cube that gets normalized.
        
| 
                             Type
                            | cube | 
| 
                               File Mode
                              | input | 
| 
                               Filter
                              | 
          *.cub
         | 
 
 
Files:
                        TO
                         Description
                       
         Output file that will be created using average values from 
         the input cube to normalize.
        
| 
                             Type
                            | cube | 
| 
                               File Mode
                              | output | 
 
 
Normalization option:
                        AVERAGE
                         Description
                       
           This is the the average to be used during normalization. If the user chooses
           to use band averages, they intend to take in an entire band of data 
           and normalize based on the average of that band for each pixel in
           that band. If they choose to use the average from the entire cube, 
           they intend to take in an entire cube of data and normalize each 
           pixel in each band based on the average of the entire cube.  If they 
           choose pencil, they intend to use a file containing the averages of 
           each band to normalize each pixel in correlating band.  This file is 
           best obtained using Qview's plot tool.
         
| 
                             Type
                            | string | 
| 
                               Default
                              | BAND | 
| 
                               Option List:
                              | 
| 
                                   Option | 
                                   Brief | 
                                   Description | 
 
| BAND | Divide by Band Average  | 
              Get the average of each band separately to use in the normalization
            Exclusions
- SPECTRUM
 
- METHOD
 
- NUMBER
 
- NAME
 
 
 | 
 
| CUBE | Divide by Cube Average | 
              Get the average of the entire cube to use in the normailization
            Exclusions
- SPECTRUM
 
- METHOD
 
- NUMBER
 
- NAME
 
 
 | 
 
| PENCIL | Divide by Spectral Pencil | 
              Use the given file as the source of the values used to normalize 
              each band separately.
            Inclusions
- SPECTRUM
 
- METHOD
 
- NUMBER
 
- NAME
 
 
 | 
 
 
 | 
 
 
Normalization option:
                        SPECTRUM
                         Description
                       
          The file with the spectrum data for each band to be normalized with.  
          It assumes this file was aquired using Qview's plot tool. The first 
          line of the spectrum file MUST be composed of titles, and the
          following lines MUST be the data desired (in most cases the average) 
          of each band in sequential order, starting with the first band. Extra 
          lines are ignored.
        
| 
                             Type
                            | filename | 
| 
                               File Mode
                              | input | 
| 
                               Filter
                              | 
          *.txt *.lis
         | 
 
 
Normalization option:
                        METHOD
                         Description
                       
          The method used to determine the correct data column of the spectrum
          file wished to be used in creating the normalized cube.
        
| 
                             Type
                            | string | 
| 
                               Default
                              | BYNAME | 
| 
                               Option List:
                              | 
| 
                                   Option | 
                                   Brief | 
                                   Description | 
 
| BYNUMBER | Specify the column of the spectrum file to be used by 
              column number | 
              Allows one to specify by column number within the given 
              spectrum file, the column data to be used to create the normalized 
              cube.
            Exclusions
Inclusions
 | 
 
| BYNAME | Specify the column of the spectrum file to be used by 
              column name | 
              The name of the column within the specified spectrum file, used to 
              create the normalized cube.
            Exclusions
Inclusions
 | 
 
 
 | 
 
 
Normalization option:
                        NUMBER
                         Description
                       
          Allows one to specify by column number within the given 
          spectrum file, the column data to be used to create the normalized 
          cube.
        
 
Normalization option:
                        NAME
                         Description
                       
          Allows one to specify by column name within the given 
          spectrum file, the column data to be used to create the normalized 
          cube.
        
| 
                             Type
                            | string | 
| 
                               Default
                              | Average |