SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions
CHomogeneousKernelMap Class Reference

Detailed Description

Preprocessor HomogeneousKernelMap performs homogeneous kernel maps as described in.

A. Vedaldi and A. Zisserman. Efficient additive kernels via explicit feature maps. In PAMI, 2011

The homogeneous kernel map is a finite dimensional linear approximation of homogeneous kernels, including the intersection, chi-squared, and Jensen-Shannon kernels. These kernels are frequently used in computer vision applications because they are particular suitable for data in the format of histograms, which encompasses many visual descriptors used.

The implementation is unsafe to work with negative feature values.

Implementation is based on the vlfeat library.

Definition at line 55 of file HomogeneousKernelMap.h.

Inheritance diagram for CHomogeneousKernelMap:
Inheritance graph
[legend]

Public Member Functions

 CHomogeneousKernelMap ()
 
 CHomogeneousKernelMap (HomogeneousKernelType kernel, HomogeneousKernelMapWindowType wType, float64_t gamma=1.0, uint64_t order=1, float64_t period=-1)
 
virtual ~CHomogeneousKernelMap ()
 
virtual bool init (CFeatures *features)
 
virtual void cleanup ()
 
virtual SGMatrix< float64_t > apply_to_feature_matrix (CFeatures *features)
 
virtual SGVector< float64_t > apply_to_feature_vector (SGVector< float64_t > vector)
 apply preproc on single feature vector More...
 
virtual const char * get_name () const
 
virtual EPreprocessorType get_type () const
 
void set_kernel_type (HomogeneousKernelType k)
 
HomogeneousKernelType get_kernel_type () const
 
void set_window_type (HomogeneousKernelMapWindowType w)
 
HomogeneousKernelMapWindowType get_window_type () const
 
void set_gamma (float64_t g)
 
float64_t get_gamma (float64_t g) const
 
void set_order (uint64_t o)
 
uint64_t get_order () const
 
void set_period (float64_t p)
 
float64_t get_period () const
 
virtual CFeatures * apply (CFeatures *features)
 
virtual EFeatureClass get_feature_class ()
 return that we are dense features (just fixed size matrices) More...
 
virtual EFeatureType get_feature_type ()
 return feature type More...
 
virtual CSGObject * shallow_copy () const
 
virtual CSGObject * deep_copy () const
 
virtual bool is_generic (EPrimitiveType *generic) const
 
template<class T >
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
void unset_generic ()
 
virtual void print_serializable (const char *prefix="")
 
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
void set_global_io (SGIO *io)
 
SGIO * get_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallel * get_global_parallel ()
 
void set_global_version (Version *version)
 
Version * get_global_version ()
 
SGStringList< char > get_modelsel_names ()
 
void print_modsel_params ()
 
char * get_modsel_param_descr (const char *param_name)
 
index_t get_modsel_param_index (const char *param_name)
 
void build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObject * clone ()
 

Public Attributes

SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
Parameter * m_gradient_parameters
 
uint32_t m_hash
 

Protected Member Functions

virtual void load_serializable_pre () throw (ShogunException)
 
virtual void load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 

Constructor & Destructor Documentation

CHomogeneousKernelMap ( )

default constructor

Definition at line 19 of file HomogeneousKernelMap.cpp.

CHomogeneousKernelMap ( HomogeneousKernelType  kernel,
HomogeneousKernelMapWindowType  wType,
float64_t  gamma = 1.0,
uint64_t  order = 1,
float64_t  period = -1 
)

constructor

Parameters
kernelkernel type
wTypewindow type (use HomogeneousKernelMapWindowRectangular if unsure)
gammathe homogeneity order
orderthe approximation order
periodthe period (use a negative value to use the default period)

Definition at line 31 of file HomogeneousKernelMap.cpp.

~CHomogeneousKernelMap ( )
virtual

destructor

Definition at line 46 of file HomogeneousKernelMap.cpp.

Member Function Documentation

virtual CFeatures* apply ( CFeatures *  features)
virtualinherited

generic interface for applying the preprocessor. used as a wrapper for apply_to_feature_matrix() method

Parameters
featuresthe dense input features
Returns
the result feature object after applying the preprocessor

Implements CPreprocessor.

SGMatrix< float64_t > apply_to_feature_matrix ( CFeatures *  features)
virtual

applies to features

Parameters
featuresfeatures
Returns
feature matrix

Implements CDensePreprocessor< float64_t >.

Definition at line 163 of file HomogeneousKernelMap.cpp.

SGVector< float64_t > apply_to_feature_vector ( SGVector< float64_t >  vector)
virtual

apply preproc on single feature vector

applies to feature vector

Parameters
vectorfeatures vector
Returns
transformed feature vector

Implements CDensePreprocessor< float64_t >.

Definition at line 183 of file HomogeneousKernelMap.cpp.

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict)
inherited

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

Parameters
dictdictionary of parameters to be built.

Definition at line 597 of file SGObject.cpp.

void cleanup ( )
virtual

cleanup

Implements CPreprocessor.

Definition at line 58 of file HomogeneousKernelMap.cpp.

CSGObject * clone ( )
virtualinherited

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

Returns
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 714 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 198 of file SGObject.cpp.

bool equals ( CSGObject *  other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtualinherited

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 618 of file SGObject.cpp.

virtual EFeatureClass get_feature_class ( )
virtualinherited

return that we are dense features (just fixed size matrices)

Implements CPreprocessor.

Reimplemented in CRandomFourierGaussPreproc.

virtual EFeatureType get_feature_type ( )
virtualinherited

return feature type

Implements CPreprocessor.

Reimplemented in CRandomFourierGaussPreproc.

float64_t get_gamma ( float64_t  g) const

returns gamma

Returns
gamma value

Definition at line 217 of file HomogeneousKernelMap.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 of file SGObject.cpp.

HomogeneousKernelType get_kernel_type ( ) const

returns kernel type

Returns
kernel type

Definition at line 195 of file HomogeneousKernelMap.cpp.

SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 498 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters
param_namename of the parameter
Returns
description of the parameter

Definition at line 522 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

Parameters
param_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual
Returns
object name

Implements CSGObject.

Definition at line 94 of file HomogeneousKernelMap.h.

uint64_t get_order ( ) const

returns approximation order

Returns
approximation order

Definition at line 228 of file HomogeneousKernelMap.cpp.

float64_t get_period ( ) const

returns period value

Returns
period value

Definition at line 239 of file HomogeneousKernelMap.cpp.

virtual EPreprocessorType get_type ( ) const
virtual
Returns
a type of preprocessor

Reimplemented from CDensePreprocessor< float64_t >.

Definition at line 97 of file HomogeneousKernelMap.h.

HomogeneousKernelMapWindowType get_window_type ( ) const

returns window type

Returns
window type

Definition at line 206 of file HomogeneousKernelMap.cpp.

bool init ( CFeatures *  features)
virtual

initialize preprocessor from features

Implements CPreprocessor.

Definition at line 50 of file HomogeneousKernelMap.cpp.

bool is_generic ( EPrimitiveType *  generic) const
virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

Parameters
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 296 of file SGObject.cpp.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 369 of file SGObject.cpp.

void load_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 426 of file SGObject.cpp.

void load_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 421 of file SGObject.cpp.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtualinherited

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 314 of file SGObject.cpp.

void save_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 436 of file SGObject.cpp.

void save_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 431 of file SGObject.cpp.

void set_gamma ( float64_t  g)

sets gamma

Parameters
ggamma value

Definition at line 211 of file HomogeneousKernelMap.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO *  io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

void set_kernel_type ( HomogeneousKernelType  k)

sets kernel type

Parameters
ktype of homogeneous kernel

Definition at line 189 of file HomogeneousKernelMap.cpp.

void set_order ( uint64_t  o)

sets approximation order

Parameters
oorder

Definition at line 222 of file HomogeneousKernelMap.cpp.

void set_period ( float64_t  p)

sets period

Parameters
pperiod value

Definition at line 233 of file HomogeneousKernelMap.cpp.

void set_window_type ( HomogeneousKernelMapWindowType  w)

sets window type

Parameters
wtype of window

Definition at line 200 of file HomogeneousKernelMap.cpp.

CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

Reimplemented in CGaussianKernel.

Definition at line 192 of file SGObject.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.

The documentation for this class was generated from the following files:
SHOGUN Machine Learning Toolbox - Documentation