#include <ossimBandClipFilter.h>

Inheritance diagram for ossimBandClipFilter:

Public Types
enum	ossimBandClipType { ossimBandClipType_NONE = 0, ossimBandClipType_CLIP = 1, ossimBandClipType_CLAMP = 2, ossimBandClipType_LINEAR_STRETCH = 3, ossimBandClipType_MEDIAN_STRETCH = 4 }

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
	ossimBandClipFilter ()

	ossimBandClipFilter (ossimImageSource *, const vector< double > &minPix, const vector< double > &maxPix, ossimBandClipType clipType=ossimBandClipType_NONE)

	ossimBandClipFilter (ossimImageSource *, double minPix, double maxPix, ossimBandClipType clipType=ossimBandClipType_NONE)

void	setClipType (ossimBandClipType clipType)

ossimBandClipType	getClipType () const

virtual ossim_uint32	getNumberOfValues () const

void	setNumberOfValues (ossim_uint32 size)

void	setMinMaxPix (const vector< double > &minPix, const vector< double > &maxPix)

const std::vector< double > &	getMinPixList () const

const std::vector< double >	getMaxPixList () const

double	getMinPix (ossim_uint32 index) const

double	getMaxPix (ossim_uint32 index) const

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

virtual void	initialize ()

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...

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=NULL) const
	Method to save the state of an object to 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 ossimScalarType	getOutputScalarType () const
	This will be used to query the output pixel type of the tile source. 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	~ossimBandClipFilter ()

void	runClip ()

void	runClamp ()

void	runLinearStretch ()

void	runMedianStretch ()

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< double >	theMinPix

std::vector< double >	theMaxPix

std::vector< double >	theMedian

ossimBandClipType	theClipType

ossimRefPtr< ossimImageData >	theTile

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 19 of file ossimBandClipFilter.h.

Member Enumeration Documentation

◆ ossimBandClipType

enum ossimBandClipFilter::ossimBandClipType

Specifies the type of clipping. The first will just clip and

Enumerator
ossimBandClipType_NONE
ossimBandClipType_CLIP
ossimBandClipType_CLAMP
ossimBandClipType_LINEAR_STRETCH
ossimBandClipType_MEDIAN_STRETCH

Definition at line 26 of file ossimBandClipFilter.h.

    {
       ossimBandClipType_NONE             = 0,
       ossimBandClipType_CLIP             = 1,
       ossimBandClipType_CLAMP            = 2,
       ossimBandClipType_LINEAR_STRETCH   = 3,
       ossimBandClipType_MEDIAN_STRETCH   = 4 
    };

Constructor & Destructor Documentation

◆ ossimBandClipFilter() [1/3]

ossimBandClipFilter::ossimBandClipFilter ( )

Definition at line 19 of file ossimBandClipFilter.cpp.

References ossimImageData::initialize(), OSSIM_NORMALIZED_FLOAT, and theTile.

    :ossimImageSourceFilter(),
     theClipType(ossimBandClipType_NONE),
     theTile(NULL)
 {
    theTile = new ossimImageData(this, // I am the owner,
                                 OSSIM_NORMALIZED_FLOAT,
                                 1);
    theTile->initialize();
 }

◆ ossimBandClipFilter() [2/3]

ossimBandClipFilter::ossimBandClipFilter	(	ossimImageSource *	inputSource,
		const vector< double > &	minPix,
		const vector< double > &	maxPix,
		ossimBandClipType	clipType = `ossimBandClipType_NONE`
	)

Definition at line 30 of file ossimBandClipFilter.cpp.

References ossimImageData::initialize(), OSSIM_NORMALIZED_FLOAT, setMinMaxPix(), and theTile.

    :ossimImageSourceFilter(inputSource),
     theClipType(clipType),
     theTile(NULL)
 {
    theTile = new ossimImageData(this, // I am the owner,
                                 OSSIM_NORMALIZED_FLOAT,
                                 1);
    theTile->initialize();
    setMinMaxPix(minPix, maxPix);
 }

◆ ossimBandClipFilter() [3/3]

ossimBandClipFilter::ossimBandClipFilter	(	ossimImageSource *	inputSource,
		double	minPix,
		double	maxPix,
		ossimBandClipType	clipType = `ossimBandClipType_NONE`
	)

Definition at line 45 of file ossimBandClipFilter.cpp.

References ossimImageData::initialize(), OSSIM_NORMALIZED_FLOAT, theMaxPix, theMinPix, and theTile.

    :ossimImageSourceFilter(inputSource),
     theClipType(clipType),
     theTile(NULL)
 {
    theTile = new ossimImageData(this, // I am the owner,
                                 OSSIM_NORMALIZED_FLOAT,
                                 1);
    theTile->initialize();
    
    theMinPix.push_back(minPix);
    theMaxPix.push_back(maxPix);
 }

◆ ~ossimBandClipFilter()

ossimBandClipFilter::~ossimBandClipFilter ( )

protectedvirtual

Definition at line 62 of file ossimBandClipFilter.cpp.

63 {

64 }

Member Function Documentation

◆ getClipType()

ossimBandClipFilter::ossimBandClipType ossimBandClipFilter::getClipType ( ) const

Definition at line 71 of file ossimBandClipFilter.cpp.

References theClipType.

 {
    return theClipType;
 }

◆ getMaxPix()

double ossimBandClipFilter::getMaxPix ( ossim_uint32 index ) const

Definition at line 156 of file ossimBandClipFilter.cpp.

References theMaxPix.

 {
    return index<theMaxPix.size()?theMaxPix[index]:0;
 }

◆ getMaxPixList()

const std::vector< double > ossimBandClipFilter::getMaxPixList ( ) const

Definition at line 146 of file ossimBandClipFilter.cpp.

References theMaxPix.

 {
    return theMaxPix;
 }

◆ getMinPix()

double ossimBandClipFilter::getMinPix ( ossim_uint32 index ) const

Definition at line 151 of file ossimBandClipFilter.cpp.

References theMinPix.

 {
    return index<theMinPix.size()?theMinPix[index]:0;
 }

◆ getMinPixList()

const std::vector< double > & ossimBandClipFilter::getMinPixList ( ) const

Definition at line 141 of file ossimBandClipFilter.cpp.

References theMinPix.

 {
    return theMinPix;
 }

◆ getNumberOfValues()

ossim_uint32 ossimBandClipFilter::getNumberOfValues ( ) const

virtual

Definition at line 76 of file ossimBandClipFilter.cpp.

References theMinPix.

Referenced by getTile(), and saveState().

 {
    // We make sure that all arrays have the same number
    // of elements so we can use the size of any of them.
    return (ossim_uint32)theMinPix.size();
 }

◆ getTile()

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

virtual

Returns: the requested region of interest

Reimplemented from ossimImageSource.

Definition at line 161 of file ossimBandClipFilter.cpp.

References ossimImageData::copyNormalizedBufferToTile(), ossimImageData::copyTileToNormalizedBuffer(), ossimRefPtr< T >::get(), ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getHeight(), ossimImageData::getNumberOfBands(), getNumberOfValues(), ossimImageSource::getTile(), ossimImageData::getWidth(), ossimImageData::initialize(), OSSIM_EMPTY, OSSIM_NORMALIZED_FLOAT, OSSIM_NULL, ossimBandClipType_CLAMP, ossimBandClipType_CLIP, ossimBandClipType_LINEAR_STRETCH, ossimBandClipType_MEDIAN_STRETCH, ossimNotify(), ossimNotifyLevel_WARN, runClamp(), runClip(), runLinearStretch(), runMedianStretch(), ossimDataObject::setDataObjectStatus(), status, theClipType, ossimImageSourceFilter::theInputConnection, and theTile.

 {
    if(!theInputConnection)
    {
       return NULL;
    }
    
    ossimRefPtr<ossimImageData> data =
       theInputConnection->getTile(rect, resLevel);
    if(!data.get())
    {
       return data;
    }
    ossimDataObjectStatus status = data->getDataObjectStatus();
    if((status != OSSIM_NULL) &&
       (status != OSSIM_EMPTY))
    {
       ossim_uint32 dw = data->getWidth();
       ossim_uint32 dh = data->getHeight();
       ossim_uint32 db = data->getNumberOfBands();
 
       ossim_uint32 tw = theTile->getWidth();
       ossim_uint32 th = theTile->getHeight();
       ossim_uint32 tb = theTile->getNumberOfBands();
 
       if(((tw*th)!=(dw*dh))||
          (tb != db))
       {
          theTile = new ossimImageData(this,
                                       OSSIM_NORMALIZED_FLOAT,
                                       db,
                                       dw,
                                       dh);
          theTile->initialize();
       }
 
       if(getNumberOfValues() != theTile->getNumberOfBands())
       {
          // Should this go on??? (drb)
          ossimNotify(ossimNotifyLevel_WARN)
             << "ossimBandClipFilter::getTile\n"
             << "getNumberOfValues() != theTile->getNumberOfBands"
             << endl;
       }
       
       data->copyTileToNormalizedBuffer(static_cast<float*>(theTile->getBuf()));
       theTile->setDataObjectStatus(data->getDataObjectStatus());
       
       switch(theClipType)
       {
          case ossimBandClipType_CLIP:
          {
             runClip();
             break;
          }
          case ossimBandClipType_CLAMP:
          {
             runClamp();
             break;
          }
          case ossimBandClipType_LINEAR_STRETCH:
          {
             runLinearStretch();
             break;
          }
          case ossimBandClipType_MEDIAN_STRETCH:
          {
             runMedianStretch();
             break;
          }
          default:
             break;
       }
       data->copyNormalizedBufferToTile(static_cast<float*>(theTile->getBuf()));
    }
    
    return data;
 }

◆ initialize()

void ossimBandClipFilter::initialize ( )

virtual

Reimplemented from ossimImageSourceFilter.

Definition at line 500 of file ossimBandClipFilter.cpp.

References ossimImageSource::getNumberOfOutputBands(), ossimImageSourceFilter::initialize(), setNumberOfValues(), ossimImageSourceFilter::theInputConnection, and theMinPix.

 {
    ossimImageSourceFilter::initialize();
    
    if(theInputConnection)
    {
       ossim_uint32 bands = theInputConnection->getNumberOfOutputBands();
 
       if(bands)
       {
          if(theMinPix.size() != bands)
          {
             setNumberOfValues(bands);
          }
       }
    }
 }

◆ loadState()

bool ossimBandClipFilter::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 518 of file ossimBandClipFilter.cpp.

References ossimString::c_str(), ossimKeywordlist::find(), ossimKeywordlist::getNumberOfSubstringKeys(), ossimImageSourceFilter::loadState(), min, ossimBandClipType_CLIP, ossimBandClipType_LINEAR_STRETCH, ossimBandClipType_MEDIAN_STRETCH, ossimBandClipType_NONE, ossimNotify(), ossimNotifyLevel_NOTICE, theClipType, theMaxPix, theMedian, theMinPix, ossimString::toString(), ossimString::trim(), and ossimString::upcase().

 {
    bool result = ossimImageSourceFilter::loadState(kwl, prefix);
 
    if(result)
    {
       ossimString minRegExpression    = ossimString("^(") +
                                         ossimString(prefix) +
                                         "min[0-9]+)";
       ossimString maxRegExpression    = ossimString("^(") +
                                         ossimString(prefix) +
                                         "max[0-9]+)";
       ossimString medianRegExpression = ossimString("^(") +
                                         ossimString(prefix) +
                                         "median[0-9]+)";
       
       ossim_uint32 numberOfMins    = kwl.getNumberOfSubstringKeys(minRegExpression);
       ossim_uint32 numberOfMaxs    = kwl.getNumberOfSubstringKeys(maxRegExpression);
       ossim_uint32 numberOfMedians = kwl.getNumberOfSubstringKeys(medianRegExpression);
       theMinPix.clear();
       theMaxPix.clear();
       theMedian.clear();
 
       if(numberOfMins != numberOfMaxs)
       {
          ossim_int32 temp = (ossim_int32)min(numberOfMins, numberOfMaxs);
          numberOfMins = temp;
          numberOfMaxs = temp;
       }
       if(numberOfMins> 0)
       {
          ossimString prefixMin    = ossimString(prefix) + "min";
          ossimString prefixMax    = ossimString(prefix) + "max";
          ossimString prefixMedian = ossimString(prefix) + "median";
          
          ossim_uint32 numberOfMatches = 0;
          ossim_uint32 index = 0;
          const char* value=(const char*)NULL;
          
          while(numberOfMatches < numberOfMins)
          {
             value = kwl.find(prefixMin.c_str(),
                              ossimString::toString(index).c_str());
             if(value)
             {
                theMinPix.push_back(ossimString(value).toDouble());
                ++numberOfMatches;
             }
             ++index;
          }
          index = 0;
          numberOfMatches = 0;
          while(numberOfMatches < numberOfMaxs)
          {
             value = kwl.find(prefixMax.c_str(),
                              ossimString::toString(index).c_str());
             if(value)
             {
                theMaxPix.push_back(ossimString(value).toDouble());
                ++numberOfMatches;
             }
             ++index;
          }
          if(numberOfMedians != numberOfMins)
          {
             for(index = 0; index <  theMaxPix.size(); ++index)
             {
                theMedian.push_back((theMinPix[index]+theMaxPix[index])/2.0);
             }
          }
          else
          {
             index = 0;
             numberOfMatches = 0;
             while(numberOfMatches < numberOfMedians)
             {
                value = kwl.find(prefixMedian.c_str(),
                                 ossimString::toString(index).c_str());
                if(value)
                {
                   theMedian.push_back(ossimString(value).toDouble());
                   ++numberOfMatches;
                }
                ++index;
             }
          }
       }
    }
    const char* clip_type = kwl.find(prefix, "clip_type");
    if(clip_type)
    {
      ossimString clipType = clip_type;
       clipType = clipType.upcase().trim();
 
       if(clipType == "NONE")
       {
          theClipType = ossimBandClipType_NONE;
       }
       else if(clipType == "CLIP")
       {
          theClipType = ossimBandClipType_CLIP;
       }
       else if(clipType == "LINEAR_STRETCH")
       {
          theClipType = ossimBandClipType_LINEAR_STRETCH;
       }
       else if(clipType == "MEDIAN_STRETCH")
       {
          theClipType = ossimBandClipType_MEDIAN_STRETCH;
       }
    }
    else
    {
       ossimNotify(ossimNotifyLevel_NOTICE)
          << "ossimBandClipFilter::loadState NOTICE:\n"
          << "Clip type not given defaulting to NONE" << endl;
       theClipType = ossimBandClipType_NONE;
    }
 
    return result;
 }

◆ runClamp()

void ossimBandClipFilter::runClamp ( )

protected

Definition at line 269 of file ossimBandClipFilter.cpp.

References ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getHeight(), ossimImageData::getNullPix(), ossimImageData::getNumberOfBands(), ossimImageData::getWidth(), OSSIM_PARTIAL, theMaxPix, theMinPix, and theTile.

Referenced by getTile().

 {
    ossim_uint32 offset = 0;
    ossim_uint32 upperBound = theTile->getWidth()*theTile->getHeight();
    for(ossim_uint32 band =0; band < theTile->getNumberOfBands(); ++band)
    {
       float *buf     = static_cast<float*>(theTile->getBuf(band));
       float  minPix  = theMinPix[band];
       float  maxPix  = theMaxPix[band];
       float  nullPix = theTile->getNullPix(band);
       
       if(buf)
       {
          if(theTile->getDataObjectStatus() == OSSIM_PARTIAL)
          {
             for(offset = 0; offset < upperBound; ++offset)
             {
                if(*buf != nullPix)
                {
                   if(*buf < minPix)
                   {
                      *buf = minPix;
                   }
                   else if(*buf > maxPix)
                   {
                      *buf = maxPix;
                   }
                }
                ++buf;
             }
          }
          else
          {
             for(offset = 0; offset < upperBound; ++offset)
             {
                if(*buf < minPix)
                {
                   *buf = minPix;
                }
                else if(*buf > maxPix)
                {
                   *buf = maxPix;
                }
                ++buf;
             }
          }
       }
    }
 }

◆ runClip()

void ossimBandClipFilter::runClip ( )

protected

Definition at line 242 of file ossimBandClipFilter.cpp.

References ossimImageData::getBuf(), ossimImageData::getHeight(), ossimImageData::getNullPix(), ossimImageData::getNumberOfBands(), ossimImageData::getWidth(), theMaxPix, theMinPix, theTile, and ossimImageData::validate().

Referenced by getTile().

 {
    ossim_uint32 offset = 0;
    ossim_uint32 upperBound = theTile->getWidth()*theTile->getHeight();
    for(ossim_uint32 band =0; band < theTile->getNumberOfBands(); ++band)
    {
       float *buf     = static_cast<float*>(theTile->getBuf(band));
       float  minPix  = theMinPix[band];
       float  maxPix  = theMaxPix[band];
       float  nullPix = theTile->getNullPix(band);
       
       if(buf)
       {
          for(offset = 0; offset < upperBound; ++offset)
          {
             if((*buf < minPix)||
                (*buf > maxPix))
             {
                *buf = nullPix;
             }
             ++buf;
          }
       }
    }
    theTile->validate();
 }

◆ runLinearStretch()

void ossimBandClipFilter::runLinearStretch ( )

protected

Definition at line 319 of file ossimBandClipFilter.cpp.

References ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getHeight(), ossimImageData::getMaxPix(), ossimImageData::getMinPix(), ossimImageData::getNumberOfBands(), ossimImageData::getWidth(), ossimImageData::isNull(), min, OSSIM_FULL, OSSIM_PARTIAL, theMaxPix, theMinPix, and theTile.

Referenced by getTile().

 {   
    ossim_uint32 bands = (ossim_uint32)min(theTile->getNumberOfBands(), (ossim_uint32)theMinPix.size());
    ossim_uint32 w     = theTile->getWidth();
    ossim_uint32 h     = theTile->getHeight();
    ossim_uint32 upperBound = w*h;
    const double* minPixArray = theTile->getMinPix();
    const double* maxPixArray = theTile->getMaxPix();
       
    float* *bandArray = new float*[bands];
    ossim_uint32 band = 0;
    for(band = 0; band < bands; ++band)
    {
       bandArray[band] = static_cast<float*>(theTile->getBuf(band));
    }
    
    if(theTile->getDataObjectStatus() == OSSIM_PARTIAL)
    {
       for(ossim_uint32 offset = 0; offset < upperBound; ++offset)
       {
          if(!theTile->isNull(offset))
          {
             for(band = 0; band < bands; ++band)
             {
                double delta = theMaxPix[band] - theMinPix[band];
                double t     = (bandArray[band][offset] - theMinPix[band])/delta;
                if(t < 0)
                {
                  bandArray[band][offset] = minPixArray[band];
                }
                else if(t > 1)
                {
                  bandArray[band][offset] = maxPixArray[band];
                }
                else
                {
                   bandArray[band][offset] = t;
                }
             }
          }
       }
    }
    else if(theTile->getDataObjectStatus() == OSSIM_FULL)
    {
       for(ossim_uint32 offset = 0; offset < upperBound; ++offset)
          {
             for(band = 0; band < bands; ++band)
             {
                double delta = theMaxPix[band] - theMinPix[band];
                double t     = (bandArray[band][offset] - theMinPix[band])/delta;
                
               if(t < 0)
               {
                  bandArray[band][offset] = minPixArray[band];
               }
               else if(t > 1)
               {
                  bandArray[band][offset] = maxPixArray[band];
               }
               else
               {
                  bandArray[band][offset] = t;
               }
             }
          }
    }
    delete [] bandArray;
    
 }

◆ runMedianStretch()

void ossimBandClipFilter::runMedianStretch ( )

protected

Definition at line 389 of file ossimBandClipFilter.cpp.

References ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getHeight(), ossimImageData::getNumberOfBands(), ossimImageData::getWidth(), ossimImageData::isNull(), OSSIM_DEFAULT_MAX_PIX_NORM_FLOAT, OSSIM_DEFAULT_MIN_PIX_NORM_FLOAT, OSSIM_FULL, OSSIM_PARTIAL, theMaxPix, theMedian, theMinPix, and theTile.

Referenced by getTile().

 {
    ossim_uint32 bands = theTile->getNumberOfBands();
    float* *bandArray = new float*[bands];
    ossim_uint32 band = 0;
 
    for(band = 0; band < bands; ++band)
    {
       bandArray[band] = static_cast<float*>(theTile->getBuf(band));
    }
    ossim_uint32 upperBound = theTile->getWidth()*theTile->getHeight();
    
    if(theTile->getDataObjectStatus() == OSSIM_PARTIAL)
    {
       for(ossim_uint32 offset = 0; offset < upperBound; ++offset)
       {
          if(!theTile->isNull(offset))
          {
             for(band = 0; band < bands; ++band)
             {
                double side = (theMedian[band] - (double)bandArray[band][offset]);
                
                if(side > 0) // on the left
                {
                   double delta = fabs(theMedian[band] - theMinPix[band]);
                   double t     = ((double)bandArray[band][offset] - theMinPix[band])/delta;
                   if(t < 0)
                   {
                      bandArray[band][offset] = OSSIM_DEFAULT_MIN_PIX_NORM_FLOAT;
                   }
                   else if(t > 1)
                   {
                      bandArray[band][offset] = theMedian[band];
                   }
                   else
                   {
                      bandArray[band][offset] = theMedian[band]*t;
                   }
                }
                else // on the right
                {
                   double delta = theMaxPix[band] - theMedian[band];
                   double t = ((double)bandArray[band][offset] - theMedian[band])/delta;
                   
                   if(t < 0)
                   {
                      bandArray[band][offset] = theMedian[band];
                   }
                   else if(t > 1)
                   {
                      bandArray[band][offset] = OSSIM_DEFAULT_MAX_PIX_NORM_FLOAT;
                   }
                   else
                   {
                      bandArray[band][offset] = theMedian[band]+delta*t;
                   }
                }
             }
          }
       }
    }
    else if(theTile->getDataObjectStatus() == OSSIM_FULL)
    {
       for(ossim_uint32 offset = 0; offset < upperBound; ++offset)
       {
          for(band = 0; band < bands; ++band)
          {
             double side = (theMedian[band] - (double)bandArray[band][offset]);
             
             if(side > 0) // on the left
             {
                double delta = fabs(theMedian[band] - theMinPix[band]);
                double t     = ((double)bandArray[band][offset] - theMinPix[band])/delta;
                if(t < 0)
                {
                   bandArray[band][offset] = OSSIM_DEFAULT_MIN_PIX_NORM_FLOAT;
                }
                else if(t > 1)
                {
                   bandArray[band][offset] = theMedian[band];
                }
                else
                {
                   bandArray[band][offset] = theMedian[band]*t;
                }
             }
             else // on the right
             {
                double delta = theMaxPix[band] - theMedian[band];
                double t = ((double)bandArray[band][offset] - theMedian[band])/delta;
                
                if(t < 0)
                {
                   bandArray[band][offset] = theMedian[band];
                }
                else if(t > 1)
                {
                   bandArray[band][offset] = OSSIM_DEFAULT_MAX_PIX_NORM_FLOAT;
                }
                else
                {
                   bandArray[band][offset] = theMedian[band]+delta*t;
                }
             }
          }
       }
    }
 
    delete [] bandArray;
 }   

◆ saveState()

bool ossimBandClipFilter::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 641 of file ossimBandClipFilter.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), getNumberOfValues(), ossimBandClipType_CLIP, ossimBandClipType_LINEAR_STRETCH, ossimBandClipType_MEDIAN_STRETCH, ossimBandClipType_NONE, ossimImageSourceFilter::saveState(), theClipType, theMaxPix, theMedian, theMinPix, and ossimString::toString().

 {
    ossimString minPrefix    = ossimString("min");
    ossimString maxPrefix    = ossimString("max");
    ossimString medianPrefix = ossimString("median");
 
    for(ossim_uint32 index = 1; index <= getNumberOfValues(); ++index)
    {
       ossimString value = (minPrefix+ossimString::toString(index));
       kwl.add(prefix,
               value.c_str(),
               theMinPix[index-1],
               true);
       value = (maxPrefix+ossimString::toString(index));
       kwl.add(prefix,
               value.c_str(),
               theMaxPix[index-1],
               true);
       value = (medianPrefix+ossimString::toString(index));
       kwl.add(prefix,
               value.c_str(),
               theMedian[index-1],
               true);
    }
    ossimString clipType;
    switch(theClipType)
    {
       case ossimBandClipType_NONE:
       {
          clipType = "NONE";
          break;
       }
       case ossimBandClipType_CLIP:
       {
          clipType = "CLIP";
          break;
       }
       case ossimBandClipType_LINEAR_STRETCH:
       {
          clipType = "LINEAR_STRETCH";
          break;
       }
       case ossimBandClipType_MEDIAN_STRETCH:
       {
          clipType = "MEDIAN_STRETCH";
          break;
       }
       default:
          break;
    }
    kwl.add(prefix,
            "clip_type",
            clipType.c_str(),
            true);
    
    return ossimImageSourceFilter::saveState(kwl, prefix);
 }

◆ setClipType()

void ossimBandClipFilter::setClipType ( ossimBandClipType clipType )

Definition at line 66 of file ossimBandClipFilter.cpp.

References theClipType.

 {
    theClipType = clipType;
 }

◆ setMinMaxPix()

void ossimBandClipFilter::setMinMaxPix	(	const vector< double > &	minPix,
		const vector< double > &	maxPix
	)

Definition at line 132 of file ossimBandClipFilter.cpp.

References max, setNumberOfValues(), theMaxPix, and theMinPix.

Referenced by ossimBandClipFilter().

 {
    theMinPix = minPix;
    theMaxPix = maxPix;
 
    setNumberOfValues((ossim_uint32)max(theMinPix.size(), theMaxPix.size()));
 }

◆ setNumberOfValues()

void ossimBandClipFilter::setNumberOfValues ( ossim_uint32 size )

Definition at line 83 of file ossimBandClipFilter.cpp.

References min, OSSIM_DEFAULT_MAX_PIX_NORM_FLOAT, OSSIM_DEFAULT_MIN_PIX_NORM_FLOAT, size, theMaxPix, theMedian, and theMinPix.

Referenced by initialize(), and setMinMaxPix().

 {
 
    // lets do a non destructive set.  That way we can
    // grow or shrink the list without destroying
    // the original values.
    //
    if(!size)
    {
       theMinPix.clear();
       theMaxPix.clear();
       theMedian.clear();
       return;
    }
 
    
    vector<double> tempMin    = theMinPix;
    vector<double> tempMax    = theMaxPix;
    
    theMinPix.resize(size);
    theMaxPix.resize(size);
    theMedian.resize(size);
     
    ossim_uint32 upperBound = (ossim_uint32)min(theMinPix.size(), tempMin.size());
    ossim_uint32 index = 0;
 
    for(index = 0; index < upperBound; ++index)
    {
       theMinPix[index] = tempMin[index];
       theMaxPix[index] = tempMax[index];
       
       theMinPix[index] = theMinPix[index]>1?1:theMinPix[index];
       theMinPix[index] = theMinPix[index]<0?0:theMinPix[index];
       theMaxPix[index] = theMaxPix[index]>1?1:theMaxPix[index];
       theMaxPix[index] = theMaxPix[index]<0?0:theMaxPix[index];
       
       theMedian[index] = (theMaxPix[index] + theMinPix[index])/2.0;
    }
    
    for(;index < theMinPix.size();++index)
    {
       theMinPix[index] = OSSIM_DEFAULT_MIN_PIX_NORM_FLOAT;
       theMaxPix[index] = OSSIM_DEFAULT_MAX_PIX_NORM_FLOAT;
       theMedian[index] = (theMaxPix[index] + theMinPix[index])/2.0;
             
       theMedian[index] = (theMaxPix[index] + theMinPix[index])/2.0;
    }
 }

Member Data Documentation

◆ theClipType

ossimBandClipType ossimBandClipFilter::theClipType

protected

Definition at line 86 of file ossimBandClipFilter.h.

Referenced by getClipType(), getTile(), loadState(), saveState(), and setClipType().

◆ theMaxPix

std::vector<double> ossimBandClipFilter::theMaxPix

protected

Definition at line 83 of file ossimBandClipFilter.h.

Referenced by getMaxPix(), getMaxPixList(), loadState(), ossimBandClipFilter(), runClamp(), runClip(), runLinearStretch(), runMedianStretch(), saveState(), setMinMaxPix(), and setNumberOfValues().

◆ theMedian

std::vector<double> ossimBandClipFilter::theMedian

protected

Definition at line 84 of file ossimBandClipFilter.h.

Referenced by loadState(), runMedianStretch(), saveState(), and setNumberOfValues().

◆ theMinPix

std::vector<double> ossimBandClipFilter::theMinPix

protected

Definition at line 82 of file ossimBandClipFilter.h.

Referenced by getMinPix(), getMinPixList(), getNumberOfValues(), initialize(), loadState(), ossimBandClipFilter(), runClamp(), runClip(), runLinearStretch(), runMedianStretch(), saveState(), setMinMaxPix(), and setNumberOfValues().

◆ theTile

ossimRefPtr<ossimImageData> ossimBandClipFilter::theTile

protected

Definition at line 87 of file ossimBandClipFilter.h.

Referenced by getTile(), ossimBandClipFilter(), runClamp(), runClip(), runLinearStretch(), and runMedianStretch().

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

◆ ossimBandClipType

Constructor & Destructor Documentation

◆ ossimBandClipFilter() [1/3]

◆ ossimBandClipFilter() [2/3]

◆ ossimBandClipFilter() [3/3]

◆ ~ossimBandClipFilter()

Member Function Documentation

◆ getClipType()

◆ getMaxPix()

◆ getMaxPixList()

◆ getMinPix()

◆ getMinPixList()

◆ getNumberOfValues()

◆ getTile()

◆ initialize()

◆ loadState()

◆ runClamp()

◆ runClip()

◆ runLinearStretch()

◆ runMedianStretch()

◆ saveState()

◆ setClipType()

◆ setMinMaxPix()

◆ setNumberOfValues()

Member Data Documentation

◆ theClipType

◆ theMaxPix

◆ theMedian

◆ theMinPix

◆ theTile