ossimTableRemapper.cpp

Go to the documentation of this file.

//*******************************************************************
//
// License:  See top level LICENSE.txt file.
//
// Author:  David Burken
//
// Description:
//
// Table remapper class definition.
//
// Takes input tile, remaps it through a table, then output tile in the desired
// scalar type.
//
// Two modes one that works on native remap tables, that being of the same
// scalar type (like ossim_uint8) of the input connection, and another that
// uses a normalized remap table (more scalar independent).
//
//*************************************************************************
// $Id: ossimTableRemapper.cpp 22745 2014-04-22 16:57:22Z dburken $

#include <ossim/imaging/ossimTableRemapper.h>
#include <ossim/base/ossimTrace.h>
#include <ossim/base/ossimScalarTypeLut.h>
#include <ossim/base/ossimNotifyContext.h>
#include <ossim/imaging/ossimImageDataFactory.h>

RTTI_DEF1(ossimTableRemapper, "ossimTableRemapper", ossimImageSourceFilter)

static ossimTrace traceDebug("ossimTableRemapper:debug");

static const char* TABLE_TYPE[] = { "UNKNOWN", "NATIVE", "NORMALIZED" };

ossimTableRemapper::ossimTableRemapper()
   :
      ossimImageSourceFilter(),  // base class
      theTile(0),
      theTmpTile(0),
      theNormBuf(0),
      theTableBinCount(0),
      theTableBandCount(0),
      theTableType(ossimTableRemapper::UKNOWN),
      theInputScalarType(OSSIM_SCALAR_UNKNOWN),
      theOutputScalarType(OSSIM_SCALAR_UNKNOWN)
{
   //***
   // Set the base class "theEnableFlag" to off since no adjustments have been
   // made yet.
   //***
   //disableSource();
}

ossimTableRemapper::~ossimTableRemapper()
{
   destroy();
}

void ossimTableRemapper::destroy()
{
   if (theNormBuf)
   {
      delete [] theNormBuf;
      theNormBuf = 0;
   }
   theTmpTile = 0;
   theTile    = 0;
}

void ossimTableRemapper::initialize()
{
   //---
   // Call the base class initialize.
   // Note:  This will reset "theInputConnection" if it changed...
   //---
   ossimImageSourceFilter::initialize();
   destroy();
   if (theInputConnection)
   {
      theInputScalarType = theInputConnection->getOutputScalarType();
      
      // Since we override "getOutputScalarType" make sure something's set.
      if (theOutputScalarType == OSSIM_SCALAR_UNKNOWN)
      {
         theOutputScalarType = theInputConnection->getOutputScalarType();
      }

      if (theTile.valid())
      {
         //if ( theTile->getNumberOfBands() !=
         //     theInputConnection->getNumberOfOutputBands() )
        // {
            // Wipe everything slick. The next getTile will call allocate.
        //    destroy();
        // }
      }
   }

   // Nothing else to do for this...
}

void ossimTableRemapper::allocate(const ossimIrect& rect)
{
   //---
   // It's either first getTile or we've had either a resize, so allocate
   // needed stuff...
   //---
   destroy();

   if (theInputConnection)
   {
      ossim_uint32 width  = rect.width();
      ossim_uint32 height = rect.height();
    
      theTile =  ossimImageDataFactory::instance()->create(this,this);
      theTile->setImageRectangle(rect); 
     // theTile =
     //    ossimImageDataFactory::instance()->create(this,
     //                                              getOutputScalarType(),
     //                                              getNumberOfOutputBands(),
     //                                              width,x
     //                                              height);
      theTile->initialize();


      if (theInputScalarType !=  getOutputScalarType() &&
          theTableType == ossimTableRemapper::NATIVE)
      {
         //---
         // We need a temp tile so we can do two remaps
         // inputTile->remapTable->tmpTile then
         // tmpTile->normalize->theTile(unnormalize to new scalar)...
         //---
         theTmpTile 
         = ossimImageDataFactory::instance()->create(this,
                                                     theInputScalarType,
                                                     getNumberOfOutputBands(),
                                                     width,
                                                     height);
         theTmpTile->setMinPix(theTile->getMinPix(), theTile->getNumberOfBands());
         theTmpTile->initialize();

      }

      if (theTableType == ossimTableRemapper::NORMALIZED ||
          theInputScalarType != theOutputScalarType)
      {
         theNormBuf = new ossim_float64[theTile->getSize()];
      }
   }
}

ossimRefPtr<ossimImageData> ossimTableRemapper::getTile(
   const ossimIrect& tile_rect, ossim_uint32 resLevel)
{
   ossimRefPtr<ossimImageData> result = 0;
   
   if(theInputConnection)
   {
      // Fetch tile from pointer from the input source.
      result = theInputConnection->getTile(tile_rect, resLevel);
      if (theEnableFlag&&result.valid())
      {  
         // Get its status of the input tile.
         ossimDataObjectStatus tile_status = result->getDataObjectStatus();
         
         // Check for remap bypass:
         if ( (tile_status != OSSIM_NULL) &&
              (tile_status != OSSIM_EMPTY) && theTable.size() )
         {

            // OK we have an input tile... and it's not null or empty.
            if(!theTile)
            {
               allocate(tile_rect);
            }
            if (theTile.valid())
            {
               theTile->setImageRectangle(tile_rect);
               if(theTmpTile.valid()) // not mandatory for all modes.
               {
                  theTmpTile->setImageRectangle(tile_rect);
               }   
               // Think things are good.  Do the real work...
               if (theTableType == ossimTableRemapper::NATIVE)
               {
                  // Most efficient case...
                  remapFromNativeTable(result);
               }
               else
               {
                  remapFromNormalizedTable(result);
               }
              
               theTile->validate();
               result = theTile;
            }
         }
      }
   }
   return result;
}

void ossimTableRemapper::remapFromNativeTable(
   ossimRefPtr<ossimImageData>& inputTile)
{
   switch (theOutputScalarType)
   {
      case OSSIM_UINT8:
      {
         remapFromNativeTable(ossim_uint8(0), inputTile);
         break;
      }
      
      case OSSIM_USHORT11:
      case OSSIM_USHORT12:
      case OSSIM_USHORT13:
      case OSSIM_USHORT14:
      case OSSIM_USHORT15:
      case OSSIM_USHORT16:
      {
         remapFromNativeTable(ossim_uint16(0), inputTile);
         break;
      }
      
      case OSSIM_SSHORT16:
      {
         remapFromNativeTable(ossim_sint16(0), inputTile);
         break;
      }
      
      case OSSIM_NORMALIZED_FLOAT:
      case OSSIM_FLOAT:
      {
         remapFromNativeTable(ossim_float32(0), inputTile);
         break;
      }
      
      case OSSIM_NORMALIZED_DOUBLE:
      case OSSIM_DOUBLE:
      {
         remapFromNativeTable(ossim_float64(0), inputTile);
         break;
      }
      
      case OSSIM_SCALAR_UNKNOWN:
      default:
      {
         if(traceDebug())
         {
         // Shouldn't hit this.
            ossimNotify(ossimNotifyLevel_WARN)
            << "ossimTableRemapper::remapFromNativeTable"
            << "\nOutput scalar type is OSSIM_SCALAR_UNKNOWN!\n";
         }
         break;
      }

   } // End of "switch (theTableType)"
}

template <class T> void ossimTableRemapper::remapFromNativeTable(
   T /* dummy */,
   ossimRefPtr<ossimImageData>& inputTile)
{
   
   const ossim_uint32 BANDS = theTile->getNumberOfBands();
   const ossim_uint32 PPB   = theTile->getSizePerBand(); // pixels per band
   //---
   // NOTE:
   // If (theTableBandCount == one) that means we only have one band; or,
   // the user wanted to remap all bands using the same table...
   //---
   const ossim_uint32 BAND_OFFSET =
      (theTableBandCount != 1) ? theTableBinCount: 0;



   const T* rt = reinterpret_cast<T*>(&theTable.front()); // remap table (rt)
   ossimRefPtr<ossimImageData> id;
   if (theInputScalarType == theOutputScalarType)
   {
      id = theTile;
   }
   else
   {
      id = theTmpTile;
   }
   if(theTable.size() >= (BANDS*BAND_OFFSET))
   {
      for (ossim_uint32 band = 0; band < BANDS; ++band)
      {
         const T NULL_PIX = static_cast<T>(id->getNullPix(band));
         //const T MIN_PIX  = static_cast<T>(id->getMinPix(band));

         const T* s = static_cast<T*>(inputTile->getBuf(band)); // source (s)
         T*       d = static_cast<T*>(id->getBuf(band));   // destination (d)

         if(s&&d)
         {
            for (ossim_uint32 pixel = 0; pixel < PPB; ++pixel)
            {
               //---
               // Get the source pixel and use it as an index to the table.
               // Note Null is always the "0" index, min always the "1".
               //---
               T p = s[pixel];
               if (p == NULL_PIX)  // Null is not always zero (dted).
               {
                  d[pixel] = NULL_PIX;
                 // p = 0;
               }
               else
               {
      //         else
      //         {
      //            p = (p+1-MIN_PIX);  // If min == 1 we want that to map to index 1.
      //         }

                  ossim_uint32 table_index = static_cast<ossim_uint32>(p);
                  
                  //---
                  // If within range use to index the remap table; else, null.
                  // Note:
                  // There is no min, max range checking on value retrieved from table.
                  // Range checking should be performed when the table is built.
                  //---
                  if(table_index < theTableBinCount)
                  {
                     d[pixel] = rt[table_index];
                  }
      //            else if(table_index < 0)
      //            {
      //               if(theTableBinCount > 1)
      //               {
      //                  d[pixel] = rt[1];
      //               }
      //               else
      //               {
      //                  d[pixel] = table_index;
       //              }
       //           }
                  else
                  {
                     if(theTableBinCount>0)
                     {
                        d[pixel] = rt[theTableBinCount-1];
                     }
                     else
                     {
                        d[pixel] = p;
                    }
                  }
               }
            }

         }

         rt += BAND_OFFSET; // Go to next band in the table.
      }

   }

   if (theInputScalarType != theOutputScalarType)
   {
      // Normalize and copy the temp tile to a buffer.
      id->copyTileToNormalizedBuffer(theNormBuf);

      // Un-normalize and copy the buffer to the destination tile.
      theTile->copyNormalizedBufferToTile(theNormBuf);
   }
}

void ossimTableRemapper::remapFromNormalizedTable(
   ossimRefPtr<ossimImageData>& inputTile)
{
   if (!theNormBuf) // First time...
   {
      theNormBuf = new ossim_float64[theTile->getSize()];
   }
   
   // Normalize and copy the source tile to a buffer.
   inputTile->copyTileToNormalizedBuffer(theNormBuf);

   const ossim_uint32 BANDS = theTile->getNumberOfBands();
   const ossim_uint32 PPB   = theTile->getSizePerBand(); // pixels per band

   //---
   // NOTE:
   // If (theTableBandCount == one) that means we only have one band; or,
   // the user wanted to remap all bands using the same table...
   //---
   const ossim_uint32 BAND_OFFSET = (theTableBandCount == 1) ? 0 : PPB;

   // remap table (rt)
   ossim_float64* rt = reinterpret_cast<ossim_float64*>(&theTable.front()); 

   ossim_float64* buf = theNormBuf;
   ossim_float64 p = 0.0;
   for (ossim_uint32 band = 0; band < BANDS; ++band)
   {
      for (ossim_uint32 pixel = 0; pixel < PPB; ++pixel)
      {
         // Get the source pixel...
         ossim_uint32 idx
            = static_cast<ossim_uint32>(buf[pixel]*theTableBinCount+0.5);

         if((idx < theTableBinCount))
         {
            // If within range use to index the remap table; else, null.
            p = (idx < theTableBinCount) ? rt[idx] : 0.0;
         }
//         else if(idx < 0)
//         {
//            p = 0.0;
//         }
         else 
         {
            p = 1.0;
         }
         // Range check (in case table bad) and assign to destination pixel.
         buf[pixel] = (p >= 0.0) ? ( (p <=1.0) ? p : 1) : 0.0;
      }

      // (GP)this is not for th table so this offset appears wrong
      // commenting this out and replacing with t bin count
      // Go to next band.
      //rt += BAND_OFFSET;


      rt += theTableBinCount;
      buf += PPB;
   }
   
   // Un-normalize and copy the buffer to the destination tile.
   theTile->copyNormalizedBufferToTile(theNormBuf);
}

ossimScalarType ossimTableRemapper::getOutputScalarType() const
{
   if (theOutputScalarType != OSSIM_SCALAR_UNKNOWN)
   {
      return theOutputScalarType;
   }

   return ossimImageSourceFilter::getOutputScalarType();
}

bool ossimTableRemapper::loadState(const ossimKeywordlist& kwl,
                                   const char* prefix)
{
   // Look for scalar type keyword.
   ossim_int32 st = ossimScalarTypeLut::instance()->
      getEntryNumber(kwl, prefix, true);

   // Lookup table returns -1 if not found so check return...
   if ( (st != -1) && (st != OSSIM_SCALAR_UNKNOWN) )
   {
      theOutputScalarType = static_cast<ossimScalarType>(st);
   }

   return ossimImageSourceFilter::loadState(kwl, prefix);
}

bool ossimTableRemapper::saveState(ossimKeywordlist& kwl,
                                   const char* prefix) const
{
   // Save the output scalar type.
   kwl.add(prefix,
           ossimKeywordNames::SCALAR_TYPE_KW,
           ossimScalarTypeLut::instance()->
           getEntryString(theOutputScalarType).c_str(),
           true);
   
   return ossimImageSourceFilter::saveState(kwl, prefix);
}

ostream& ossimTableRemapper::print(ostream& os) const
{
   ossimScalarTypeLut* sl = ossimScalarTypeLut::instance();

   os << "\nossimTableRemapper::print:"
      << "\ntheTableBinCount:    " << theTableBinCount
      << "\ntheTableBandCount:   " << theTableBandCount
      << "\ntheTableType:        " << TABLE_TYPE[theTableType]
      << "\ntheInputScalarType:  " << (*sl)[theInputScalarType]
      << "\ntheOutputScalarType: " << (*sl)[theOutputScalarType]
      << endl;
   
   if (theTile.valid())
   {
      os << "theTile:\n" << *theTile << endl;
   }
   if (theTmpTile.valid())
   {
      os << "theTmpTile:\n" << *theTmpTile << endl;
   }

   switch (theOutputScalarType)
   {
      case OSSIM_UCHAR:
      {
         dumpTable(ossim_uint8(0), os);
         break;
      }
      
      case OSSIM_USHORT11:
      case OSSIM_USHORT12:
      case OSSIM_USHORT13:
      case OSSIM_USHORT14:
      case OSSIM_USHORT15:
      case OSSIM_USHORT16:
      {
         dumpTable(ossim_uint16(0), os);
         break;
      }
      
      case OSSIM_SSHORT16:
      {
         dumpTable(ossim_sint16(0), os);
         break;
      }
      
      case OSSIM_NORMALIZED_FLOAT:
      case OSSIM_FLOAT:
      {
         dumpTable(ossim_float32(0), os);
         break;
      }
      
      case OSSIM_NORMALIZED_DOUBLE:
      case OSSIM_DOUBLE:
      {
         dumpTable(ossim_float64(0), os);
         break;
      }
      
      case OSSIM_SCALAR_UNKNOWN:
      default:
      {
         if(traceDebug())
         {
         // Shouldn't hit this.
            ossimNotify(ossimNotifyLevel_WARN)
               << "ossimTableRemapper::print OSSIM_SCALAR_UNKNOWN!\n";
         }
         break;
      }

   } // End of "switch (theTableType)"

   return os;
}

template <class T> void ossimTableRemapper::dumpTable(T /*dummy*/,
                                                      ostream& os) const
{
   if (theTable.empty() || !theTableBinCount || !theTableBandCount)
   {
      return;
   }

   const T* table = reinterpret_cast<const T*>(&theTable.front());

   ossim_uint32 table_index = 0;
   for (ossim_uint32 band = 0; band < theTableBandCount; ++band)
   {
      for (ossim_uint32 index = 0; index < theTableBinCount; ++index)
      {
         os << "tabel[" << band << "][" << index << "]:  "
            << static_cast<int>(table[table_index]) << endl;
         ++table_index;
      }
   }
}


ostream& operator<<(ostream& os, const ossimTableRemapper& tr)
{
   return tr.print(os);
}

// Private to disallow use...
ossimTableRemapper::ossimTableRemapper(const ossimTableRemapper&)
: theNormBuf(0),
  theTableBinCount(0),
  theTableBandCount(0),
  theTableType(UKNOWN),
  theInputScalarType(OSSIM_SCALAR_UNKNOWN),
  theOutputScalarType(OSSIM_SCALAR_UNKNOWN)
{
}

// Private to disallow use...
ossimTableRemapper& ossimTableRemapper::operator=(const ossimTableRemapper&)
{
   return *this;
}