#include <ossimIndexToRgbLutFilter.h>

Inheritance diagram for ossimIndexToRgbLutFilter:

Public Types
enum	Mode { LITERAL = 0, VERTICES = 1, REGULAR = 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
	ossimIndexToRgbLutFilter ()

virtual	~ossimIndexToRgbLutFilter ()

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &origin, ossim_uint32 resLevel=0)

ossim_uint32	getNumberOfOutputBands () const
	Returns the number of bands in a tile returned from this TileSource. More...

virtual ossimScalarType	getOutputScalarType () const
	This will be used to query the output pixel type of the tile source. More...

void	setMode (Mode mode)

Mode	getMode () const

void	setLut (const ossimFilename &file)
	Set lookup table(lut) method. More...

double	getMinValue () const

double	getMaxValue () const

void	setMinValue (double value)

void	setMaxValue (double value)

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 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	getTileWidth () const
	Returns the default processing tile width. More...

virtual ossim_uint32	getTileHeight () const
	Returns the default processing tile height. 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
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::map< double, ossimRgbVector >	theLut

double	theMinValue

double	theMaxValue

bool	theMinValueOverride

bool	theMaxValueOverride

Mode	theMode

ossimRefPtr< ossimImageData >	theTile

ossimFilename	theLutFile

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 103 of file ossimIndexToRgbLutFilter.h.

Member Enumeration Documentation

◆ Mode

enum ossimIndexToRgbLutFilter::Mode

Enumerator
LITERAL
VERTICES
REGULAR

Definition at line 106 of file ossimIndexToRgbLutFilter.h.

106 { LITERAL = 0, VERTICES = 1, REGULAR = 2 };

ossimIndexToRgbLutFilter::LITERAL

Definition: ossimIndexToRgbLutFilter.h:106

ossimIndexToRgbLutFilter::VERTICES

Definition: ossimIndexToRgbLutFilter.h:106

ossimIndexToRgbLutFilter::REGULAR

Definition: ossimIndexToRgbLutFilter.h:106

Constructor & Destructor Documentation

◆ ossimIndexToRgbLutFilter()

ossimIndexToRgbLutFilter::ossimIndexToRgbLutFilter ( )

Definition at line 29 of file ossimIndexToRgbLutFilter.cpp.

References ossimConnectableObject::setDescription().

 :ossimImageSourceFilter(),
  theMinValue(ossim::nan()),
  theMaxValue(ossim::nan()),
  theMinValueOverride(false),
  theMaxValueOverride(false),
  theMode(REGULAR),
  theTile(0),
  theLutFile("")
 {
    setDescription("Look-up-table remapper from single-band index image to 24-bit RGB.");
 }

◆ ~ossimIndexToRgbLutFilter()

ossimIndexToRgbLutFilter::~ossimIndexToRgbLutFilter ( )

virtual

Definition at line 42 of file ossimIndexToRgbLutFilter.cpp.

43 {

44 }

Member Function Documentation

◆ allocate()

void ossimIndexToRgbLutFilter::allocate ( )

protected

Called on first getTile, will initialize all data needed.

Definition at line 176 of file ossimIndexToRgbLutFilter.cpp.

References ossimImageDataFactory::create(), ossimImageData::initialize(), ossimImageDataFactory::instance(), ossimImageSourceFilter::theInputConnection, theTile, and ossimRefPtr< T >::valid().

Referenced by getTile().

 {
    if(!theInputConnection) return;
 
    theTile = ossimImageDataFactory::instance()->create(this, 3, this);
    if(theTile.valid())
    {
       theTile->initialize();
    }
 }

◆ getMaxPixelValue()

double ossimIndexToRgbLutFilter::getMaxPixelValue ( ossim_uint32 band = 0 ) const

virtual

Returns the max pixel of the band.

Reimplemented from ossimImageSource.

Definition at line 467 of file ossimIndexToRgbLutFilter.cpp.

 {
    return 255.0;
 }

◆ getMaxValue()

double ossimIndexToRgbLutFilter::getMaxValue ( ) const

Definition at line 442 of file ossimIndexToRgbLutFilter.cpp.

References theMaxValue.

 {
    return theMaxValue;
 }

◆ getMinPixelValue()

double ossimIndexToRgbLutFilter::getMinPixelValue ( ossim_uint32 band = 0 ) const

virtual

Returns the min pixel of the band.

Reimplemented from ossimImageSource.

Definition at line 462 of file ossimIndexToRgbLutFilter.cpp.

 {
    return 1.0;
 }

◆ getMinValue()

double ossimIndexToRgbLutFilter::getMinValue ( ) const

Definition at line 437 of file ossimIndexToRgbLutFilter.cpp.

References theMinValue.

 {
    return theMinValue;
 }

◆ getMode()

Mode ossimIndexToRgbLutFilter::getMode ( ) const

inline

Definition at line 120 of file ossimIndexToRgbLutFilter.h.

120 { return theMode; }

ossimIndexToRgbLutFilter::theMode

Mode theMode

Definition: ossimIndexToRgbLutFilter.h:164

◆ getNullPixelValue()

double ossimIndexToRgbLutFilter::getNullPixelValue ( ossim_uint32 band = 0 ) const

virtual

Each band has a null pixel associated with it.

The null pixel represents an invalid value.

Reimplemented from ossimImageSource.

Definition at line 457 of file ossimIndexToRgbLutFilter.cpp.

 {
    return 0.0;
 }

◆ getNumberOfOutputBands()

ossim_uint32 ossimIndexToRgbLutFilter::getNumberOfOutputBands ( ) const

virtual

Returns the number of bands in a tile returned from this TileSource.

Reimplemented from ossimImageSource.

Definition at line 408 of file ossimIndexToRgbLutFilter.cpp.

References ossimImageSource::getNumberOfOutputBands(), and ossimSource::isSourceEnabled().

 {
    if(isSourceEnabled())
    {
       return 3;
    }
    return ossimImageSourceFilter::getNumberOfOutputBands();
 }

◆ getOutputScalarType()

ossimScalarType ossimIndexToRgbLutFilter::getOutputScalarType ( ) const

virtual

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 417 of file ossimIndexToRgbLutFilter.cpp.

References ossimImageSource::getOutputScalarType(), ossimSource::isSourceEnabled(), and OSSIM_UCHAR.

 {
    if(isSourceEnabled())
    {
       return OSSIM_UCHAR;
    }
 
    return ossimImageSourceFilter::getOutputScalarType();
 }

◆ getTile()

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

virtual

Returns: the requested region of interest

Reimplemented from ossimImageSource.

Definition at line 46 of file ossimIndexToRgbLutFilter.cpp.

References allocate(), ossimRgbVector::getB(), ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimRgbVector::getG(), ossimImageData::getHeight(), ossimImageData::getNullPix(), ossimImageSource::getNullPixelValue(), ossimRgbVector::getR(), ossimRectilinearDataObject::getScalarType(), ossimImageSource::getTile(), ossimImageData::getWidth(), LITERAL, ossimImageData::makeBlank(), 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, REGULAR, ossimRgbVector::setB(), ossimRgbVector::setG(), ossimImageData::setImageRectangle(), ossimRgbVector::setR(), ossimImageSourceFilter::theInputConnection, theLut, theMaxValue, theMinValue, theMode, theTile, and ossimImageData::validate().

 {
    if(!theInputConnection || (theLut.size() == 0))
       return 0;
 
    ossimRefPtr<ossimImageData> tile = theInputConnection->getTile(tileRect, resLevel);
    if (!tile || !tile->getBuf())
       return 0;
    if(!theTile)
    {
       allocate();
       if (!theTile)
          return 0;
    }
 
    theTile->setImageRectangle(tileRect);
    theTile->makeBlank();
 
    // Quick handling special case of empty input tile:
    if (tile->getDataObjectStatus() == OSSIM_EMPTY)
       return theTile;
 
    ossim_uint8* outBuf[3];
    outBuf[0] = (ossim_uint8*)(theTile->getBuf(0));
    outBuf[1] = (ossim_uint8*)(theTile->getBuf(1));
    outBuf[2] = (ossim_uint8*)(theTile->getBuf(2));
 
    ossim_uint32 maxLength = tile->getWidth()*tile->getHeight();
    ossimRgbVector color;
    const ossimRgbVector null_color (theTile->getNullPix(0), theTile->getNullPix(1), theTile->getNullPix(2));
    double index;
    std::map<double, ossimRgbVector>::const_iterator lut_entry;
    double null_index = theInputConnection->getNullPixelValue();
 
    for (ossim_uint32 pixel=0; pixel<maxLength; ++pixel)
    {
       // Convert input pixel to a double index value:
       switch(tile->getScalarType())
       {
       case OSSIM_DOUBLE:
          index = ((double*) tile->getBuf())[pixel];
          break;
       case OSSIM_SSHORT16:
          index = (double)(((ossim_sint16*) tile->getBuf())[pixel]);
          break;
       case OSSIM_FLOAT:
       case OSSIM_NORMALIZED_FLOAT:
          index = (double)(((float*) tile->getBuf())[pixel]);
          break;
       case OSSIM_UCHAR:
          index = (double)(((ossim_uint8*) tile->getBuf())[pixel]);
          break;
       case OSSIM_USHORT16:
       case OSSIM_USHORT11:
       case OSSIM_USHORT12:
       case OSSIM_USHORT13:
       case OSSIM_USHORT14:
       case OSSIM_USHORT15:
          index = (double)(((ossim_uint16*) tile->getBuf())[pixel]);
          break;
       default:
          break;
       }
 
       // Do not remap null pixels, leave the output pixel "blank" which is null-pixel value:
       if (index == null_index)
          continue;
 
       // REGULAR mode needs to clamp the indices to min max for non-null pixels:
       if (theMode == REGULAR)
       {
          if (index < theMinValue)
             index = theMinValue;
          else if (index > theMaxValue)
             index = theMaxValue;
       }
 
       // Now perform look-up depending on mode:
       if (theMode == LITERAL)
       {
          lut_entry = theLut.find(index);
          if (lut_entry == theLut.end())
             color = null_color;
          else
             color = lut_entry->second;
       }
       else
       {
          // Vertices and Regular mode perform same interpolation here between the line segments
          // vertices:
          lut_entry = theLut.find(index);
          if (lut_entry != theLut.end())
          {
             // Got exact match, no interpolation needed:
             color = lut_entry->second;
          }
          else
          {
             lut_entry = theLut.upper_bound(index);
             if ((lut_entry == theLut.end()) || (lut_entry == theLut.begin()))
                color = null_color;
             else
             {
                // Need to linearly interpolate:
                double index_hi = lut_entry->first;
                ossimRgbVector color_hi (lut_entry->second);
                --lut_entry;
                double index_lo = lut_entry->first;
                ossimRgbVector color_lo (lut_entry->second);
                double w_lo = (index_hi - index)/(index_hi - index_lo);
                double w_hi = 1.0 - w_lo;
                color.setR(ossim::round<ossim_uint8, double>( color_hi.getR()*w_hi + color_lo.getR()*w_lo ));
                color.setG(ossim::round<ossim_uint8, double>( color_hi.getG()*w_hi + color_lo.getG()*w_lo ));
                color.setB(ossim::round<ossim_uint8, double>( color_hi.getB()*w_hi + color_lo.getB()*w_lo ));
             }
          }
       }
 
       // Assign this output pixel:
       outBuf[0][pixel]  = color.getR();
       outBuf[1][pixel]  = color.getG();
       outBuf[2][pixel]  = color.getB();
 
    } // end loop over tile's pixels
 
    theTile->validate();
    return theTile;
 }

◆ initialize()

void ossimIndexToRgbLutFilter::initialize ( )

virtual

Reimplemented from ossimImageSourceFilter.

Definition at line 187 of file ossimIndexToRgbLutFilter.cpp.

References ossimImageSource::getMaxPixelValue(), ossimImageSource::getMinPixelValue(), ossimImageSourceFilter::initialize(), ossimImageSource::initialize(), ossimImageSourceFilter::theInputConnection, theMaxValue, theMaxValueOverride, theMinValue, theMinValueOverride, and theTile.

Referenced by ossimPointCloudTool::execute().

 {
    // 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();
       if(!theMinValueOverride)
          theMinValue = theInputConnection->getMinPixelValue(0);
       if(!theMaxValueOverride)
          theMaxValue = theInputConnection->getMaxPixelValue(0);
       if(theMinValue > theMaxValue)
          swap(theMinValue, theMaxValue);
    }
 }

◆ initializeLut()

bool ossimIndexToRgbLutFilter::initializeLut	(	const ossimKeywordlist *	kwl,
		const char *	prefix = `0`
	)

protected

Definition at line 313 of file ossimIndexToRgbLutFilter.cpp.

References ossimString::chars(), ossimString::empty(), ossimKeywordlist::find(), ossimString::length(), LITERAL, ossimNotify(), ossimNotifyLevel_WARN, REGULAR, ossimRgbVector::setB(), ossimRgbVector::setG(), ossimRgbVector::setR(), ossimString::split(), theLut, theMaxValue, theMinValue, theMode, ossimString::toDouble(), ossimString::toString(), and VERTICES.

 {
    theLut.clear();
 
    const ossimString entry_kw ("entry");
    ossimString keyword, base_keyword;
    ossimString indexStr, rgbStr;
    ossimString blank(" ");
    std::vector<ossimString> rgbList;
    double index;
    ossimRgbVector rgbVector (0,0,0);
    bool rtn_state = true;
 
    ossim_uint32 numEntries=0;
    while (true)
    {
       base_keyword = entry_kw + ossimString::toString(numEntries);
       if ((theMode == LITERAL) || (theMode == VERTICES))
       {
          // Index and color are subentries for this mode:
          keyword = base_keyword + ".index";
          indexStr = kwl->find(prefix, keyword.chars());
          if (indexStr.empty())
             break;
 
          index = indexStr.toDouble();
          keyword = base_keyword + ".color";
          rgbStr = kwl->find(prefix, keyword.chars());
       }
       else
       {
          // REGULAR mode: index is computed later to arrive at equally-spaced vertices. For now,
          // just store entry number as index:
          index = (double) numEntries;
          keyword = base_keyword;
          rgbStr = kwl->find(prefix, keyword.chars());
          if (rgbStr.empty())
          {
             // Perhaps old bloated form with separate keywords for R, G, B
             rgbStr = kwl->find(prefix, (keyword + ".r").chars());
             rgbStr += " ";
             rgbStr += kwl->find(prefix, (keyword + ".g").chars());
             rgbStr += " ";
             rgbStr += kwl->find(prefix, (keyword + ".b").chars());
             if (rgbStr.length() < 5)
                break;
          }
       }
 
       rgbStr.split(rgbList, blank, true);
       if (rgbList.size() != 3)
       {
          ossimNotify(ossimNotifyLevel_WARN)<<"ossimIndexToRgbLutFilter::initializeLut() -- "
                "Bad color specification in LUT KWL. LUT is not properly initialized."<<endl;
          return false;
       }
 
       rgbVector.setR(rgbList[0].toUInt8());
       rgbVector.setG(rgbList[1].toUInt8());
       rgbVector.setB(rgbList[2].toUInt8());
       theLut.insert(std::pair<double, ossimRgbVector>(index, rgbVector));
       rgbList.clear();
       ++numEntries;
    }
 
    // For REGULAR mode, need to adjust the indices to reflect a piecewise linear LUT with equally
    // spaced vertices:
    if (theMode == REGULAR)
    {
       std::map<double, ossimRgbVector> orig_lut = theLut;
       std::map<double, ossimRgbVector>::iterator iter =  orig_lut.begin();
       theLut.clear();
 
       if (numEntries == 1)
       {
          // Insert the implied start index at black and endpoint at specified color:
          theLut.insert(std::pair<double, ossimRgbVector>(theMinValue, ossimRgbVector (1, 1, 1)));
          theLut.insert(std::pair<double, ossimRgbVector>(theMaxValue, iter->second));
       }
       else
       {
          // Loop to create equally-spaced vertices between min and max index values:
          double interval = (theMaxValue - theMinValue) / (numEntries - 1);
          while (iter != orig_lut.end())
          {
             index = theMinValue + iter->first*interval;
             theLut.insert(std::pair<double, ossimRgbVector>(index, iter->second));
             ++iter;
          }
       }
    }
 
    return rtn_state;
 }

◆ loadState()

bool ossimIndexToRgbLutFilter::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 267 of file ossimIndexToRgbLutFilter.cpp.

References ossimKeywordlist::find(), and theLutFile.

Referenced by ossimPointCloudTool::execute(), and setLut().

 {
    bool return_state = true;
    ossimKeywordlist* kwl = new ossimKeywordlist(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
    }
 
    theMinValueOverride = false;
    ossimString lookup = kwl->find(prefix, MIN_VALUE_KW);
    if(!lookup.empty())
    {
       theMinValue =lookup.toDouble();
       theMinValueOverride = true;
    }
 
    theMaxValueOverride = false;
    lookup = kwl->find(prefix, MAX_VALUE_KW);
    if(!lookup.empty())
    {
       theMaxValue = lookup.toDouble();
       theMaxValueOverride = true;
    }
 
    lookup =  kwl->find(prefix, MODE_KW);
    if (lookup.contains("literal"))
       theMode = LITERAL;
    else if (lookup.contains("vertices"))
       theMode = VERTICES;
    else
       theMode = REGULAR;
 
    return_state &= initializeLut(kwl, prefix);
    return_state &= ossimImageSourceFilter::loadState(orig_kwl, prefix);
 
    delete kwl;
    return return_state;
 }

◆ saveState()

bool ossimIndexToRgbLutFilter::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 208 of file ossimIndexToRgbLutFilter.cpp.

References ossimKeywordlist::add(), and theMinValueOverride.

 {
    if (theMinValueOverride)
       kwl.add(prefix, MIN_VALUE_KW, theMinValue, true);
 
    if (theMaxValueOverride)
       kwl.add(prefix, MAX_VALUE_KW, theMaxValue, true);
 
    ossimString value;
    switch (theMode)
    {
    case LITERAL:
       value = "literal";
       break;
    case VERTICES:
       value = "vertices";
       break;
    default:
       value = "regular";
    }
    kwl.add(prefix, MODE_KW,  value.c_str(), true);
 
    bool rtn_stat = true;
 
    // Save the actual LUT:
    const ossimString entry_kw ("entry");
    ossimString color_keyword, base_keyword;
    ossimRgbVector rgbVector;
    ossimString blank(" ");
 
    ossim_uint32 entry = 0;
    std::map<double, ossimRgbVector>::const_iterator iter =  theLut.begin();
    while (iter != theLut.end())
    {
       base_keyword = entry_kw + ossimString::toString(entry);
       if ((theMode == LITERAL) || (theMode == VERTICES))
       {
          // Index and color are sub-entries for these modes:
          kwl.add(prefix, (base_keyword+".index").chars(), iter->first);
          color_keyword = base_keyword + ".color";
       }
       else
       {
          color_keyword = base_keyword;
       }
 
       rgbVector = iter->second;
       value = ossimString::toString((int)rgbVector.getR()) + blank +
             ossimString::toString((int)rgbVector.getG()) + blank +
             ossimString::toString((int)rgbVector.getB());
       kwl.add(prefix, color_keyword.chars(), value.chars());
       ++iter;
       ++entry;
    }
 
    rtn_stat &= ossimImageSourceFilter::saveState(kwl, prefix);
    return rtn_stat;
 }

◆ setLut()

void ossimIndexToRgbLutFilter::setLut ( const ossimFilename & file )

Set lookup table(lut) method.

This opens the keyword list and initializes lut.

CAUTION: Requires theMinValue, theMaxValue, and theMode to be set. Typically a connection is made prior to this call. If not connected to an input, "min", "max" and "mode" keywords should be passed in the keyword list file.

Parameters

file	Keyword list containing lut.

Definition at line 427 of file ossimIndexToRgbLutFilter.cpp.

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

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

◆ setMaxValue()

void ossimIndexToRgbLutFilter::setMaxValue ( double value )

Definition at line 452 of file ossimIndexToRgbLutFilter.cpp.

References theMaxValue.

 {
    theMaxValue = value;
 }

◆ setMinValue()

void ossimIndexToRgbLutFilter::setMinValue ( double value )

Definition at line 447 of file ossimIndexToRgbLutFilter.cpp.

References theMinValue.

 {
    theMinValue = value;
 }

◆ setMode()

void ossimIndexToRgbLutFilter::setMode ( Mode mode )

inline

Definition at line 119 of file ossimIndexToRgbLutFilter.h.

119 { theMode = mode; }

ossimIndexToRgbLutFilter::theMode

Mode theMode

Definition: ossimIndexToRgbLutFilter.h:164

Member Data Documentation

◆ theLut

std::map<double, ossimRgbVector> ossimIndexToRgbLutFilter::theLut

protected

Definition at line 158 of file ossimIndexToRgbLutFilter.h.

Referenced by getTile(), and initializeLut().

◆ theLutFile

ossimFilename ossimIndexToRgbLutFilter::theLutFile

protected

Definition at line 166 of file ossimIndexToRgbLutFilter.h.

Referenced by loadState(), and setLut().

◆ theMaxValue

double ossimIndexToRgbLutFilter::theMaxValue

protected

Definition at line 161 of file ossimIndexToRgbLutFilter.h.

Referenced by getMaxValue(), getTile(), initialize(), initializeLut(), and setMaxValue().

◆ theMaxValueOverride

bool ossimIndexToRgbLutFilter::theMaxValueOverride

protected

Definition at line 163 of file ossimIndexToRgbLutFilter.h.

Referenced by initialize().

◆ theMinValue

double ossimIndexToRgbLutFilter::theMinValue

protected

Definition at line 160 of file ossimIndexToRgbLutFilter.h.

Referenced by getMinValue(), getTile(), initialize(), initializeLut(), and setMinValue().

◆ theMinValueOverride

bool ossimIndexToRgbLutFilter::theMinValueOverride

protected

Definition at line 162 of file ossimIndexToRgbLutFilter.h.

Referenced by initialize(), and saveState().

◆ theMode

Mode ossimIndexToRgbLutFilter::theMode

protected

Definition at line 164 of file ossimIndexToRgbLutFilter.h.

Referenced by getTile(), and initializeLut().

◆ theTile

ossimRefPtr<ossimImageData> ossimIndexToRgbLutFilter::theTile

protected

Definition at line 165 of file ossimIndexToRgbLutFilter.h.

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ ossimIndexToRgbLutFilter()

◆ ~ossimIndexToRgbLutFilter()

Member Function Documentation

◆ allocate()

◆ getMaxPixelValue()

◆ getMaxValue()

◆ getMinPixelValue()

◆ getMinValue()

◆ getMode()

◆ getNullPixelValue()

◆ getNumberOfOutputBands()

◆ getOutputScalarType()

◆ getTile()

◆ initialize()

◆ initializeLut()

◆ loadState()

◆ saveState()

◆ setLut()

◆ setMaxValue()

◆ setMinValue()

◆ setMode()

Member Data Documentation

◆ theLut

◆ theLutFile

◆ theMaxValue

◆ theMaxValueOverride

◆ theMinValue

◆ theMinValueOverride

◆ theMode

◆ theTile