This function returns the cross validation accuracy of a SVM model. More...

#include <otbSVMCrossValidationCostFunction.h>

Inheritance diagram for otb::SVMCrossValidationCostFunction< TModel >:

Collaboration diagram for otb::SVMCrossValidationCostFunction< TModel >:

Public Types
typedef itk::SmartPointer < const Self >	ConstPointer
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::MeasureType	MeasurementType
typedef double	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::ParametersValueType	ParametersValueType
typedef itk::SmartPointer< Self >	Pointer
typedef SVMCrossValidationCostFunction	Self
typedef itk::SingleValuedCostFunction	Superclass
typedef SVMModelType::Pointer	SVMModelPointer
typedef TModel	SVMModelType

Public Member Functions
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const
virtual ParametersValueType	GetDerivativeStep ()
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual SVMModelType *	GetModel ()
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfCrossValidationFolders ()
virtual unsigned int	GetNumberOfParameters (void) const
virtual int	GetReferenceCount () const
virtual MeasureType	GetValue (const ParametersType &parameters) const
virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetDerivativeStep (ParametersValueType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetModel (SVMModelType *_arg)
virtual void	SetNumberOfCrossValidationFolders (unsigned int _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	SVMCrossValidationCostFunction ()
	Constructor.
virtual	~SVMCrossValidationCostFunction ()
	Destructor.
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	UpdateParameters (struct svm_parameter &svm_parameters, const ParametersType &parameters) const

Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	SVMCrossValidationCostFunction (const Self &)
void	operator= (const Self &)

Private Attributes
ParametersValueType	m_DerivativeStep
SVMModelPointer	m_Model
unsigned int	m_NumberOfCrossValidationFolders

Detailed Description

template<class TModel>
class otb::SVMCrossValidationCostFunction< TModel >

This function returns the cross validation accuracy of a SVM model.

It allows to perform parameters selection to maximize the accuracy using ITK optimizers.

Given an input SVM model, the number of parameters depends on the type of kernel:

Linear kernel : C
Polynomial kernel : C, gamma, coef0
RBF kernel : C, Gamma
Gaussian kernel : C, Gamma, coef0
Other kernels : C

Please note that this function is only defined on $R_{+}^{*}$ .

The GetDerivative() uses the GetValue() function to compute the partial derivatives. as such, it can be quite intensive.

Definition at line 49 of file otbSVMCrossValidationCostFunction.h.

Member Typedef Documentation

template<class TModel >

typedef itk::SmartPointer<const Self> otb::SVMCrossValidationCostFunction< TModel >::ConstPointer

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 57 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

typedef Superclass::DerivativeType otb::SVMCrossValidationCostFunction< TModel >::DerivativeType

DerivativeType typedef. It defines a type used to return the cost function derivative.

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 70 of file otbSVMCrossValidationCostFunction.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TModel >

typedef Superclass::MeasureType otb::SVMCrossValidationCostFunction< TModel >::MeasurementType

Superclass typedefs

Definition at line 67 of file otbSVMCrossValidationCostFunction.h.

typedef double itk::SingleValuedCostFunction::MeasureType

inherited

MeasureType typedef. It defines a type used to return the cost function value.

Definition at line 46 of file itkSingleValuedCostFunction.h.

template<class TModel >

typedef Superclass::ParametersType otb::SVMCrossValidationCostFunction< TModel >::ParametersType

ParametersType typedef. It defines a position in the optimization search space.

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 68 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

typedef Superclass::ParametersValueType otb::SVMCrossValidationCostFunction< TModel >::ParametersValueType

ParametersType typedef. It defines a position in the optimization search space.

Reimplemented from itk::CostFunction.

Definition at line 69 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

typedef itk::SmartPointer<Self> otb::SVMCrossValidationCostFunction< TModel >::Pointer

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 56 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

typedef SVMCrossValidationCostFunction otb::SVMCrossValidationCostFunction< TModel >::Self

Standard class typedefs.

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 54 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

typedef itk::SingleValuedCostFunction otb::SVMCrossValidationCostFunction< TModel >::Superclass

Reimplemented from itk::SingleValuedCostFunction.

Definition at line 55 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

typedef SVMModelType::Pointer otb::SVMCrossValidationCostFunction< TModel >::SVMModelPointer

Definition at line 64 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

typedef TModel otb::SVMCrossValidationCostFunction< TModel >::SVMModelType

Type definitions for the SVM Model.

Definition at line 60 of file otbSVMCrossValidationCostFunction.h.

Constructor & Destructor Documentation

template<class TModel >

otb::SVMCrossValidationCostFunction< TModel >::SVMCrossValidationCostFunction ( )

protected

Constructor.

Definition at line 27 of file otbSVMCrossValidationCostFunction.txx.

template<class TModel >

otb::SVMCrossValidationCostFunction< TModel >::~SVMCrossValidationCostFunction ( )

protectedvirtual

Destructor.

Definition at line 31 of file otbSVMCrossValidationCostFunction.txx.

template<class TModel >

otb::SVMCrossValidationCostFunction< TModel >::SVMCrossValidationCostFunction ( const Self & )

private

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

template<class TModel >

virtual::itk::LightObject::Pointer otb::SVMCrossValidationCostFunction< TModel >::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<class TModel >

void otb::SVMCrossValidationCostFunction< TModel >::GetDerivative	(	const ParametersType &	parameters,
		DerivativeType &	derivative
	)		const

virtual

Returns:: The accuracy derivative corresponding to the parameters

Implements itk::SingleValuedCostFunction.

Definition at line 60 of file otbSVMCrossValidationCostFunction.txx.

References itk::Array< TValueType >::Fill(), otbMsgDevMacro, itk::Array< TValueType >::SetSize(), and itk::Array< TValueType >::Size().

template<class TModel >

virtual ParametersValueType otb::SVMCrossValidationCostFunction< TModel >::GetDerivativeStep ( )

virtual

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

template<class TModel >

virtual SVMModelType* otb::SVMCrossValidationCostFunction< TModel >::GetModel ( )

virtual

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

virtual const char* itk::SingleValuedCostFunction::GetNameOfClass ( ) const

virtualinherited

Run-time type information (and related methods).

Reimplemented from itk::CostFunction.

template<class TModel >

virtual unsigned int otb::SVMCrossValidationCostFunction< TModel >::GetNumberOfCrossValidationFolders ( )

virtual

template<class TModel >

unsigned int otb::SVMCrossValidationCostFunction< TModel >::GetNumberOfParameters ( void ) const

virtual

Returns:: the number of parameters to optimize

Implements itk::CostFunction.

Definition at line 89 of file otbSVMCrossValidationCostFunction.txx.

References LINEAR, POLY, RBF, and SIGMOID.

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

template<class TModel >

SVMCrossValidationCostFunction< TModel >::MeasureType otb::SVMCrossValidationCostFunction< TModel >::GetValue ( const ParametersType & parameters ) const

virtual

Returns:: The accuracy value corresponding the parameters

Implements itk::SingleValuedCostFunction.

Definition at line 37 of file otbSVMCrossValidationCostFunction.txx.

virtual void itk::SingleValuedCostFunction::GetValueAndDerivative	(	const ParametersType &	parameters,
		MeasureType &	value,
		DerivativeType &	derivative
	)		const

inlinevirtualinherited

This method returns the value and derivative of the cost function corresponding to the specified parameters

Reimplemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >.

Definition at line 71 of file itkSingleValuedCostFunction.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TModel >

static Pointer otb::SVMCrossValidationCostFunction< TModel >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TModel >

void otb::SVMCrossValidationCostFunction< TModel >::operator= ( const Self & )

private

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

void itk::CostFunction::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::Object.

Definition at line 23 of file itkCostFunction.cxx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

template<class TModel >

virtual void otb::SVMCrossValidationCostFunction< TModel >::SetDerivativeStep ( ParametersValueType _arg )

virtual

Set/Get the derivative step

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

template<class TModel >

virtual void otb::SVMCrossValidationCostFunction< TModel >::SetModel ( SVMModelType * _arg )

virtual

Set the model

template<class TModel >

virtual void otb::SVMCrossValidationCostFunction< TModel >::SetNumberOfCrossValidationFolders ( unsigned int _arg )

virtual

Set/Get the number of cross validation folders

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

template<class TModel >

void otb::SVMCrossValidationCostFunction< TModel >::UpdateParameters	(	struct svm_parameter &	svm_parameters,
		const ParametersType &	parameters
	)		const

protectedvirtual

Update svm parameters struct according to the input parameters

Definition at line 123 of file otbSVMCrossValidationCostFunction.txx.

References svm_parameter::C, svm_parameter::coef0, svm_parameter::gamma, LINEAR, POLY, RBF, and SIGMOID.

Member Data Documentation

template<class TModel >

ParametersValueType otb::SVMCrossValidationCostFunction< TModel >::m_DerivativeStep

private

Step used to compute the derivatives

Definition at line 114 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

SVMModelPointer otb::SVMCrossValidationCostFunction< TModel >::m_Model

private

Pointer to the SVM model to optimize

Definition at line 108 of file otbSVMCrossValidationCostFunction.h.

template<class TModel >

unsigned int otb::SVMCrossValidationCostFunction< TModel >::m_NumberOfCrossValidationFolders

private

Number of cross validation folders

Definition at line 111 of file otbSVMCrossValidationCostFunction.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class TModel> class otb::SVMCrossValidationCostFunction< TModel >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TModel>
class otb::SVMCrossValidationCostFunction< TModel >