ossimBandLutFilter Class Reference

#include <ossimBandLutFilter.h>

Inheritance diagram for ossimBandLutFilter:

Public Types
enum	Mode { UNKNOWN =0, LITERAL = 1, INTERPOLATED = 2 }
Public Types inherited from ossimConnectableObject
enum	ossimConnectableObjectDirectionType { CONNECTABLE_DIRECTION_NONE = 0, CONNECTABLE_DIRECTION_INPUT = 1, CONNECTABLE_DIRECTION_OUTPUT = 2 }
typedef std::vector< ossimRefPtr< ossimConnectableObject > >	ConnectableObjectList

Public Member Functions
	ossimBandLutFilter ()
virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &origin, ossim_uint32 resLevel=0)
void	setMode (Mode mode)
Mode	getMode () const
virtual ossimScalarType	getOutputScalarType () const
	This will be used to query the output pixel type of the tile source. More...
virtual void	setOutputScalarType (ossimScalarType scalarType)
	Sets the output scalar type. More...
virtual void	setOutputScalarType (ossimString scalarType)
void	setLut (const ossimFilename &file)
	This opens the keyword list and initializes lut. More...
virtual void	initialize ()
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=NULL) const
	Method to save the state of an object to a keyword list. More...
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=NULL)
	Method to the load (recreate) the state of an object from a keyword list. More...
Public Member Functions inherited from ossimImageSourceFilter
	ossimImageSourceFilter (ossimObject *owner=NULL)
	ossimImageSourceFilter (ossimImageSource *inputSource)
	ossimImageSourceFilter (ossimObject *owner, ossimImageSource *inputSource)
virtual void	getOutputBandList (std::vector< ossim_uint32 > &bandList) const
virtual ossim_uint32	getNumberOfInputBands () const
bool	canConnectMyInputTo (ossim_int32 inputIndex, const ossimConnectableObject *object) const
	required to be overriden by derived classes More...
virtual void	connectInputEvent (ossimConnectionEvent &event)
virtual void	disconnectInputEvent (ossimConnectionEvent &event)
virtual void	propertyEvent (ossimPropertyEvent &event)
virtual void	refreshEvent (ossimRefreshEvent &event)
virtual void	setProperty (ossimRefPtr< ossimProperty > property)
virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const
virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
Public Member Functions inherited from ossimImageSource
	ossimImageSource (ossimObject *owner=0)
	ossimImageSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)
virtual	~ossimImageSource ()
virtual ossimRefPtr< ossimImageData >	getTile (const ossimIpt &origin, ossim_uint32 resLevel=0)
virtual bool	getTile (ossimImageData *result, ossim_uint32 resLevel=0)
	Method to get a tile. More...
virtual ossimObject *	getObject ()
	For RTTI support. More...
virtual const ossimObject *	getObject () const
	For RTTI support. More...
virtual void	getDecimationFactor (ossim_uint32 resLevel, ossimDpt &result) const
	Will return the decimation factor for the given resolution level. More...
virtual void	getDecimationFactors (std::vector< ossimDpt > &decimations) const
	Will return an array of all decimations for each resolution level. More...
virtual ossim_uint32	getNumberOfDecimationLevels () const
	Will return the number of resolution levels. More...
virtual ossim_uint32	getNumberOfOutputBands () const
	Returns the number of bands in a tile returned from this TileSource. More...
virtual ossim_uint32	getTileWidth () const
	Returns the default processing tile width. More...
virtual ossim_uint32	getTileHeight () const
	Returns the default processing tile height. More...
virtual double	getNullPixelValue (ossim_uint32 band=0) const
	Each band has a null pixel associated with it. More...
virtual double	getMinPixelValue (ossim_uint32 band=0) const
	Returns the min pixel of the band. More...
virtual double	getMaxPixelValue (ossim_uint32 band=0) const
	Returns the max pixel of the band. More...
virtual ossimIrect	getBoundingRect (ossim_uint32 resLevel=0) const
	This will return the bounding rect of the source. More...
virtual void	getBoundingRect (ossimIrect &rect, ossim_uint32 resLevel=0) const
	Gets the bounding rectangle of the source. More...
virtual void	getValidImageVertices (std::vector< ossimIpt > &validVertices, ossimVertexOrdering ordering=OSSIM_CLOCKWISE_ORDER, ossim_uint32 resLevel=0) const
	ordering specifies how the vertices should be arranged. More...
virtual ossimRefPtr< ossimImageGeometry >	getImageGeometry ()
	Returns the image geometry object associated with this tile source or NULL if not defined. More...
virtual void	setImageGeometry (const ossimImageGeometry *geom)
	Default implementation sets geometry of the first input to the geometry specified. More...
virtual void	saveImageGeometry () const
	Default method to call input's saveImageGeometry. More...
virtual void	saveImageGeometry (const ossimFilename &geometry_file) const
	Default method to call input's saveImageGeometry. More...
virtual bool	isIndexedData () const
Public Member Functions inherited from ossimSource
	ossimSource (ossimObject *owner=0)
	ossimSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)
virtual	~ossimSource ()
virtual bool	isSourceEnabled () const
virtual void	enableSource ()
virtual void	disableSource ()
virtual bool	getEnableFlag () const
virtual void	setEnableFlag (bool flag)
virtual bool	isInitialized () const
virtual void	setInitializedFlag (bool flag)
virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...
Public Member Functions inherited from ossimConnectableObject
	ossimConnectableObject (ossimObject *owner=0)
	Base constructor of this object. More...
	ossimConnectableObject (ossimObject *owner, ossim_int32 inputListSize, ossim_int32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)
virtual	~ossimConnectableObject ()
void	setId (const ossimId &id)
	All connectable objects will have id's. More...
const ossimId &	getId () const
	Will allow us to get this object's id. More...
const ossimObject *	getOwner () const
	Fetches the current owner, most likely a container but not limited to one. More...
virtual void	changeOwner (ossimObject *owner)
	Permits changing the object's owner. More...
virtual void	setDescription (const ossimString &description)
virtual ossimString	getDescription () const
virtual bool	isConnected (ossimConnectableObjectDirectionType direction=CONNECTABLE_DIRECTION_INPUT) const
	will check the direction specified to see if all slots are full. More...
	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findConnectableObject(const ossimId &id))
	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(RTTItypeid typeId, ossimConnectableObjectDirectionType directionType, bool recurse=true))
	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(const ossimString &obj, ossimConnectableObjectDirectionType directionType, bool recurse=true))
	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findInputObjectOfType(const ossimString &className))
virtual ossim_int32	findInputIndex (const ossimConnectableObject *object)
	Return a valid index of the input list if the passed in object is found else return -1. More...
virtual ossim_int32	findInputIndex (const ossimId &id)
	Return a valid index of the input list if the passed id is found else return -1. More...
virtual ossim_int32	findOutputIndex (const ossimConnectableObject *object)
	Return a valid index of the output list if the passed in object is found else return -1. More...
virtual ossim_int32	findOutputIndex (const ossimId &id)
	Return a valid index of the output list if the passed in object is found else return -1. More...
virtual ossim_int32	getMyInputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...
virtual ossim_int32	getMyOutputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...
virtual bool	canConnectMyOutputTo (ossim_int32 myOutputIndex, const ossimConnectableObject *object) const
	default implementation is to allow anyone to connect to us. More...
virtual void	disconnect (ossimConnectableObject *object=0)
	Will disconnect the object passed in. More...
virtual void	disconnect (const ossimId &id)
	Will disconnect the object passed in. More...
virtual ossimRefPtr< ossimConnectableObject >	disconnectMyInput (ossim_int32 inputIndex, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given input index and generate a connection event. More...
virtual void	disconnectMyInput (ossimConnectableObject *input, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Finds the index of the passed in input and calls disconnectMyInput(inputIndex, disconnectOutputFlag, createEventFlag);. More...
virtual void	disconnectMyInputs (ConnectableObjectList &inputList, bool disconnectOutputFlag=true, bool createEventFlag=true)
virtual ossimRefPtr< ossimConnectableObject >	disconnectMyOutput (ossim_int32 outputIndex, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given output index and generate a connection event. More...
virtual void	disconnectMyOutput (ossimConnectableObject *output, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the output object. More...
virtual void	disconnectMyOutputs (ConnectableObjectList &outputList, bool disconnectOutputFlag=true, bool createEventFlag=true)
virtual void	disconnectAllInputs ()
	Will disconnect all of the input objects. More...
virtual void	disconnectAllOutputs ()
	Will disconnect all of the output objects. More...
virtual ossim_int32	connectMyInputTo (ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will try to connect this objects input to the passed in object. More...
virtual ossim_int32	connectMyInputTo (ossim_int32 inputIndex, ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will connect the specified input to the passed in object. More...
virtual bool	connectMyInputTo (ConnectableObjectList &inputList, bool makeOutputConnection=true, bool createEventFlag=true)
virtual ossim_int32	connectMyOutputTo (ossimConnectableObject *outputObject, bool makeInputConnection=true, bool createEventFlag=true)
	Will try to connect this objects output to the passed in object. More...
virtual bool	connectMyOutputTo (ConnectableObjectList &outputList, bool makeInputConnection=true, bool createEventFlag=true)
virtual bool	connectInputList (ConnectableObjectList &inputList)
	Will disconnect itself from all inputs and reset to the passed in input list. More...
virtual bool	connectOutputList (ConnectableObjectList &outputList)
	Will disconnect itself from all outputs and reset to the passed in output list. More...
virtual ossim_uint32	getNumberOfInputs () const
	Returns the number of input objects. More...
virtual ossim_uint32	getNumberOfOutputs () const
	Return the number of output objects. More...
ossimConnectableObject *	getInput (ossim_uint32 index=0)
	returns the object at the specified index. More...
const ossimConnectableObject *	getInput (ossim_uint32 index=0) const
	returns the object at the specified index. More...
ossimConnectableObject *	getOutput (ossim_uint32 index=0)
	returns the object at the specified index. More...
const ossimConnectableObject *	getOutput (ossim_uint32 index=0) const
	returns the object at the specified index. More...
virtual void	setNumberOfInputs (ossim_int32 numberOfInputs)
	Will set the number of inputs. More...
virtual bool	getInputListIsFixedFlag () const
virtual bool	getOutputListIsFixedFlag () const
virtual void	setNumberOfOutputs (ossim_int32 numberOfInputs)
	Will set the number of outputs. More...
const ConnectableObjectList &	getInputList () const
const ConnectableObjectList &	getOutputList () const
ConnectableObjectList &	getInputList ()
ConnectableObjectList &	getOutputList ()
	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const RTTItypeid &typeInfo, bool recurse=true))
	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const ossimString &className, bool recurse=true))
virtual void	propagateEventToOutputs (ossimEvent &event)
virtual void	propagateEventToInputs (ossimEvent &event)
virtual void	setProperty (const ossimString &name, const ossimString &value)
virtual ossim_uint32	saveStateOfAllInputs (ossimKeywordlist &kwl, bool saveThisStateFlag=true, ossim_uint32 objectIndex=1, const char *prefix=0) const
	Save the state of all inputs to a keyword list. More...
virtual bool	fillContainer (ossimConnectableContainer &container)
	Inserts this object and all of its children and inputs into the container provided. More...
bool	moveInputUp (const ossimId &id)
	Moves the input connection matching id up one in the connection list. More...
bool	moveInputDown (const ossimId &id)
	Moves the input connection matching id down one in the connection list. More...
bool	moveInputToTop (const ossimId &id)
	Moves the input connection matching id to the top of the connection list. More...
bool	moveInputToBottom (const ossimId &id)
	Moves the input connection matching id to the bottom of the connection list. More...
virtual void	accept (ossimVisitor &visitor)
	We will add a visitor interface for all connectable objects. More...
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const
Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()
virtual	~ossimListenerManager ()
virtual void	fireEvent (ossimEvent &event)
virtual bool	addListener (ossimListener *listener)
virtual bool	removeListener (ossimListener *listener)
virtual bool	findListener (ossimListener *listener)
Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()
virtual	~ossimPropertyInterface ()
virtual ossimString	getPropertyValueAsString (const ossimString &name) const
void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const
void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)
Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()
virtual	~ossimErrorStatusInterface ()
virtual ossimErrorCode	getErrorStatus () const
virtual ossimString	getErrorStatusString () const
virtual void	setErrorStatus (ossimErrorCode error_status) const
virtual void	setErrorStatus () const
virtual void	clearErrorStatus () const
bool	hasError () const
Public Member Functions inherited from ossimConnectableObjectListener
	ossimConnectableObjectListener ()
virtual	~ossimConnectableObjectListener ()
virtual void	processEvent (ossimEvent &event)
	ProcessEvent. More...
virtual void	objectDestructingEvent (ossimObjectDestructingEvent &)
virtual void	connectionEvent (ossimConnectionEvent &)
virtual void	disconnectOutputEvent (ossimConnectionEvent &)
virtual void	connectOutputEvent (ossimConnectionEvent &)
virtual void	addObjectEvent (ossimContainerEvent &)
virtual void	removeObjectEvent (ossimContainerEvent &)
virtual void	containerEvent (ossimContainerEvent &)
Public Member Functions inherited from ossimListener
	ossimListener ()
virtual	~ossimListener ()
void	enableListener ()
void	disableListener ()
void	setListenerEnableFlag (bool flag)
bool	isListenerEnabled () const
bool	getListenerEnableFlag () const

Protected Member Functions
virtual	~ossimBandLutFilter ()
void	allocate ()
	Called on first getTile, will initialize all data needed. More...
bool	initializeLut (const ossimKeywordlist &kwl, const char *prefix=0)
Protected Member Functions inherited from ossimImageSourceFilter
virtual	~ossimImageSourceFilter ()
Protected Member Functions inherited from ossimImageSource
	ossimImageSource (const ossimImageSource &rhs)
const ossimImageSource &	operator= (const ossimImageSource &)
Protected Member Functions inherited from ossimSource
	ossimSource (const ossimSource &rhs)
const ossimSource &	operator= (const ossimSource &rhs)
Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObject *	findObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes
std::vector< std::map< double, double > >	theLut
Mode	theMode
ossimRefPtr< ossimImageData >	theTile
ossimFilename	theLutFile
ossimScalarType	theOutputScalarType
Protected Attributes inherited from ossimImageSourceFilter
ossimImageSource *	theInputConnection
Protected Attributes inherited from ossimSource
bool	theEnableFlag
bool	theInitializedFlag
Protected Attributes inherited from ossimConnectableObject
ossimId	theId
ossimString	theDescription
ossimObject *	theOwner
bool	theInputListIsFixedFlag
	Indicates whether the theInputObjectList is fixed. More...
bool	theOutputListIsFixedFlag
	Indicates whether the theOutputObjectList is fixed. More...
ConnectableObjectList	theInputObjectList
	Holds a list of input objects. More...
ConnectableObjectList	theOutputObjectList
	Holds a list of output objects. More...
Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * >	theListenerList
bool	theEnabledFlag
std::list< ossimListener * >	theDelayedAdd
std::list< ossimListener * >	theDelayedRemove
bool	theFireEventFlag
Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus
Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Detailed Description

Definition at line 100 of file ossimBandLutFilter.h.

Member Enumeration Documentation

Mode

enum ossimBandLutFilter::Mode

Enumerator
UNKNOWN
LITERAL
INTERPOLATED

Definition at line 103 of file ossimBandLutFilter.h.

{ UNKNOWN=0, LITERAL = 1, INTERPOLATED  = 2 };

Constructor & Destructor Documentation

ossimBandLutFilter()

ossimBandLutFilter::ossimBandLutFilter

(

)

Definition at line 26 of file ossimBandLutFilter.cpp.

References ossimConnectableObject::setDescription().

:ossimImageSourceFilter(),
 theMode(INTERPOLATED),
 theTile(0),
 theLutFile(""),
 theOutputScalarType(OSSIM_SCALAR_UNKNOWN)
{
   setDescription("Look-up-table remapper for band-independent remapping.");
}

~ossimBandLutFilter()

ossimBandLutFilter::~ossimBandLutFilter ( )

protectedvirtual

Definition at line 36 of file ossimBandLutFilter.cpp.

{
}

Member Function Documentation

allocate()

void ossimBandLutFilter::allocate ( )

protected

Called on first getTile, will initialize all data needed.

Definition at line 169 of file ossimBandLutFilter.cpp.

References ossimImageDataFactory::create(), ossimImageSourceFilter::getNumberOfInputBands(), ossimImageData::initialize(), ossimImageDataFactory::instance(), OSSIM_NORMALIZED_FLOAT, OSSIM_SSHORT16, OSSIM_UCHAR, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, OSSIM_USHORT16, ossimImageData::setMaxPix(), ossimImageData::setMinPix(), ossimImageSourceFilter::theInputConnection, theOutputScalarType, theTile, and ossimRefPtr< T >::valid().

Referenced by getTile(), and setOutputScalarType().

{
   if(!theInputConnection)
      return;

   theTile = ossimImageDataFactory::instance()->create(this, getNumberOfInputBands(), this);
   if(!theTile.valid())
      return;

   switch(theOutputScalarType)
   {
   case OSSIM_SSHORT16:
      theTile->setMinPix(-32768);
      theTile->setMaxPix(32767);
      break;
   case OSSIM_NORMALIZED_FLOAT:
      theTile->setMinPix(0.0);
      theTile->setMaxPix(1.0);
      break;
   case OSSIM_UCHAR:
      theTile->setMinPix(0);
      theTile->setMaxPix(255);
      break;
   case OSSIM_USHORT16:
      theTile->setMinPix(0);
      theTile->setMaxPix(65535);
      break;
   case OSSIM_USHORT11:
      theTile->setMinPix(0);
      theTile->setMaxPix(2047);
      break;
   case OSSIM_USHORT12:
      theTile->setMinPix(0);
      theTile->setMaxPix(4095);
      break;
   case OSSIM_USHORT13:
      theTile->setMinPix(0);
      theTile->setMaxPix(8191);
      break;
   case OSSIM_USHORT14:
      theTile->setMinPix(0);
      theTile->setMaxPix(16383);
      break;
   case OSSIM_USHORT15:
      theTile->setMinPix(0);
      theTile->setMaxPix(32767);
      break;
   default:
      break;
   }

   theTile->initialize();
}

getMode()

Mode ossimBandLutFilter::getMode ( ) const

inline

Definition at line 111 of file ossimBandLutFilter.h.

{ return theMode; }

getOutputScalarType()

virtual ossimScalarType ossimBandLutFilter::getOutputScalarType ( ) const

inlinevirtual

This will be used to query the output pixel type of the tile source.

Please ignore the argument. It will soon be removed.

Reimplemented from ossimImageSource.

Definition at line 113 of file ossimBandLutFilter.h.

{ return theOutputScalarType; }

getTile()

ossimRefPtr< ossimImageData > ossimBandLutFilter::getTile ( const ossimIrect &  rect, ossim_uint32  resLevel = 0  )

virtual

Returns

the requested region of interest

Reimplemented from ossimImageSource.

Definition at line 40 of file ossimBandLutFilter.cpp.

References allocate(), ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getDoubleBuf(), ossimImageData::getFloatBuf(), ossimImageData::getHeight(), ossimImageData::getNullPix(), ossimImageSource::getNullPixelValue(), ossimImageSourceFilter::getNumberOfInputBands(), ossimImageData::getPix(), ossimImageData::getSshortBuf(), ossimImageSource::getTile(), ossimImageData::getUcharBuf(), ossimImageData::getUshortBuf(), ossimImageData::getWidth(), LITERAL, ossimImageData::makeBlank(), OSSIM_DEFAULT_MAX_PIX_DOUBLE, OSSIM_DEFAULT_MIN_PIX_DOUBLE, OSSIM_DOUBLE, OSSIM_EMPTY, OSSIM_FLOAT, OSSIM_NORMALIZED_FLOAT, OSSIM_SSHORT16, OSSIM_UCHAR, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, OSSIM_USHORT16, ossimImageData::setImageRectangle(), ossimImageData::setMaxPix(), ossimImageData::setMinPix(), ossimImageSourceFilter::theInputConnection, theLut, theMode, theOutputScalarType, theTile, and ossimImageData::validate().

{
   if(!theInputConnection || (theLut.size() == 0))
      return 0;

   ossimRefPtr<ossimImageData> inputTile = theInputConnection->getTile(tileRect, resLevel);
   if (!inputTile || !inputTile->getBuf())
      return 0;

   if(!theTile)
   {
      allocate();
      if (!theTile)
         return 0;
   }

   theTile->setImageRectangle(tileRect);
   theTile->makeBlank();

   // Quick handling special case of empty input tile:
   if (inputTile->getDataObjectStatus() == OSSIM_EMPTY)
      return theTile;

   const double null_index = theInputConnection->getNullPixelValue();
   const double null_value = theTile->getNullPix(0); // assuming same null for all bands
   ossim_uint32 maxLength = inputTile->getWidth()*inputTile->getHeight();

   double index, value;
   double min_value=OSSIM_DEFAULT_MAX_PIX_DOUBLE;
   double max_value=OSSIM_DEFAULT_MIN_PIX_DOUBLE;

   ossim_uint32 numBands = getNumberOfInputBands();
   for (ossim_uint32 band = 0; band < numBands; ++band)
   {
      map<double, double>& bandMap = theLut[band];
      std::map<double, double>::const_iterator lut_entry;
      for (ossim_uint32 pixel=0; pixel<maxLength; ++pixel)
      {
         // Do not remap null pixels, leave the output pixel "blank" which is null-pixel value:
         index = inputTile->getPix(pixel, band);
         if (index == null_index)
            continue;

         // Now perform look-up depending on mode:
         if (theMode == LITERAL)
         {
            lut_entry = bandMap.find(index);
            if (lut_entry == bandMap.end())
               value = null_value;
            else
               value = lut_entry->second;
         }
         else
         {
            // Interpolated mode performs interpolation here between the line segments vertices:
            lut_entry = bandMap.find(index);
            if (lut_entry != bandMap.end())
            {
               // Got exact match, no interpolation needed:
               value = lut_entry->second;
            }
            else
            {
               lut_entry = bandMap.upper_bound(index);
               if ((lut_entry == bandMap.end()) || (lut_entry == bandMap.begin()))
                  value = null_value;
               else
               {
                  // Need to linearly interpolate:
                  double index_hi = lut_entry->first;
                  double value_hi (lut_entry->second);
                  --lut_entry;
                  double index_lo = lut_entry->first;
                  double value_lo (lut_entry->second);
                  double w_lo = (index_hi - index)/(index_hi - index_lo);
                  double w_hi = 1.0 - w_lo;
                  value = value_hi*w_hi + value_lo*w_lo;
               }
            }
         }

         if (value < min_value)
            min_value = value;
         if (value > max_value)
            max_value = value;

         // Assign this output pixel according to desired scalar type:
         switch(theOutputScalarType)
         {
         case OSSIM_DOUBLE:
            theTile->getDoubleBuf(band)[pixel] = value;
            theTile->setMinPix(min_value);
            theTile->setMaxPix(max_value);
            break;
         case OSSIM_SSHORT16:
            theTile->getSshortBuf(band)[pixel] = value;
            break;
         case OSSIM_FLOAT:
            theTile->setMinPix(min_value);
            theTile->setMaxPix(max_value);
            theTile->getFloatBuf(band)[pixel] = value;
            break;
         case OSSIM_NORMALIZED_FLOAT:
            theTile->getFloatBuf(band)[pixel] = value;
            break;
         case OSSIM_UCHAR:
            theTile->getUcharBuf(band)[pixel] = value;
            break;
         case OSSIM_USHORT16:
            theTile->getUshortBuf(band)[pixel] = value;
            break;
         case OSSIM_USHORT11:
         case OSSIM_USHORT12:
         case OSSIM_USHORT13:
         case OSSIM_USHORT14:
         case OSSIM_USHORT15:
            theTile->getUshortBuf(band)[pixel] = value;
            break;
         default:
            break;
         }
      } // end loop over band's pixels
   }  // end loop over tile's bands

   theTile->validate();
   return theTile;
}

initialize()

void ossimBandLutFilter::initialize ( )

virtual

Reimplemented from ossimImageSourceFilter.

Definition at line 223 of file ossimBandLutFilter.cpp.

References ossimImageSourceFilter::initialize(), ossimImageSource::initialize(), ossimImageSourceFilter::theInputConnection, and theTile.

{
   // This assigns theInputConnection if one is there.
   ossimImageSourceFilter::initialize();

   // theTile will get allocated on first getTile call.
   theTile = 0;
   if ( theInputConnection )
   {
      // Initialize the chain on the left hand side of us.
      theInputConnection->initialize();
   }
}

initializeLut()

bool ossimBandLutFilter::initializeLut ( const ossimKeywordlist &  kwl, const char *  prefix = 0  )

protected

Definition at line 317 of file ossimBandLutFilter.cpp.

References ossimString::empty(), ossimKeywordlist::find(), ossimImageSourceFilter::getNumberOfInputBands(), ossimKeywordlist::numberOf(), ossimImageSourceFilter::theInputConnection, theLut, and ossimString::toDouble().

{
   theLut.clear();
   ossim_uint32 numBands = getNumberOfInputBands();
   bool usingBandPrefix = true;
   if (numBands <= 1)
   {
      ossim_uint32 numEntries = kwl.numberOf(prefix, "band0.in");
      if (numEntries == 0)
      {
         usingBandPrefix = false;
         numBands = 1;
      }
   }

   ossim_uint32 band = 0;
   while (true)
   {
      ossim_uint32 entry = 0;
      map<double,double> bandMap;
      while (true)
      {
         ostringstream inKey, outKey;
         if (usingBandPrefix)
         {
            inKey  << "band" << band << ".entry" << entry <<".in";
            outKey << "band" << band << ".entry" << entry <<".out";
         }
         else
         {
            inKey  << "entry" << entry <<".in";
            outKey << "entry" << entry <<".out";
         }

         ossimString inVal = kwl.find(prefix, inKey.str().c_str());
         if (inVal.empty())
            break;
         ossimString outVal = kwl.find(prefix, outKey.str().c_str());
         if (outVal.empty())
            break;

         bandMap.insert(std::pair<double,double>(inVal.toDouble(), outVal.toDouble()));
         ++entry;
      }

      if (bandMap.empty())
         break;

      theLut.push_back(bandMap);

      ++band;
      if ((numBands == 1) || !usingBandPrefix)
         break;

   }

   // Band still 0 would indicate a failure reading the first band entry:
   if (band == 0)
      return false;

   // Check that the correct number of bands are represented:
   if (theInputConnection && (numBands > band))
   {
      if (!usingBandPrefix)
      {
         // Use the same map for all bands
         for (ossim_uint32 i=1; i<numBands; ++i)
            theLut.push_back(theLut[0]);
      }
      else
      {
         // Not enough bands were specified in the KWL to represent all input bands. Set remaining
         // bands to no entries:
         map<double,double> nullBandMap;
         for (; band<numBands; ++band)
            theLut.push_back(nullBandMap);
      }
   }
   return true;
}

loadState()

bool ossimBandLutFilter::loadState ( const ossimKeywordlist &  kwl, const char *  prefix = NULL  )

virtual

Method to the load (recreate) the state of an object from a keyword list.

Return true if ok or false on error.

Reimplemented from ossimImageSourceFilter.

Definition at line 287 of file ossimBandLutFilter.cpp.

References ossimKeywordlist::find(), and theLutFile.

Referenced by ossimShorelineTool::doThreshold(), and setLut().

{
   bool return_state = true;
   ossimKeywordlist kwl (orig_kwl); // need non-const copy

   // First look for a LUT filename, and add its contents to the original KWL:
   theLutFile = kwl.find(prefix, LUT_FILE_KW);
   if (!theLutFile.empty())
   {
      // Need new (non const) KWL to hold merged contents, maintaining proper prefix if any:
      ossimKeywordlist lut_kwl;
      if (lut_kwl.addFile(theLutFile))
         kwl.add(prefix, lut_kwl, false); // appends all entries of lut_kwl with prefix before adding
   }

   theMode = INTERPOLATED;
   ossimString lookup =  kwl.find(prefix, MODE_KW);
   if (lookup.contains("literal"))
      theMode = LITERAL;

   int scalar = ossimScalarTypeLut::instance()->getEntryNumber(kwl, prefix);
   if (scalar != ossimLookUpTable::NOT_FOUND)
      setOutputScalarType(static_cast<ossimScalarType>(scalar));

   return_state &= initializeLut(kwl, prefix);
   return_state &= ossimImageSourceFilter::loadState(orig_kwl, prefix);

   return return_state;
}

saveState()

bool ossimBandLutFilter::saveState ( ossimKeywordlist &  kwl, const char *  prefix = NULL  ) const

virtual

Method to save the state of an object to a keyword list.

Return true if ok or false on error.

Reimplemented from ossimImageSourceFilter.

Definition at line 237 of file ossimBandLutFilter.cpp.

References ossimKeywordlist::add(), INTERPOLATED, LITERAL, theLut, and theMode.

{
   if (theLut.empty())
      return true;

   ossimString value;
   switch (theMode)
   {
   case LITERAL:
      value = "literal";
      break;
   case INTERPOLATED:
   default:
      value = "interpolated";
      break;
   }
   kwl.add(prefix, MODE_KW,  value.c_str(), true);

   bool rtn_stat = true;

   // Save the actual LUT:
   int numBands = theLut.size();
   for (int band=0; band<numBands; ++band)
   {
      ostringstream base_keyword;
      if (numBands > 1)
         base_keyword << "band" << band << ".";

      std::map<double, double>::const_iterator iter =  theLut[band].begin();
      ossim_uint32 entry = 0;
      while (iter != theLut[band].end())
      {
         ostringstream inKey, outKey;
         inKey  << base_keyword.str() << "entry" << entry <<".in";
         outKey << base_keyword.str() << "entry" << entry <<".out";

         ostringstream inVal, outVal;
         inVal  << iter->first;
         outVal << iter->second;

         kwl.add(prefix,  inKey.str().c_str(),  inVal.str().c_str());
         kwl.add(prefix, outKey.str().c_str(), outVal.str().c_str());
         ++iter;
         ++entry;
      }
   }
   rtn_stat &= ossimImageSourceFilter::saveState(kwl, prefix);
   return rtn_stat;
}

setLut()

void ossimBandLutFilter::setLut

(

const ossimFilename &

file

)

This opens the keyword list and initializes lut.

Parameters

file	Keyword list containing lut.

Definition at line 398 of file ossimBandLutFilter.cpp.

References ossimFilename::exists(), loadState(), and theLutFile.

{
   theLutFile = file;
   if(file.exists())
   {
      ossimKeywordlist kwl(theLutFile);
      loadState(kwl);
   }
}

setMode()

void ossimBandLutFilter::setMode ( Mode  mode )

inline

Definition at line 110 of file ossimBandLutFilter.h.

{ theMode = mode; }

setOutputScalarType() [1/2]

void ossimBandLutFilter::setOutputScalarType ( ossimScalarType  scalarType )

virtual

Sets the output scalar type.

Definition at line 408 of file ossimBandLutFilter.cpp.

References allocate(), OSSIM_SCALAR_UNKNOWN, ossimNotify(), ossimNotifyLevel_WARN, and theOutputScalarType.

Referenced by setOutputScalarType().

{
   if (scalarType == OSSIM_SCALAR_UNKNOWN)
   {
      ossimNotify(ossimNotifyLevel_WARN)
               << "ossimScalarRemapper::setOutputScalarType WARN:\n"
               << "OSSIM_SCALAR_UNKNOWN passed to method.  No action taken..."
               << std::endl;
      return;
   }

   theOutputScalarType = scalarType;
   allocate();
}

setOutputScalarType() [2/2]

void ossimBandLutFilter::setOutputScalarType ( ossimString  scalarType )

virtual

Definition at line 423 of file ossimBandLutFilter.cpp.

References ossimString::c_str(), ossimLookUpTable::getEntryNumber(), ossimScalarTypeLut::instance(), ossimLookUpTable::NOT_FOUND, ossimNotify(), ossimNotifyLevel_WARN, and setOutputScalarType().

{
   int scalar = ossimScalarTypeLut::instance()->getEntryNumber(scalarType.c_str());

   if (scalar != ossimLookUpTable::NOT_FOUND)
   {
      setOutputScalarType(static_cast<ossimScalarType>(scalar));
   }
   else
   {
      ossimNotify(ossimNotifyLevel_WARN)
               << "ossimScalarRemapper ERROR:"
               << "\nUnknown scalar type:  " << scalarType.c_str() << std::endl;
   }
}

Member Data Documentation

theLut

std::vector< std::map<double, double> > ossimBandLutFilter::theLut

protected

Definition at line 142 of file ossimBandLutFilter.h.

Referenced by getTile(), initializeLut(), and saveState().

theLutFile

ossimFilename ossimBandLutFilter::theLutFile

protected

Definition at line 146 of file ossimBandLutFilter.h.

Referenced by loadState(), and setLut().

theMode

Mode ossimBandLutFilter::theMode

protected

Definition at line 144 of file ossimBandLutFilter.h.

Referenced by getTile(), and saveState().

theOutputScalarType

ossimScalarType ossimBandLutFilter::theOutputScalarType

protected

Definition at line 147 of file ossimBandLutFilter.h.

Referenced by allocate(), getTile(), and setOutputScalarType().

theTile

ossimRefPtr<ossimImageData> ossimBandLutFilter::theTile

protected

Definition at line 145 of file ossimBandLutFilter.h.

Referenced by allocate(), getTile(), and initialize().

---

The documentation for this class was generated from the following files:

• ossimBandLutFilter.h
• ossimBandLutFilter.cpp