ossimKMeansFilter Class Reference

#include <ossimKMeansFilter.h>

Inheritance diagram for ossimKMeansFilter:

Public Types
enum	ThresholdMode { NONE =0, MEAN =1, SIGMA_WEIGHTED =2, VARIANCE_WEIGHTED =3 }
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
	ossimKMeansFilter ()
	ossimKMeansFilter (ossimImageSource *input_source, ossimMultiBandHistogram *histogram=0)
	Quicker constructor handles connections to source and optional histogram. More...
	~ossimKMeansFilter ()
virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &origin, ossim_uint32 resLevel=0)
virtual ossimScalarType	getOutputScalarType () const
	This will be used to query the output pixel type of the tile source. More...
void	setInputHistogram (ossimMultiBandHistogram *histo)
	Sets the input source's histogram for quicker K-means analysis. More...
void	setNumClusters (ossim_uint32 K)
	Defines how many classification clusters will be resolved. More...
void	setClusterPixelValues (const ossim_uint32 *dns, ossim_uint32 K)
	Optionally define the output digital numbers for each cluster to be used for remapping the input pixels. More...
void	setThresholdMode (ThresholdMode mode)
	Special use case is to use K-means for thresholding an image into two values based on the histogram's clustering. More...
const ossimKMeansClustering *	getBandClassifier (ossim_uint32 band=0) const
	Callers may be interested in reporting the cluster statistics computed by this class. More...
virtual double	getMinPixelValue (ossim_uint32 band=0) const
	Returns the min pixel of the band. More...
virtual double	getMaxPixelValue (ossim_uint32 band=0) const
	Returns the max pixel of the band. More...
virtual void	initialize ()
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=NULL) const
	Method to save the state of an object to a keyword list. More...
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=NULL)
	Method to the load (recreate) the state of an object from a keyword list. More...
Public Member Functions inherited from ossimImageSourceFilter
	ossimImageSourceFilter (ossimObject *owner=NULL)
	ossimImageSourceFilter (ossimImageSource *inputSource)
	ossimImageSourceFilter (ossimObject *owner, ossimImageSource *inputSource)
virtual void	getOutputBandList (std::vector< ossim_uint32 > &bandList) const
virtual ossim_uint32	getNumberOfInputBands () const
bool	canConnectMyInputTo (ossim_int32 inputIndex, const ossimConnectableObject *object) const
	required to be overriden by derived classes More...
virtual void	connectInputEvent (ossimConnectionEvent &event)
virtual void	disconnectInputEvent (ossimConnectionEvent &event)
virtual void	propertyEvent (ossimPropertyEvent &event)
virtual void	refreshEvent (ossimRefreshEvent &event)
virtual void	setProperty (ossimRefPtr< ossimProperty > property)
virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const
virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
Public Member Functions inherited from ossimImageSource
	ossimImageSource (ossimObject *owner=0)
	ossimImageSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)
virtual	~ossimImageSource ()
virtual ossimRefPtr< ossimImageData >	getTile (const ossimIpt &origin, ossim_uint32 resLevel=0)
virtual bool	getTile (ossimImageData *result, ossim_uint32 resLevel=0)
	Method to get a tile. More...
virtual ossimObject *	getObject ()
	For RTTI support. More...
virtual const ossimObject *	getObject () const
	For RTTI support. More...
virtual void	getDecimationFactor (ossim_uint32 resLevel, ossimDpt &result) const
	Will return the decimation factor for the given resolution level. More...
virtual void	getDecimationFactors (std::vector< ossimDpt > &decimations) const
	Will return an array of all decimations for each resolution level. More...
virtual ossim_uint32	getNumberOfDecimationLevels () const
	Will return the number of resolution levels. More...
virtual ossim_uint32	getNumberOfOutputBands () const
	Returns the number of bands in a tile returned from this TileSource. More...
virtual ossim_uint32	getTileWidth () const
	Returns the default processing tile width. More...
virtual ossim_uint32	getTileHeight () const
	Returns the default processing tile height. More...
virtual double	getNullPixelValue (ossim_uint32 band=0) const
	Each band has a null pixel associated with it. More...
virtual 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
bool	computeKMeans ()
void	allocate ()
	Called on first getTile, will initialize all data needed. More...
void	clear ()
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< ossimRefPtr< ossimKMeansClustering > >	m_classifiers
ossimRefPtr< ossimMultiBandHistogram >	m_histogram
	Have num_bands entries. More...
ossim_uint32	m_numClusters
std::vector< ossim_uint32 >	m_pixelValues
std::vector< double >	m_minPixelValue
std::vector< double >	m_maxPixelValue
ossimRefPtr< ossimImageData >	m_tile
ossimScalarType	m_outputScalarType
bool	m_initialized
ThresholdMode	m_thresholdMode
std::vector< double >	m_thresholds
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 50 of file ossimKMeansFilter.h.

Member Enumeration Documentation

ThresholdMode

enum ossimKMeansFilter::ThresholdMode

Enumerator
NONE
MEAN
SIGMA_WEIGHTED
VARIANCE_WEIGHTED

Definition at line 53 of file ossimKMeansFilter.h.

{ NONE=0, MEAN=1, SIGMA_WEIGHTED=2, VARIANCE_WEIGHTED=3 };

Constructor & Destructor Documentation

ossimKMeansFilter() [1/2]

ossimKMeansFilter::ossimKMeansFilter

(

)

Definition at line 23 of file ossimKMeansFilter.cpp.

References ossimConnectableObject::setDescription().

:   ossimImageSourceFilter(),
    m_numClusters(0),
    m_tile(0),
    m_outputScalarType(OSSIM_SCALAR_UNKNOWN),
    m_initialized(false),
    m_thresholdMode(NONE)
{
   setDescription("K-Means pixel classification filter.");
}

ossimKMeansFilter() [2/2]

ossimKMeansFilter::ossimKMeansFilter	(	ossimImageSource *	input_source,
		ossimMultiBandHistogram *	histogram = 0
	)

Quicker constructor handles connections to source and optional histogram.

Definition at line 34 of file ossimKMeansFilter.cpp.

References ossimConnectableObject::setDescription().

:   ossimImageSourceFilter(input_source),
    m_histogram (histogram),
    m_numClusters(0),
    m_tile(0),
    m_outputScalarType(OSSIM_SCALAR_UNKNOWN),
    m_initialized(false),
    m_thresholdMode(NONE)
{
   setDescription("K-Means pixel classification filter.");
}

~ossimKMeansFilter()

ossimKMeansFilter::~ossimKMeansFilter

(

)

Definition at line 47 of file ossimKMeansFilter.cpp.

{
}

Member Function Documentation

allocate()

void ossimKMeansFilter::allocate ( )

protected

Called on first getTile, will initialize all data needed.

Definition at line 146 of file ossimKMeansFilter.cpp.

References ossimImageDataFactory::create(), ossimImageSourceFilter::getNumberOfInputBands(), initialize(), ossimImageData::initialize(), ossimImageDataFactory::instance(), m_classifiers, m_initialized, m_numClusters, m_tile, max, min, ossimImageData::setMaxPix(), ossimImageData::setMinPix(), and ossimRefPtr< T >::valid().

Referenced by getTile().

{
   if (!m_initialized)
   {
      initialize();
      if (!m_initialized)
         return;
   }

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

   ossim_uint32 numBands = getNumberOfInputBands();
   if (m_numClusters && (m_classifiers.size() == numBands))
   {
      for (ossim_uint32 band=0; band<numBands; band++)
      {
         double min = m_classifiers[band]->getCluster(0)->min;
         double max = m_classifiers[band]->getCluster(0)->max;

         for (ossim_uint32 gid=1; gid<m_numClusters; gid++)
         {
            if (m_classifiers[band]->getCluster(gid)->min < min)
               min = m_classifiers[band]->getCluster(gid)->min;
            if (m_classifiers[band]->getCluster(gid)->max > max)
               max = m_classifiers[band]->getCluster(gid)->max;
         }
         m_tile->setMinPix(min, band);
         m_tile->setMaxPix(max, band);
      }
   }
   m_tile->initialize();
}

clear()

void ossimKMeansFilter::clear ( )

protected

Definition at line 286 of file ossimKMeansFilter.cpp.

References m_classifiers, m_initialized, and m_numClusters.

Referenced by setNumClusters().

{
   m_classifiers.clear();
   m_numClusters = 0;
   m_initialized = false;
}

computeKMeans()

bool ossimKMeansFilter::computeKMeans ( )

protected

Definition at line 220 of file ossimKMeansFilter.cpp.

References ossimKMeansClustering::computeKmeans(), ossimHistogram::GetCounts(), ossimMultiBandHistogram::getHistogram(), ossimKMeansClustering::getMean(), ossimImageSourceFilter::getNumberOfInputBands(), ossimKMeansClustering::getNumClusters(), ossimHistogram::GetRes(), ossimKMeansClustering::getSigma(), ossimHistogram::GetVals(), initialize(), m_classifiers, m_histogram, m_initialized, m_numClusters, m_thresholdMode, m_thresholds, MEAN, NONE, ossimKMeansClustering::setNumClusters(), ossimKMeansClustering::setPopulations(), ossimKMeansClustering::setSamples(), ossimKMeansClustering::setVerbose(), SIGMA_WEIGHTED, ossimRefPtr< T >::valid(), and VARIANCE_WEIGHTED.

Referenced by getTile().

{
   m_classifiers.clear();
   m_thresholds.clear();

   ostringstream xmsg;
   if (m_numClusters == 0)
   {
      xmsg<<"ossimKMeansFilter:"<<__LINE__<<"  Number of groups has not been initialized!";
      throw ossimException(xmsg.str());
   }

   if (!m_initialized)
      initialize();

   ossim_uint32 numBands = getNumberOfInputBands();
   for (ossim_uint32 band=0; band<numBands; band++)
   {
      ossimRefPtr<ossimHistogram> band_histo = m_histogram->getHistogram(band);
      if (!band_histo.valid())
      {
         xmsg<<"ossimKMeansFilter:"<<__LINE__<<"  Null band histogram returned!";
         throw ossimException(xmsg.str());
      }

      ossimRefPtr<ossimKMeansClustering> classifier = new ossimKMeansClustering;
      classifier->setVerbose();
      classifier->setNumClusters(m_numClusters);
      classifier->setSamples(band_histo->GetVals(), band_histo->GetRes());
      classifier->setPopulations(band_histo->GetCounts(), band_histo->GetRes());
      if (!classifier->computeKmeans())
      {
         cout<<"ossimKMeansFilter:"<<__LINE__<<" No K-means clustering data available."<<endl;
         break;
      }
      m_classifiers.push_back(classifier);

      if ((m_thresholdMode != NONE) && (classifier->getNumClusters() == 2))
      {
         double mean0 = classifier->getMean(0);
         double mean1 = classifier->getMean(1);
         double sigma0 = classifier->getSigma(0);
         double sigma1 = classifier->getSigma(1);
         double threshold = 0;
         switch (m_thresholdMode)
         {
         case MEAN:
            threshold = (mean0 + mean1)/2.0;
            break;
         case SIGMA_WEIGHTED:
            threshold = (sigma1*mean0 + sigma0*mean1)/(sigma0 + sigma1);
            break;
         case VARIANCE_WEIGHTED:
            threshold = (sigma1*sigma1*mean0 + sigma0*sigma0*mean1)/(sigma0*sigma0 + sigma1*sigma1);
            break;
         default:
            break;
         }
         m_thresholds.push_back(threshold);
         cout<<"ossimKMeansFilter:"<<__LINE__<<" Using threshold = "<<threshold<<endl;
      }
   }

   return (m_classifiers.size() == numBands);
}

getBandClassifier()

const ossimKMeansClustering * ossimKMeansFilter::getBandClassifier

(

ossim_uint32

band = 0

)

const

Callers may be interested in reporting the cluster statistics computed by this class.

Returns the clusters (of size K) for the band index specified.

Definition at line 331 of file ossimKMeansFilter.cpp.

References m_classifiers.

{
   if (band < m_classifiers.size())
      return m_classifiers[band].get();
   return 0;
}

getMaxPixelValue()

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

virtual

Returns the max pixel of the band.

Reimplemented from ossimImageSource.

Definition at line 414 of file ossimKMeansFilter.cpp.

References m_maxPixelValue.

{
   if (band < m_maxPixelValue.size())
      return m_maxPixelValue[band];
   return 255.0;
}

getMinPixelValue()

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

virtual

Returns the min pixel of the band.

Reimplemented from ossimImageSource.

Definition at line 407 of file ossimKMeansFilter.cpp.

References m_minPixelValue.

{
   if (band < m_minPixelValue.size())
      return m_minPixelValue[band];
   return 1;
}

getOutputScalarType()

ossimScalarType ossimKMeansFilter::getOutputScalarType ( ) const

virtual

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

Please ignore the argument. It will soon be removed.

Reimplemented from ossimImageSource.

Definition at line 395 of file ossimKMeansFilter.cpp.

References m_numClusters, OSSIM_SCALAR_UNKNOWN, OSSIM_UINT16, and OSSIM_UINT8.

{
   ossimScalarType myType = OSSIM_SCALAR_UNKNOWN;

   if (m_numClusters > 255)
      myType = OSSIM_UINT16; // Can't have more than 65535 groups! NOT YET SUPPORTED
   else if (m_numClusters > 0)
         myType = OSSIM_UINT8;

   return myType;
}

getTile()

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

virtual

Returns

the requested region of interest

Reimplemented from ossimImageSource.

Definition at line 58 of file ossimKMeansFilter.cpp.

References allocate(), computeKMeans(), ossimImageData::getBuf(), ossimKMeansClustering::getCluster(), ossimDataObject::getDataObjectStatus(), ossimMultiBandHistogram::getHistogram(), ossimImageSource::getNullPixelValue(), ossimImageSourceFilter::getNumberOfInputBands(), ossimImageData::getPix(), ossimImageSource::getTile(), initialize(), ossimIrect::lr(), m_classifiers, m_histogram, m_initialized, m_numClusters, m_pixelValues, m_thresholds, m_tile, ossimImageData::makeBlank(), ossimKMeansClustering::Cluster::max, ossimKMeansClustering::Cluster::min, OSSIM_EMPTY, ossimImageData::setImageRectangle(), ossimImageSourceFilter::theInputConnection, ossimIrect::ul(), ossimImageData::validate(), ossimIpt::x, and ossimIpt::y.

{
   if(!theInputConnection || (m_numClusters == 0))
      return 0;

   if (!m_initialized)
   {
      initialize();
      if (!m_initialized)
         return 0;
   }
   if (m_classifiers.empty() && !computeKMeans())
      return 0;

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

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

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

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

   // Since a histogram is being used, the bin value reflects a range:
   ossimKMeansClustering* bandClusters = 0;
   const ossimKMeansClustering::Cluster* cluster = 0;
   ossim_uint8* outBuf; // TODO: Only K < 256 is currently supported
   double null_pixel = theInputConnection->getNullPixelValue();
   double pixel;
   ossimIpt ipt;
   ossim_uint32 offset = 0;
   ossim_uint32 numBands = getNumberOfInputBands();
   for (ossim_uint32 band=0; band<numBands; ++band)
   {
      // Need bin size of histogram since only center values were used in clustering:
      double delta = m_histogram->getHistogram(band)->GetBucketSize() / 2.0;
      bandClusters = m_classifiers[band].get();
      outBuf = (ossim_uint8*)(m_tile->getBuf(band));
      for (ipt.y=tileRect.ul().y; ipt.y<=tileRect.lr().y; ++ipt.y)
      {
         for (ipt.x=tileRect.ul().x; ipt.x<=tileRect.lr().x; ++ipt.x)
         {
            pixel = inTile->getPix(ipt, band);
            if (pixel != null_pixel)
            {
               // if thresholding, only interested in the threshold point, not the cluster:
               if (m_thresholds.size() > band)
               {
                  if (pixel <= m_thresholds[band])
                     outBuf[offset] = (ossim_uint8) m_pixelValues[0];
                  else
                     outBuf[offset] = (ossim_uint8) m_pixelValues[1];
               }
               else
               {
                  // Determine its group and remap it using the group's DN:
                  for (ossim_uint32 gid=0; gid<m_numClusters; ++gid)
                  {
                     cluster = bandClusters->getCluster(gid);
                     if (!cluster)
                        continue;
                     if ((pixel >= (cluster->min-delta)) && (pixel <= (cluster->max+delta)))
                     {
                        outBuf[offset] = (ossim_uint8) m_pixelValues[gid];
                        break;
                     }
                  }
               }
            }
            ++offset;
         }
      }
   } // end loop over bands

   m_tile->validate();
   return m_tile;
}

initialize()

void ossimKMeansFilter::initialize ( )

virtual

Reimplemented from ossimImageSourceFilter.

Definition at line 181 of file ossimKMeansFilter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimImageHistogramSource::execute(), ossimMultiBandHistogram::getHistogram(), ossimImageHistogramSource::getHistogram(), ossimMultiResLevelHistogram::getMultiBandHistogram(), ossimImageSourceFilter::getNumberOfInputBands(), ossimHistogram::GetRangeMax(), ossimHistogram::GetRangeMin(), ossimImageSourceFilter::initialize(), m_histogram, m_initialized, m_maxPixelValue, m_minPixelValue, m_tile, OSSIM_HISTO_MODE_FAST, ossimImageHistogramSource::setComputationMode(), ossimImageHistogramSource::setMaxNumberOfRLevels(), ossimImageSourceFilter::theInputConnection, and ossimRefPtr< T >::valid().

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

{
   // This assigns theInputConnection if one is there.
   m_initialized = false;
   ossimImageSourceFilter::initialize();
   m_tile = 0;

   if ( !theInputConnection )
      return;

   // If an input histogram was provided, use it. Otherwise compute one:
   if (!m_histogram.valid())
   {
      ossimRefPtr<ossimImageHistogramSource> histoSource = new ossimImageHistogramSource;
      histoSource->connectMyInputTo(theInputConnection);
      histoSource->setComputationMode(OSSIM_HISTO_MODE_FAST);
      histoSource->setMaxNumberOfRLevels(1);
      histoSource->execute();
      m_histogram = histoSource->getHistogram()->getMultiBandHistogram(0);
   }

   if (!m_histogram.valid())
   {
      ostringstream xmsg;
      xmsg<<"ossimKMeansFilter:"<<__LINE__<<"  Could not establish a histogram. Cannot "
            "initialize filter";
      throw ossimException(xmsg.str());
   }

   ossim_uint32 numBands = getNumberOfInputBands();
   for (ossim_uint32 band=0; band<numBands; band++)
   {
      ossimRefPtr<ossimHistogram> h = m_histogram->getHistogram(band);
      m_minPixelValue.push_back(h->GetRangeMin());
      m_maxPixelValue.push_back(h->GetRangeMax());
   }
   m_initialized = true;
}

loadState()

bool ossimKMeansFilter::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 383 of file ossimKMeansFilter.cpp.

References ossimImageSourceFilter::loadState().

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

   // TODO: Need to implement

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

   return return_state;
}

saveState()

bool ossimKMeansFilter::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 338 of file ossimKMeansFilter.cpp.

References ossimKeywordlist::add(), ossimString::chars(), ossimKMeansClustering::getCluster(), ossimImageSourceFilter::getNumberOfInputBands(), m_classifiers, m_numClusters, ossimKMeansClustering::Cluster::max, ossimKMeansClustering::Cluster::mean, ossimKMeansClustering::Cluster::min, ossimImageSourceFilter::saveState(), ossimKMeansClustering::Cluster::sigma, and ossimString::toString().

{
   if (m_numClusters == 0)
      return true;

   ossim_uint32 numBands = getNumberOfInputBands();
   kwl.add(prefix, "num_bands", numBands);
   kwl.add(prefix, "num_clusters", m_numClusters);

   ossimString key;
   ossimString keybase1;
   ossimString keybase2;
   const ossimKMeansClustering* bandClusters = 0;
   const ossimKMeansClustering::Cluster* cluster = 0;
   for (ossim_uint32 band=0; band<numBands; band++)
   {
      if (numBands > 1)
      {
         keybase1 = "band";
         keybase1 += ossimString::toString(band) + ".";
      }

      // Need bin size of histogram since only center values were used in clustering:
      bandClusters = m_classifiers[band].get();
      for (ossim_uint32 gid=0; gid < m_numClusters; ++gid)
      {
         keybase2 = keybase1;
         keybase2 += "cluster";
         keybase2 += ossimString::toString(gid);
         cluster = bandClusters->getCluster(gid);
         key = keybase2 + ".mean";
         kwl.add(prefix, key.chars(), cluster->mean);
         key = keybase2 + ".sigma";
         kwl.add(prefix, key.chars(), cluster->sigma);
         key = keybase2 + ".min";
         kwl.add(prefix, key.chars(), cluster->min);
         key = keybase2 + ".max";
         kwl.add(prefix, key.chars(), cluster->max);
      }
   }

   bool rtn_stat = ossimImageSourceFilter::saveState(kwl, prefix);
   return rtn_stat;
}

setClusterPixelValues()

void ossimKMeansFilter::setClusterPixelValues	(	const ossim_uint32 *	dns,
		ossim_uint32	K
	)

Optionally define the output digital numbers for each cluster to be used for remapping the input pixels.

K is the size of the array, resetting any previously set K value. If thresholding enabled (see setThreshold()), then only the first two values are referenced. LIMITATION: Curently, only UInt8 supported, so dns and K values must be 0-255.

Definition at line 318 of file ossimKMeansFilter.cpp.

References m_numClusters, m_pixelValues, and setNumClusters().

{
   if (dns == 0)
      return;

   if (K != m_numClusters)
      setNumClusters(K);

   m_pixelValues.clear();
   for (ossim_uint32 i=0; i<m_numClusters; ++i)
      m_pixelValues.push_back(dns[i]);
}

setInputHistogram()

void ossimKMeansFilter::setInputHistogram

(

ossimMultiBandHistogram *

histo

)

Sets the input source's histogram for quicker K-means analysis.

Definition at line 51 of file ossimKMeansFilter.cpp.

References m_histogram, m_initialized, and m_thresholds.

{
   m_histogram = histo;
   m_initialized = 0;
   m_thresholds.clear();
}

setNumClusters()

void ossimKMeansFilter::setNumClusters

(

ossim_uint32

K

)

Defines how many classification clusters will be resolved.

The input connection should be made prior so that the number of bands is known. LIMITATION: Curently, only K values < 256 are supported.

Definition at line 298 of file ossimKMeansFilter.cpp.

References clear(), m_numClusters, and m_pixelValues.

Referenced by setClusterPixelValues().

{
   if (K > 255)
   {
      ostringstream xmsg;
      xmsg << "ossimKMeansFilter:"<<__LINE__<<" Requested K="<<K<<" but only max 255 supported!";
      throw ossimException(xmsg.str());
   }
   clear();

   // Define default replacement pixel values (unless already done):
   m_numClusters = K;
   if (m_pixelValues.size() != m_numClusters)
   {
      m_pixelValues.clear();
      for (ossim_uint32 i=1; i<=m_numClusters; ++i)
         m_pixelValues.push_back(i);
   }
}

setThresholdMode()

void ossimKMeansFilter::setThresholdMode

(

ThresholdMode

mode

)

Special use case is to use K-means for thresholding an image into two values based on the histogram's clustering.

The threshold point can be left at the default boundary between clusters, or alternatively, can be computed according to predefined modes. Currently support the following modes (where mn and sn is the mean and sigma of nth cluster, respectively):

NONE Implies MEAN for multiple clusters. MEAN (m0 + m1)/2 SIGMA_WEIGHTED (s1*m0 + s0*m1)/(s0 + s1) VARIANCE_WEIGHTED (s1*s1*m0 + s0*s0*m1)/(s0*s0 + s1*s1)

Definition at line 293 of file ossimKMeansFilter.cpp.

References m_thresholdMode.

{
   m_thresholdMode = mode;
}

Member Data Documentation

m_classifiers

std::vector<ossimRefPtr<ossimKMeansClustering> > ossimKMeansFilter::m_classifiers

protected

Definition at line 124 of file ossimKMeansFilter.h.

Referenced by allocate(), clear(), computeKMeans(), getBandClassifier(), getTile(), and saveState().

m_histogram

ossimRefPtr<ossimMultiBandHistogram> ossimKMeansFilter::m_histogram

protected

Have num_bands entries.

Definition at line 125 of file ossimKMeansFilter.h.

Referenced by computeKMeans(), getTile(), initialize(), and setInputHistogram().

m_initialized

bool ossimKMeansFilter::m_initialized

protected

Definition at line 132 of file ossimKMeansFilter.h.

Referenced by allocate(), clear(), computeKMeans(), getTile(), initialize(), and setInputHistogram().

m_maxPixelValue

std::vector<double> ossimKMeansFilter::m_maxPixelValue

protected

Definition at line 129 of file ossimKMeansFilter.h.

Referenced by getMaxPixelValue(), and initialize().

m_minPixelValue

std::vector<double> ossimKMeansFilter::m_minPixelValue

protected

Definition at line 128 of file ossimKMeansFilter.h.

Referenced by getMinPixelValue(), and initialize().

m_numClusters

ossim_uint32 ossimKMeansFilter::m_numClusters

protected

Definition at line 126 of file ossimKMeansFilter.h.

Referenced by allocate(), clear(), computeKMeans(), getOutputScalarType(), getTile(), saveState(), setClusterPixelValues(), and setNumClusters().

m_outputScalarType

ossimScalarType ossimKMeansFilter::m_outputScalarType

protected

Definition at line 131 of file ossimKMeansFilter.h.

m_pixelValues

std::vector<ossim_uint32> ossimKMeansFilter::m_pixelValues

protected

Definition at line 127 of file ossimKMeansFilter.h.

Referenced by getTile(), setClusterPixelValues(), and setNumClusters().

m_thresholdMode

ThresholdMode ossimKMeansFilter::m_thresholdMode

protected

Definition at line 133 of file ossimKMeansFilter.h.

Referenced by computeKMeans(), and setThresholdMode().

m_thresholds

std::vector<double> ossimKMeansFilter::m_thresholds

protected

Definition at line 134 of file ossimKMeansFilter.h.

Referenced by computeKMeans(), getTile(), and setInputHistogram().

m_tile

ossimRefPtr<ossimImageData> ossimKMeansFilter::m_tile

protected

Definition at line 130 of file ossimKMeansFilter.h.

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

---

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

• ossimKMeansFilter.h
• ossimKMeansFilter.cpp