#include <ossimMaskFilter.h>

Inheritance diagram for ossimMaskFilter:

Public Types
enum	ossimFileSelectionMaskType { OSSIM_MASK_TYPE_SELECT = 1, OSSIM_MASK_TYPE_INVERT = 2, OSSIM_MASK_TYPE_WEIGHTED = 3, OSSIM_MASK_TYPE_BINARY = 4, OSSIM_MASK_TYPE_BINARY_INVERSE = 5, OSSIM_MASK_TYPE_SELECT_CLAMP_MIN = 6 }
	Enumeration used to identify what the selection type for this mask is to be used: More...

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
	ossimMaskFilter (ossimObject *owner=NULL)
	Default Constructor. More...

void	setMaskSource (ossimImageSource *maskSource)
	This set method is necessary when this object is being added to an ossimImageChain because ossimImageChain::addLast() performs a disconnect of all the input sources, thus losing the assignments made via constructor accepting source pointers. More...

virtual void	setMaskType (ossimFileSelectionMaskType type)
	Sets the mask type. More...

virtual void	setMaskType (const ossimString &type)
	Sets the mask type from string. More...

virtual ossimFileSelectionMaskType	getMaskType () const
	Returns the current mask algorithm used. More...

virtual ossimString	getMaskTypeString () const
	Returns the current mask algorithm used as a string. More...

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &rect, ossim_uint32 resLevel=0)
	Main entry point for the algorithm. More...

virtual void	initialize ()

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to the load (recreate) the state of an object from a keyword list. More...

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Method to save the state of an object to a keyword list. More...

virtual bool	canConnectMyInputTo (ossim_int32 index, const ossimConnectableObject *object) const
	required to be overriden by derived classes More...

virtual ossim_uint32	getNumberOfInputBands () const

virtual ossimRefPtr< ossimImageData >	executeMaskFilter (ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)

virtual void	setProperty (ossimRefPtr< ossimProperty > property)
	Interface to set the mask type. More...

virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
	Adds "mask_type" to list. More...

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 void	getOutputBandList (std::vector< ossim_uint32 > &bandList) const
	Initializes bandList. 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

Protected Member Functions
virtual	~ossimMaskFilter ()
	Will delete its owned tile. More...

void	allocate ()

ossimRefPtr< ossimImageData >	executeMaskFilterSelect (ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)
	will execute the section algorithm. More...

ossimRefPtr< ossimImageData >	executeMaskFilterInvertSelect (ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)
	will execute the invert selection algorithm. More...

ossimRefPtr< ossimImageData >	executeMaskFilterWeighted (ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)
	will execute the weighted algorithm. More...

ossimRefPtr< ossimImageData >	executeMaskFilterBinary (ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)
	Will execute the binary algorithm. More...

template<class inputT , class maskT >
ossimRefPtr< ossimImageData >	executeMaskFilterSelection (inputT dummyInput, maskT dummyMask, ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)

template<class inputT , class maskT >
ossimRefPtr< ossimImageData >	executeMaskFilterInvertSelection (inputT dummyInput, maskT dummyMask, ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)

template<class inputT , class maskT >
ossimRefPtr< ossimImageData >	executeMaskFilterWeighted (inputT dummyInput, maskT dummyMask, ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)

template<class inputT , class maskT >
ossimRefPtr< ossimImageData >	executeMaskFilterBinarySelection (inputT dummyInput, maskT dummyMask, ossimRefPtr< ossimImageData > imageSourceData, ossimRefPtr< ossimImageData > maskSourceData)

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
ossimFileSelectionMaskType	theMaskType
	Member variable that holds the algorithm type to run on the calls to getTile. More...

ossimRefPtr< ossimImageData >	theTile
	Member used to store the result of the applied algorithm type. More...

ossimRefPtr< ossimImageSource >	theMaskSource

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

Detailed Description

class ossimMaskFilter

   Requires 2 inputs.  The first input is assumed to be the image input
   and the second input is assumed to be the mask data.  It will only
   use one band of the mask and multi band masks are not supported.

   the number of bands, min pix, max pix, null pix ...etc are mapped
   to the first input.

Keywords:
   mask_type:

keywords description: This keyword can have the following values:
   select, select_clamp, invert, weighted, binary, or binary_inverse


select will use the input data and every where
     the mask is greater than 0 it will copy the input to the output.


select_clamp_min If mask pixel is non zero, output pixel is input
     pixel; else, null pixel value. Differs from select in that output
     pixel is clamped to min pixel if input pixel is used.


invert will use the input data and every where the mask is 0 it
     will copy the input to the output else it will place a null in
     the output.


weighted will normalize the mask between 0 and 1 and then multiply
     the input by that normalized value and copy to the output.


binary If mask pixel is non zero, output pixel is max pixel value;
     else, null.


binary_inverse If mask pixel is non zero, output pixel is max pixel
     value; else, null pixel value.

example of keywords:
 mask_type: select

Definition at line 61 of file ossimMaskFilter.h.

Member Enumeration Documentation

◆ ossimFileSelectionMaskType

enum ossimMaskFilter::ossimFileSelectionMaskType

Enumeration used to identify what the selection type for this mask is to be used:

OSSIM_MASK_TYPE_SELECT If the mask is non zero then the input is kept if it's 0 then the input is nulled out.
OSSIM_MASK_TYPE_INVERT If the input is non zero then the output is nulled else the input is kept
OSSIM_MASK_TYPE_WEIGHTED works as a multiplier of the input data. The mask is normalized to be between 0 and 1 and multiplies the input by that normalized value.
OSSIM_MASK_TYPE_BINARY If mask pixel is non zero, output pixel is null pixel value; else, max pixel value.
OSSIM_MASK_TYPE_BINARY_INVERSE If mask pixel is non zero, output pixel is max pixel value; else, null pixel value.
OSSIM_MASK_TYPE_SELECT_CLAMP_MIN If mask pixel is non zero, output pixel is input pixel; else, null pixel value. Differs from OSSIM_MASK_TYPE_SELECT in that output pixel is clamped to min pixel if input pixel is used. The clampling has the affect of flipping null pixels to min pixel value if the mask pixel is non zero and input pixel is a null.

Enumerator
OSSIM_MASK_TYPE_SELECT	standard select if mask is true then keep standard invert if mask is true the don't keep
OSSIM_MASK_TYPE_INVERT	weighted operation. Normalize the mask and multiply the input
OSSIM_MASK_TYPE_WEIGHTED	binary image>
OSSIM_MASK_TYPE_BINARY	inverse binary image>
OSSIM_MASK_TYPE_BINARY_INVERSE	Standard select if mask is true then keep with min.
OSSIM_MASK_TYPE_SELECT_CLAMP_MIN

Definition at line 89 of file ossimMaskFilter.h.

   {
      OSSIM_MASK_TYPE_SELECT         = 1,
      OSSIM_MASK_TYPE_INVERT         = 2,
      OSSIM_MASK_TYPE_WEIGHTED       = 3,
      OSSIM_MASK_TYPE_BINARY         = 4,
      OSSIM_MASK_TYPE_BINARY_INVERSE = 5,
      OSSIM_MASK_TYPE_SELECT_CLAMP_MIN = 6,
   };

Constructor & Destructor Documentation

◆ ossimMaskFilter()

ossimMaskFilter::ossimMaskFilter ( ossimObject * owner = NULL )

Default Constructor.

Definition at line 28 of file ossimMaskFilter.cpp.

    :
    ossimImageSource(owner, 1, 1, true, false),
    theMaskType(OSSIM_MASK_TYPE_SELECT),
    theTile(0)
 {
 }

◆ ~ossimMaskFilter()

ossimMaskFilter::~ossimMaskFilter ( )

protectedvirtual

Will delete its owned tile.

Definition at line 36 of file ossimMaskFilter.cpp.

37 {

38 }

Member Function Documentation

◆ allocate()

void ossimMaskFilter::allocate ( )

protected

Definition at line 110 of file ossimMaskFilter.cpp.

References ossimImageDataFactory::create(), ossimConnectableObject::getInput(), ossimImageData::initialize(), ossimImageDataFactory::instance(), and theTile.

Referenced by getTile().

 {
    if(getInput())
    {
       theTile = ossimImageDataFactory::instance()->create(this, this);
       theTile->initialize();
    }
 }

◆ canConnectMyInputTo()

bool ossimMaskFilter::canConnectMyInputTo	(	ossim_int32	myInputIndex,
		const ossimConnectableObject *	object
	)		const

virtual

required to be overriden by derived classes

Implements ossimConnectableObject.

Definition at line 95 of file ossimMaskFilter.cpp.

References PTR_CAST.

 {
    return (PTR_CAST(ossimImageSource, object)!= 0);
 }

◆ executeMaskFilter()

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilter	(	ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

virtual

Definition at line 119 of file ossimMaskFilter.cpp.

References ossimImageData::dup(), executeMaskFilterBinary(), executeMaskFilterInvertSelect(), executeMaskFilterSelect(), executeMaskFilterWeighted(), ossimRefPtr< T >::get(), ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getHeight(), ossimImageData::getOrigin(), ossimImageData::getWidth(), ossimImageData::initialize(), ossimImageData::loadTile(), OSSIM_MASK_TYPE_BINARY, OSSIM_MASK_TYPE_BINARY_INVERSE, OSSIM_MASK_TYPE_INVERT, OSSIM_MASK_TYPE_SELECT, OSSIM_MASK_TYPE_SELECT_CLAMP_MIN, OSSIM_MASK_TYPE_WEIGHTED, ossimDataObject::setDataObjectStatus(), ossimImageData::setOrigin(), ossimImageData::setWidthHeight(), theMaskType, and theTile.

Referenced by getTile().

 {
    if(!theTile)
    {
       theTile = (ossimImageData*)imageSourceData->dup();
       if(!theTile->getBuf())
       {
          theTile->initialize();
       }
    }
    else
    {
       ossim_uint32 tw = theTile->getWidth();
       ossim_uint32 th = theTile->getHeight();
       ossim_uint32 dw = imageSourceData->getWidth();
       ossim_uint32 dh = imageSourceData->getHeight();
       
       theTile->setWidthHeight(imageSourceData->getWidth(),
                   imageSourceData->getHeight());
       theTile->setOrigin(imageSourceData->getOrigin());
       if((tw*th) != (dw*dh))
       {
          theTile->initialize();
       }
       theTile->setDataObjectStatus(imageSourceData->getDataObjectStatus());
    }
    theTile->loadTile(imageSourceData.get());
    theTile->setDataObjectStatus(imageSourceData->getDataObjectStatus());
    switch(theMaskType)
    {
       case OSSIM_MASK_TYPE_SELECT:
       case OSSIM_MASK_TYPE_SELECT_CLAMP_MIN:
       {
          return executeMaskFilterSelect(theTile, maskSourceData);
       }
       case OSSIM_MASK_TYPE_INVERT:
       {
          return executeMaskFilterInvertSelect(theTile, maskSourceData);
       }
       case OSSIM_MASK_TYPE_WEIGHTED:
       {
          return executeMaskFilterWeighted(theTile, maskSourceData);
       }
       case OSSIM_MASK_TYPE_BINARY:
       case OSSIM_MASK_TYPE_BINARY_INVERSE:
       {
          return executeMaskFilterBinary(theTile, maskSourceData);
       }
    }
    
    return imageSourceData;
 }

◆ executeMaskFilterBinary()

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilterBinary	(	ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

protected

Will execute the binary algorithm.

Copies the values in the mask to each tile. Values will be either NULL or MAX pixel value, typically 0 or 255.

Definition at line 379 of file ossimMaskFilter.cpp.

References executeMaskFilterBinarySelection(), ossimRectilinearDataObject::getScalarType(), OSSIM_DOUBLE, OSSIM_FLOAT, OSSIM_NORMALIZED_DOUBLE, OSSIM_NORMALIZED_FLOAT, OSSIM_SSHORT16, OSSIM_UCHAR, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, OSSIM_USHORT16, ossimNotify(), ossimNotifyLevel_WARN, and theTile.

Referenced by executeMaskFilter().

 {
    if(maskSourceData->getScalarType() != OSSIM_UCHAR)
    {
       ossimNotify(ossimNotifyLevel_WARN) << "ossimMaskFilter::executeMaskFilterBinary WARNING: Only uchar masks are supported" << endl;
       return imageSourceData;
    }
    
    switch(imageSourceData->getScalarType())
    {
       case OSSIM_UCHAR:
       {
          executeMaskFilterBinarySelection((ossim_uint8)0,
                                           (ossim_uint8)0,
                                           imageSourceData,
                                           maskSourceData);
          break;
       }
       case OSSIM_USHORT11:
       case OSSIM_USHORT12:
       case OSSIM_USHORT13:
       case OSSIM_USHORT14:
       case OSSIM_USHORT15:
       case OSSIM_USHORT16:
       {
          executeMaskFilterBinarySelection((ossim_uint16)0,
                                           (ossim_uint8)0,
                                           imageSourceData,
                                           maskSourceData);
          break;
       }
       case OSSIM_SSHORT16:
       {
          executeMaskFilterBinarySelection((ossim_sint16)0,
                                           (ossim_uint8)0,
                                           imageSourceData,
                                           maskSourceData);
          break;
       }
       case OSSIM_FLOAT:
       case OSSIM_NORMALIZED_FLOAT:
       {
          executeMaskFilterBinarySelection((float)0,
                                           (ossim_uint8)0,
                                           imageSourceData,
                                           maskSourceData);
          break;
       }
       case OSSIM_DOUBLE:
       case OSSIM_NORMALIZED_DOUBLE:
       {
          executeMaskFilterBinarySelection((double)0,
                                           (ossim_uint8)0,
                                           imageSourceData,
                                           maskSourceData);
          break;
       }
       default:
       {
          ossimNotify(ossimNotifyLevel_WARN) << "ossimMaskFilter::executeMaskFilterBinary WARNING: Unknown scalar type" << endl;
          break;
       }
    }
 
    return theTile;
 }

◆ executeMaskFilterBinarySelection()

template<class inputT , class maskT >

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilterBinarySelection	(	inputT	dummyInput,
		maskT	dummyMask,
		ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

protected

Definition at line 668 of file ossimMaskFilter.cpp.

References ossimImageData::getBuf(), ossimImageData::getHeight(), ossimImageData::getMaxPix(), ossimImageData::getNullPix(), ossimImageData::getNumberOfBands(), ossimImageData::getWidth(), OSSIM_MASK_TYPE_BINARY_INVERSE, theMaskType, theTile, and ossimImageData::validate().

Referenced by executeMaskFilterBinary().

 {
    ossim_uint32 maskBands  = maskSourceData->getNumberOfBands();
    ossim_uint32 inputBands = imageSourceData->getNumberOfBands();
    if(maskBands&&inputBands)
    {
       ossim_uint32 maxOffset = theTile->getWidth()*theTile->getHeight();
       for(ossim_uint32 band = 0; band < inputBands; ++band)
       {
          maskT*  bufMask   = (maskT*)maskSourceData->getBuf();
          inputT* bufOut    = (inputT*)theTile->getBuf(band);
          const inputT  NP  = (inputT)theTile->getNullPix(band);
          const inputT  MP  = (inputT)theTile->getMaxPix(band);
          ossim_uint32 offset = 0;
          for(offset = 0; offset < maxOffset; ++offset)
          {
             if (theMaskType == OSSIM_MASK_TYPE_BINARY_INVERSE)
             {
                if(*bufMask)      // if mask == 1
                   *bufOut = MP;  // set to max pix
                else              // if mask == 0
                   *bufOut = NP;  // set to null pix
             }
             else
             {
                if(*bufMask)      // if mask == 1
                   *bufOut = NP;  // set to null pix
                else              // if mask == 0
                   *bufOut = MP;  // set to max pix
             }
             ++bufOut;
             ++bufMask;
          }
       }
       theTile->validate();
    }
    
    return theTile;
 }

◆ executeMaskFilterInvertSelect()

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilterInvertSelect	(	ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

protected

will execute the invert selection algorithm.

everywhere the mask is 0 it copies the input data to the output else it outputs null.

Definition at line 243 of file ossimMaskFilter.cpp.

References executeMaskFilterInvertSelection(), ossimRectilinearDataObject::getScalarType(), OSSIM_DOUBLE, OSSIM_FLOAT, OSSIM_NORMALIZED_DOUBLE, OSSIM_NORMALIZED_FLOAT, OSSIM_SSHORT16, OSSIM_UCHAR, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, OSSIM_USHORT16, ossimNotify(), ossimNotifyLevel_WARN, and theTile.

Referenced by executeMaskFilter().

 {
    if(maskSourceData->getScalarType() != OSSIM_UCHAR)
    {
       ossimNotify(ossimNotifyLevel_WARN) << "ossimMaskFilter::executeMaskFilterSelect WARNING: Only uchar masks are supported" << endl;
       return imageSourceData;
    }
 
    switch(imageSourceData->getScalarType())
    {
    case OSSIM_UCHAR:
    {
       executeMaskFilterInvertSelection((ossim_uint8)0,
                                        (ossim_uint8)0,
                                        imageSourceData,
                                        maskSourceData);
       break;
    }
    case OSSIM_USHORT11:
    case OSSIM_USHORT12:
    case OSSIM_USHORT13:
    case OSSIM_USHORT14:
    case OSSIM_USHORT15:
    case OSSIM_USHORT16:
    {
       executeMaskFilterInvertSelection((ossim_uint16)0,
                                        (ossim_uint8)0,
                                        imageSourceData,
                                        maskSourceData);
       break;
    }
    case OSSIM_SSHORT16:
    {
       executeMaskFilterInvertSelection((ossim_sint16)0,
                                        (ossim_uint8)0,
                                        imageSourceData,
                                        maskSourceData);
       break;
    }
    case OSSIM_FLOAT:
    case OSSIM_NORMALIZED_FLOAT:
    {
       executeMaskFilterInvertSelection((float)0,
                                        (ossim_uint8)0,
                                        imageSourceData,
                                        maskSourceData);
       break;
    }
    case OSSIM_DOUBLE:
    case OSSIM_NORMALIZED_DOUBLE:
    {
       executeMaskFilterInvertSelection((double)0,
                                        (ossim_uint8)0,
                                        imageSourceData,
                                        maskSourceData);
       break;
    }
    default:
    {
       ossimNotify(ossimNotifyLevel_WARN) << "ossimMaskFilter::executeMaskFilterSelect WARNING: Unknown scalar type" << endl;
       break;
    }   
    }
 
    return theTile;
 }

◆ executeMaskFilterInvertSelection()

template<class inputT , class maskT >

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilterInvertSelection	(	inputT	dummyInput,
		maskT	dummyMask,
		ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

protected

Definition at line 524 of file ossimMaskFilter.cpp.

References ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getHeight(), ossimImageData::getNullPix(), ossimImageData::getNumberOfBands(), ossimImageData::getWidth(), ossimImageData::makeBlank(), OSSIM_EMPTY, OSSIM_FULL, OSSIM_NULL, theTile, and ossimImageData::validate().

Referenced by executeMaskFilterInvertSelect().

 {
    ossimDataObjectStatus maskDataStatus  = maskSourceData->getDataObjectStatus();
    ossimDataObjectStatus inputDataStatus = imageSourceData->getDataObjectStatus();
 
    // First just check if mask is empty, which means pass the image source along untouched:
    if( (maskDataStatus == OSSIM_NULL) || (maskDataStatus == OSSIM_EMPTY))
    {
       theTile = imageSourceData;
       return theTile;
    }
 
    // Then check for a total mask (all mask values are 1) and return empty tile if so:
    if (maskDataStatus == OSSIM_FULL)
    {
       theTile->makeBlank();
       return theTile;
    }
 
    // Finally check for blank source tile and return it if so:
    if( (inputDataStatus == OSSIM_NULL) || (inputDataStatus == OSSIM_EMPTY))
    {
       theTile->makeBlank();
       return theTile;
    }
 
    ossim_uint32 maskBands  = maskSourceData->getNumberOfBands();
    ossim_uint32 inputBands = imageSourceData->getNumberOfBands();
    if(maskBands&&inputBands)
    {
       ossim_uint32 maxOffset = theTile->getWidth()*theTile->getHeight();
       for(ossim_uint32 band = 0; band < inputBands; ++band)
       {
          maskT*    bufMask = (maskT*)maskSourceData->getBuf();
          inputT* bufIn     = (inputT*)imageSourceData->getBuf(band);
          inputT* bufOut    = (inputT*)theTile->getBuf(band);
          inputT  np        = (inputT)theTile->getNullPix(band);
          ossim_uint32 offset = 0;
          for(offset = 0; offset < maxOffset; ++offset)
          {
             if(!*bufMask)
             {
                *bufOut = *bufIn;
             }
             else
             {
                *bufOut = np;
             }
             ++bufOut;
             ++bufIn;
             ++bufMask;
          }
       }
       theTile->validate();
    }
    
    return theTile;
 }

◆ executeMaskFilterSelect()

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilterSelect	(	ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

protected

will execute the section algorithm.

everywhere the mask is not 0 it copies the input data to the output and everywhere the input is null it writes a null pixel to the output.

Definition at line 174 of file ossimMaskFilter.cpp.

References executeMaskFilterSelection(), ossimRectilinearDataObject::getScalarType(), OSSIM_DOUBLE, OSSIM_FLOAT, OSSIM_NORMALIZED_DOUBLE, OSSIM_NORMALIZED_FLOAT, OSSIM_SSHORT16, OSSIM_UCHAR, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, OSSIM_USHORT16, ossimNotify(), ossimNotifyLevel_WARN, and theTile.

Referenced by executeMaskFilter().

 {
    if(maskSourceData->getScalarType() != OSSIM_UCHAR)
    {
       ossimNotify(ossimNotifyLevel_WARN) << "ossimMaskFilter::executeMaskFilterSelect WARNING: Only uchar masks are supported" << endl;
       return imageSourceData;
    }
 
    switch(imageSourceData->getScalarType())
    {
    case OSSIM_UCHAR:
    {
       executeMaskFilterSelection((ossim_uint8)0,
                                  (ossim_uint8)0,
                                  imageSourceData,
                                  maskSourceData);
       break;
    }
    case OSSIM_USHORT11:
    case OSSIM_USHORT12:
    case OSSIM_USHORT13:
    case OSSIM_USHORT14:
    case OSSIM_USHORT15:
    case OSSIM_USHORT16:
    {
       executeMaskFilterSelection((ossim_uint16)0,
                                  (ossim_uint8)0,
                                  imageSourceData,
                                  maskSourceData);
       break;
    }
    case OSSIM_SSHORT16:
    {
       executeMaskFilterSelection((ossim_sint16)0,
                                  (ossim_uint8)0,
                                  imageSourceData,
                                  maskSourceData);
       break;
    }
    case OSSIM_FLOAT:
    case OSSIM_NORMALIZED_FLOAT:
    {
       executeMaskFilterSelection((float)0,
                                  (ossim_uint8)0,
                                  imageSourceData,
                                  maskSourceData);
       break;
    }
    case OSSIM_DOUBLE:
    case OSSIM_NORMALIZED_DOUBLE:
    {
       executeMaskFilterSelection((double)0,
                                  (ossim_uint8)0,
                                  imageSourceData,
                                  maskSourceData);
       break;
    }
    default:
    {
       ossimNotify(ossimNotifyLevel_WARN) << "ossimMaskFilter::executeMaskFilterSelect WARNING: Unknown scalar type" << endl;
       break;
    }   
    }
 
    return theTile;
 }

◆ executeMaskFilterSelection()

template<class inputT , class maskT >

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilterSelection	(	inputT	dummyInput,
		maskT	dummyMask,
		ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

protected

Definition at line 448 of file ossimMaskFilter.cpp.

References ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getHeight(), ossimImageData::getMinPix(), ossimImageData::getNullPix(), ossimImageData::getNumberOfBands(), ossimImageData::getWidth(), ossimImageData::makeBlank(), OSSIM_EMPTY, OSSIM_FULL, OSSIM_MASK_TYPE_SELECT, OSSIM_NULL, theMaskType, theTile, and ossimImageData::validate().

Referenced by executeMaskFilterSelect().

 {
    ossimDataObjectStatus maskDataStatus  = maskSourceData->getDataObjectStatus();
    ossimDataObjectStatus inputDataStatus = imageSourceData->getDataObjectStatus();
 
    // First just check if mask is full, which means pass the image source along untouched:
    if (maskDataStatus == OSSIM_FULL)
    {
       theTile = imageSourceData;
       return theTile;
    }
 
    // Then check for a total mask (all mask values are 0) and return empty tile if so:
    if( (maskDataStatus == OSSIM_NULL) || (maskDataStatus == OSSIM_EMPTY))
    {
       theTile->makeBlank();
       return theTile;
    }
 
    // Finally check for blank source tile and return it if so:
    if( (inputDataStatus == OSSIM_NULL) || (inputDataStatus == OSSIM_EMPTY))
    {
       theTile->makeBlank();
       return theTile;
    }
 
    ossim_uint32 maskBands  = maskSourceData->getNumberOfBands();
    ossim_uint32 inputBands = imageSourceData->getNumberOfBands();
    if(maskBands&&inputBands)
    {
       ossim_uint32 maxOffset = theTile->getWidth()*theTile->getHeight();
       for(ossim_uint32 band = 0; band < inputBands; ++band)
       {
          maskT*  bufMask = static_cast<maskT*> ( maskSourceData->getBuf() );
          inputT* bufIn   = static_cast<inputT*>( imageSourceData->getBuf(band) );
          inputT* bufOut  = static_cast<inputT*>( theTile->getBuf(band) );
          inputT  nullPix = static_cast<inputT> ( theTile->getNullPix(band) );
          inputT  minPix  = static_cast<inputT> ( theTile->getMinPix(band) );
          ossim_uint32 offset = 0;
          for(offset = 0; offset < maxOffset; ++offset)
          {
             if(*bufMask)
             {
                if ( theMaskType == OSSIM_MASK_TYPE_SELECT )
                {
                   *bufOut = *bufIn;
                }
                else
                {
                   //---
                   // OSSIM_MASK_TYPE_SELECT_CLAMP_MIN
                   // Use input pixel clamping any nulls to min.
                   //---
                   *bufOut = *bufIn != nullPix ? *bufIn : minPix;
                }
             }
             else
             {
                *bufOut = nullPix;
             }
             ++bufOut;
             ++bufIn;
             ++bufMask;
          }
       }
       theTile->validate();
    }
    
    return theTile;
 }

◆ executeMaskFilterWeighted() [1/2]

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilterWeighted	(	ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

protected

will execute the weighted algorithm.

It normalizes the mask value to be between 0 and 1 and multiplies the input data by that value and outputs it.

Definition at line 311 of file ossimMaskFilter.cpp.

References ossimRectilinearDataObject::getScalarType(), OSSIM_DOUBLE, OSSIM_FLOAT, OSSIM_NORMALIZED_DOUBLE, OSSIM_NORMALIZED_FLOAT, OSSIM_SSHORT16, OSSIM_UCHAR, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, OSSIM_USHORT16, ossimNotify(), ossimNotifyLevel_WARN, and theTile.

Referenced by executeMaskFilter().

 {
    if(maskSourceData->getScalarType() != OSSIM_UCHAR)
    {
       ossimNotify(ossimNotifyLevel_WARN) << "ossimMaskFilter::executeMaskFilterSelect WARNING: Only uchar masks are supported" << endl;
       return imageSourceData;
    }
 
    switch(imageSourceData->getScalarType())
    {
    case OSSIM_UCHAR:
    {
       executeMaskFilterWeighted((ossim_uint8)0,
                                 (ossim_uint8)0,
                                 imageSourceData,
                                 maskSourceData);
       break;
    }
    case OSSIM_USHORT11:
    case OSSIM_USHORT12:
    case OSSIM_USHORT13:
    case OSSIM_USHORT14:
    case OSSIM_USHORT15:
    case OSSIM_USHORT16:
    {
       executeMaskFilterWeighted((ossim_uint16)0,
                                 (ossim_uint8)0,
                                 imageSourceData,
                                 maskSourceData);
       break;
    }
    case OSSIM_SSHORT16:
    {
       executeMaskFilterWeighted((ossim_sint16)0,
                                 (ossim_uint8)0,
                                 imageSourceData,
                                 maskSourceData);
       break;
    }
    case OSSIM_FLOAT:
    case OSSIM_NORMALIZED_FLOAT:
    {
       executeMaskFilterWeighted((float)0,
                                 (ossim_uint8)0,
                                 imageSourceData,
                                 maskSourceData);
       break;
    }
    case OSSIM_DOUBLE:
    case OSSIM_NORMALIZED_DOUBLE:
    {
       executeMaskFilterWeighted((double)0,
                                 (ossim_uint8)0,
                                 imageSourceData,
                                 maskSourceData);
       break;
    }
    default:
    {
       ossimNotify(ossimNotifyLevel_WARN) << "ossimMaskFilter::executeMaskFilterSelect WARNING: Unknown scalar type" << endl;
       break;
    }   
    }
 
    return theTile;
 }

◆ executeMaskFilterWeighted() [2/2]

template<class inputT , class maskT >

ossimRefPtr< ossimImageData > ossimMaskFilter::executeMaskFilterWeighted	(	inputT	dummyInput,
		maskT	dummyMask,
		ossimRefPtr< ossimImageData >	imageSourceData,
		ossimRefPtr< ossimImageData >	maskSourceData
	)

protected

Definition at line 588 of file ossimMaskFilter.cpp.

References ossimImageData::getBuf(), ossimDataObject::getDataObjectStatus(), ossimImageData::getHeight(), ossimImageData::getMinPix(), ossimImageData::getNullPix(), ossimImageData::getNumberOfBands(), ossimImageData::getWidth(), ossimImageData::makeBlank(), OSSIM_EMPTY, OSSIM_NULL, OSSIM_PARTIAL, theTile, and ossimImageData::validate().

 {
    ossimDataObjectStatus maskDataStatus  = maskSourceData->getDataObjectStatus();
    ossimDataObjectStatus inputDataStatus = imageSourceData->getDataObjectStatus();
 
    if( (maskDataStatus == OSSIM_NULL)||
        (maskDataStatus == OSSIM_EMPTY))
    {
       theTile->makeBlank();
       return theTile;
    }
    if( (inputDataStatus == OSSIM_NULL)||
        (inputDataStatus == OSSIM_EMPTY))
    {
       return theTile;
    }
    
    ossim_uint32 maskBands  = maskSourceData->getNumberOfBands();
    ossim_uint32 inputBands = imageSourceData->getNumberOfBands();
    if(maskBands&&inputBands)
    {
       ossim_uint32 maxOffset = theTile->getWidth()*theTile->getHeight();
       for(ossim_uint32 band = 0; band < inputBands; ++band)
       {
          maskT*    bufMask = (maskT*)maskSourceData->getBuf();
          inputT* bufIn     = (inputT*)imageSourceData->getBuf(band);
          inputT* bufOut    = (inputT*)theTile->getBuf(band);
          inputT  np        = (inputT)theTile->getNullPix(band);
          inputT  minp      = (inputT)theTile->getMinPix(band);
          ossim_uint32 offset = 0;
 
          if(inputDataStatus == OSSIM_PARTIAL)
          {
             for(offset = 0; offset < maxOffset; ++offset)
             {
                if(*bufIn != np)
                {
                   *bufOut = (inputT)((*bufIn)*((double)(*bufMask)/255.0));
                   if((*bufOut != np)&&
                      (*bufOut < minp))
                   {
                      *bufOut = minp;
                   }
                }
                else
                {
                   *bufOut = np;
                }
                ++bufOut;
                ++bufIn;
                ++bufMask;
             }
          }
          else
          {
             for(offset = 0; offset < maxOffset; ++offset)
             {
                *bufOut = (inputT)((*bufIn)*((double)(*bufMask)/255.0));
                if((*bufOut != np)&&
                   (*bufOut < minp))
                {
                   *bufOut = minp;
                }
                ++bufOut;
                ++bufIn;
                ++bufMask;
             }
          }
       }
       theTile->validate();
    }
    
    return theTile;
 }

◆ getMaskType()

ossimMaskFilter::ossimFileSelectionMaskType ossimMaskFilter::getMaskType ( ) const

virtual

Returns the current mask algorithm used.

Returns: the current ossimFileSelectionMaskType used.

Definition at line 751 of file ossimMaskFilter.cpp.

References theMaskType.

 {
    return theMaskType;
 }

◆ getMaskTypeString()

ossimString ossimMaskFilter::getMaskTypeString ( ) const

virtual

Returns the current mask algorithm used as a string.

Returns: the current ossimFileSelectionMaskType used.

Definition at line 756 of file ossimMaskFilter.cpp.

References OSSIM_MASK_TYPE_BINARY, OSSIM_MASK_TYPE_BINARY_INVERSE, OSSIM_MASK_TYPE_INVERT, OSSIM_MASK_TYPE_SELECT, OSSIM_MASK_TYPE_SELECT_CLAMP_MIN, OSSIM_MASK_TYPE_WEIGHTED, and theMaskType.

 {
    ossimString maskType;
    
    switch(theMaskType)
    {
       case OSSIM_MASK_TYPE_SELECT:
       {
          maskType = "select";
          break;
       }
       case OSSIM_MASK_TYPE_INVERT:
       {
          maskType = "invert";
          break;
       }
       case OSSIM_MASK_TYPE_WEIGHTED:
       {
          maskType = "weighted";
          break;
       }
       case OSSIM_MASK_TYPE_BINARY:
       {
          maskType = "binary";
          break;
       }
       case OSSIM_MASK_TYPE_BINARY_INVERSE:
       {
          maskType = "binary_inverse";
          break;
       }
       case OSSIM_MASK_TYPE_SELECT_CLAMP_MIN:
       {
          maskType = "select_clamp_min";
          break;
       }
    }
 
    return maskType;
 }

◆ getNumberOfInputBands()

ossim_uint32 ossimMaskFilter::getNumberOfInputBands ( ) const

virtual

Returns the number of bands available from the input.

Implements ossimImageSource.

Definition at line 871 of file ossimMaskFilter.cpp.

References ossimConnectableObject::getInput(), ossimImageSource::getNumberOfInputBands(), and PTR_CAST.

 {
    ossimImageSource* img_source = PTR_CAST(ossimImageSource, getInput());
    if (img_source)
       return img_source->getNumberOfInputBands();
    return 0;
 }

◆ getProperty()

ossimRefPtr< ossimProperty > ossimMaskFilter::getProperty ( const ossimString & name ) const

virtual

Returns: "mask_type" property.

Reimplemented from ossimImageSource.

Definition at line 841 of file ossimMaskFilter.cpp.

 {
    ossimRefPtr<ossimProperty> result = 0;
    
    if(name == MASK_FILTER_MASK_TYPE_KW)
    {
       std::vector<ossimString> constraintList;
       constraintList.push_back(ossimString("select"));
       constraintList.push_back(ossimString("invert"));
       constraintList.push_back(ossimString("weighted"));
       
       result = new ossimStringProperty(MASK_FILTER_MASK_TYPE_KW,
                                        getMaskTypeString(),
                                        false,
                                        constraintList);
    }
    else
    {
       result = ossimImageSource::getProperty(name);
    }
    return result;
 }

◆ getPropertyNames()

void ossimMaskFilter::getPropertyNames ( std::vector< ossimString > & propertyNames ) const

virtual

Adds "mask_type" to list.

Reimplemented from ossimImageSource.

Definition at line 865 of file ossimMaskFilter.cpp.

References ossimImageSource::getPropertyNames().

 {
    ossimImageSource::getPropertyNames(propertyNames);
    propertyNames.push_back(MASK_FILTER_MASK_TYPE_KW);
 }

◆ getTile()

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

virtual

Main entry point for the algorithm.

Parameters

rect

Reimplemented from ossimImageSource.

Definition at line 46 of file ossimMaskFilter.cpp.

References allocate(), executeMaskFilter(), ossimDataObject::getDataObjectStatus(), ossimImageData::getImageRectangle(), ossimConnectableObject::getInput(), ossimImageSource::getTile(), ossimImageData::initialize(), ossimSource::isSourceEnabled(), OSSIM_NULL, PTR_CAST, ossimImageData::setImageRectangle(), ossimImageData::setOrigin(), theMaskSource, theTile, ossimIrect::ul(), and ossimRefPtr< T >::valid().

Referenced by ossimOverviewSequencer::getNextTile().

 {
    ossimImageSource* imageSource = PTR_CAST(ossimImageSource, getInput(0));
    if (!imageSource || !theMaskSource.valid())
    {
       ossimRefPtr<ossimImageData>();
       return theTile;
    }
 
    ossimRefPtr<ossimImageData> imageSourceData;
    ossimRefPtr<ossimImageData> maskSourceData;
    
    imageSourceData = imageSource->getTile(rect, resLevel);
    if(!isSourceEnabled())
       return imageSourceData;
    
    if (!theTile.valid())
       allocate();
 
    maskSourceData = theMaskSource->getTile(rect, resLevel);
    if(!imageSourceData.valid() || !theTile.valid())
    {
       return ossimRefPtr<ossimImageData>();
    }
    
    theTile->setOrigin(rect.ul());
    if(theTile->getImageRectangle() != rect)
    {
       theTile->setImageRectangle(rect);
       theTile->initialize();
    }
    if(!imageSourceData.valid())
    {
       return theTile;
    }
    if(!maskSourceData.valid()) 
    {
       return imageSourceData;
    }
    
    if(imageSourceData->getDataObjectStatus() != OSSIM_NULL)
    {
       return executeMaskFilter(imageSourceData, maskSourceData);  
    }
    
    return theTile;
 }

◆ initialize()

void ossimMaskFilter::initialize ( )

virtual

Implements ossimImageSource.

Definition at line 101 of file ossimMaskFilter.cpp.

References ossimConnectableObject::getInput(), and theTile.

 {
    if(getInput(0))
    {
       // Force an allocate on the next getTile.
       theTile = 0;
    }
 }

◆ loadState()

bool ossimMaskFilter::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)

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

Definition at line 797 of file ossimMaskFilter.cpp.

References ossimKeywordlist::find(), ossimImageSource::loadState(), ossimConnectableObject::setNumberOfInputs(), ossimConnectableObject::theInputListIsFixedFlag, and ossimConnectableObject::theOutputListIsFixedFlag.

 {
    bool result = ossimImageSource::loadState(kwl, prefix);
    
    theInputListIsFixedFlag  = true;
    theOutputListIsFixedFlag = false;
    setNumberOfInputs(2);
 
    const char* lookup = kwl.find(prefix, MASK_FILTER_MASK_TYPE_KW);
    if (lookup)
    {
       setMaskType(ossimString(lookup));
    }
 
    return result;
 }

◆ saveState()

bool ossimMaskFilter::saveState	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

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

Return true if ok or false on error.

Reimplemented from ossimImageSource.

Definition at line 815 of file ossimMaskFilter.cpp.

References ossimKeywordlist::add().

 {
    kwl.add(prefix,
            MASK_FILTER_MASK_TYPE_KW,
            getMaskTypeString().c_str(),
            true);
    
    return ossimImageSource::saveState(kwl, prefix);
 }

◆ setMaskSource()

void ossimMaskFilter::setMaskSource ( ossimImageSource * maskSource )

This set method is necessary when this object is being added to an ossimImageChain because ossimImageChain::addLast() performs a disconnect of all the input sources, thus losing the assignments made via constructor accepting source pointers.

If the intent is to insert this object in place of the image handler in a chain, First remove the handler from the chain, then add a default-constructed mask filter object, then call this method to assign the inputs.

Definition at line 41 of file ossimMaskFilter.cpp.

References theMaskSource.

 {
    theMaskSource = maskSource;
 }

◆ setMaskType() [1/2]

void ossimMaskFilter::setMaskType ( ossimFileSelectionMaskType type )

virtual

Sets the mask type.

Parameters

type	The mask algorithm type to be used. see ossimFileSelectionMaskType

Definition at line 712 of file ossimMaskFilter.cpp.

References theMaskType.

 {
    theMaskType = type;
 }

◆ setMaskType() [2/2]

void ossimMaskFilter::setMaskType ( const ossimString & type )

virtual

Sets the mask type from string.

Valid strings are: "select", "invert" and "weighted".

Parameters

type	The mask algorithm type to be used.

Definition at line 717 of file ossimMaskFilter.cpp.

References ossimString::downcase(), OSSIM_MASK_TYPE_BINARY, OSSIM_MASK_TYPE_BINARY_INVERSE, OSSIM_MASK_TYPE_INVERT, OSSIM_MASK_TYPE_SELECT, OSSIM_MASK_TYPE_SELECT_CLAMP_MIN, OSSIM_MASK_TYPE_WEIGHTED, and theMaskType.

 {
    if(type != "")
    {
       ossimString maskType = type;
       maskType.downcase();
 
       if(maskType == "select")
       {
          theMaskType = OSSIM_MASK_TYPE_SELECT;
       }
       else if(maskType == "invert")
       {
          theMaskType = OSSIM_MASK_TYPE_INVERT;
       }
       else if(maskType == "weighted")
       {
          theMaskType = OSSIM_MASK_TYPE_WEIGHTED;
       }
       else if(maskType == "binary")
       {
          theMaskType = OSSIM_MASK_TYPE_BINARY;
       }
       else if(maskType == "binary_inverse")
       {
          theMaskType = OSSIM_MASK_TYPE_BINARY_INVERSE;
       }
       else if(maskType == "select_clamp_min")
       {
          theMaskType = OSSIM_MASK_TYPE_SELECT_CLAMP_MIN;
       } 
    }
 }

◆ setProperty()

void ossimMaskFilter::setProperty ( ossimRefPtr< ossimProperty > property )

virtual

Interface to set the mask type.

Reimplemented from ossimImageSource.

Definition at line 826 of file ossimMaskFilter.cpp.

References ossimProperty::getName(), and ossimRefPtr< T >::valid().

 {
    if( property.valid() )
    {
       if(property->getName() == MASK_FILTER_MASK_TYPE_KW)
       {
          setMaskType(property->valueToString());
       }
       else
       {
          ossimImageSource::setProperty(property);
       }
    }
 }

Member Data Documentation

◆ theMaskSource

ossimRefPtr<ossimImageSource> ossimMaskFilter::theMaskSource

protected

Definition at line 261 of file ossimMaskFilter.h.

Referenced by getTile(), and setMaskSource().

◆ theMaskType

ossimFileSelectionMaskType ossimMaskFilter::theMaskType

protected

Member variable that holds the algorithm type to run on the calls to getTile.

Definition at line 254 of file ossimMaskFilter.h.

Referenced by executeMaskFilter(), executeMaskFilterBinarySelection(), executeMaskFilterSelection(), getMaskType(), getMaskTypeString(), and setMaskType().

◆ theTile

ossimRefPtr<ossimImageData> ossimMaskFilter::theTile

protected

Member used to store the result of the applied algorithm type.

This is returned from the call to getTile.

Definition at line 260 of file ossimMaskFilter.h.

Referenced by allocate(), executeMaskFilter(), executeMaskFilterBinary(), executeMaskFilterBinarySelection(), executeMaskFilterInvertSelect(), executeMaskFilterInvertSelection(), executeMaskFilterSelect(), executeMaskFilterSelection(), executeMaskFilterWeighted(), 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

◆ ossimFileSelectionMaskType

Constructor & Destructor Documentation

◆ ossimMaskFilter()

◆ ~ossimMaskFilter()

Member Function Documentation

◆ allocate()

◆ canConnectMyInputTo()

◆ executeMaskFilter()

◆ executeMaskFilterBinary()

◆ executeMaskFilterBinarySelection()

◆ executeMaskFilterInvertSelect()

◆ executeMaskFilterInvertSelection()

◆ executeMaskFilterSelect()

◆ executeMaskFilterSelection()

◆ executeMaskFilterWeighted() [1/2]

◆ executeMaskFilterWeighted() [2/2]

◆ getMaskType()

◆ getMaskTypeString()

◆ getNumberOfInputBands()

◆ getProperty()

◆ getPropertyNames()

◆ getTile()

◆ initialize()

◆ loadState()

◆ saveState()

◆ setMaskSource()

◆ setMaskType() [1/2]

◆ setMaskType() [2/2]

◆ setProperty()

Member Data Documentation

◆ theMaskSource

◆ theMaskType

◆ theTile