homkermap.h File Reference

Homogeneous kernel map (Homogeneous kernel map) More...

#include "generic.h"
#include <math.h>

Include dependency graph for homkermap.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct _VlHomogeneousKernelMap	VlHomogeneousKernelMap
Enumerations
enum	VlHomogeneousKernelMapWindowType { VlHomogeneousKernelMapWindowUniform = 0, VlHomogeneousKernelMapWindowRectangular = 1 }
	Type of spectral windowing function. More...
enum	VlHomogeneousKernelType { VlHomogeneousKernelIntersection = 0, VlHomogeneousKernelChi2, VlHomogeneousKernelJS }
	Type of kernel. More...
Functions
Create and destroy
VL_EXPORT VlHomogeneousKernelMap *	vl_homogeneouskernelmap_new (VlHomogeneousKernelType kernelType, double gamma, vl_size order, double period, VlHomogeneousKernelMapWindowType windowType)
	Create a new homgeneous kernel map.
VL_EXPORT void	vl_homogeneouskernelmap_delete (VlHomogeneousKernelMap *self)
	Delete an object instance.
Process data
VL_EXPORT void	vl_homogeneouskernelmap_evaluate_d (VlHomogeneousKernelMap const *self, double *destination, vl_size stride, double x)
	Evaluate map.
VL_EXPORT void	vl_homogeneouskernelmap_evaluate_f (VlHomogeneousKernelMap const *self, float *destination, vl_size stride, double x)
Retrieve data and parameters
VL_EXPORT vl_size	vl_homogeneouskernelmap_get_order (VlHomogeneousKernelMap const *self)
	Get the map order.
VL_EXPORT vl_size	vl_homogeneouskernelmap_get_dimension (VlHomogeneousKernelMap const *self)
	Get the map dimension.
VL_EXPORT VlHomogeneousKernelType	vl_homogeneouskernelmap_get_kernel_type (VlHomogeneousKernelMap const *self)
	Get the kernel type.
VL_EXPORT VlHomogeneousKernelMapWindowType	vl_homogeneouskernelmap_get_window_type (VlHomogeneousKernelMap const *self)
	Get the window type.

---

Detailed Description

Homogeneous kernel map (Homogeneous kernel map)

Author:

Andrea Vedaldi

Definition in file homkermap.h.

---

Typedef Documentation

typedef struct _VlHomogeneousKernelMap VlHomogeneousKernelMap

Definition at line 36 of file homkermap.h.

---

Enumeration Type Documentation

enum VlHomogeneousKernelMapWindowType

Type of spectral windowing function.

Enumerator:

VlHomogeneousKernelMapWindowUniform	uniform window
VlHomogeneousKernelMapWindowRectangular	rectangular window

Definition at line 29 of file homkermap.h.

enum VlHomogeneousKernelType

Type of kernel.

Enumerator:

VlHomogeneousKernelIntersection	intersection kernel
VlHomogeneousKernelChi2	Chi2 kernel
VlHomogeneousKernelJS	Jensen-Shannon kernel

Definition at line 22 of file homkermap.h.

---

Function Documentation

VL_EXPORT void vl_homogeneouskernelmap_delete

(

VlHomogeneousKernelMap *

self

)

Delete an object instance.

Parameters:

self	object. The function deletes the specified map object.

Definition at line 435 of file homkermap.c.

vl_homogeneouskernelmap_evaluate_d	(	VlHomogeneousKernelMap const *	self,
		double *	destination,
		vl_size	stride,
		double	x
	)

Evaluate map.

Parameters:

self	map object.
destination	output buffer.
stride	stride of the output buffer.
x	value to expand.

The function evaluates the feature map on x and stores the resulting 2*order+1 dimensional vector to destination[0], destination[stride], destination[2*stride], ....

vl_homogeneouskernelmap_evaluate_f	(	VlHomogeneousKernelMap const *	self,
		float *	destination,
		vl_size	stride,
		double	x
	)

Parameters:

self	map object.
destination	output buffer.
stride	stride of the output buffer.
x	value to expand.

The function evaluates the feature map on x and stores the resulting 2*order+1 dimensional vector to destination[0], destination[stride], destination[2*stride], ....

VL_EXPORT vl_size vl_homogeneouskernelmap_get_dimension

(

VlHomogeneousKernelMap const *

self

)

Get the map dimension.

Parameters:

self

object.

Returns:

the map dimension (2 order +1).

Definition at line 464 of file homkermap.c.

VL_EXPORT VlHomogeneousKernelType vl_homogeneouskernelmap_get_kernel_type

(

VlHomogeneousKernelMap const *

self

)

Get the kernel type.

Parameters:

self

object.

Returns:

kernel type.

Definition at line 476 of file homkermap.c.

VL_EXPORT vl_size vl_homogeneouskernelmap_get_order

(

VlHomogeneousKernelMap const *

self

)

Get the map order.

Parameters:

self

object.

Returns:

the map order.

Definition at line 452 of file homkermap.c.

VL_EXPORT VlHomogeneousKernelMapWindowType vl_homogeneouskernelmap_get_window_type

(

VlHomogeneousKernelMap const *

self

)

Get the window type.

Parameters:

self

object.

Returns:

window type.

Definition at line 488 of file homkermap.c.

VL_EXPORT VlHomogeneousKernelMap* vl_homogeneouskernelmap_new	(	VlHomogeneousKernelType	kernelType,
		double	gamma,
		vl_size	order,
		double	period,
		VlHomogeneousKernelMapWindowType	windowType
	)

Create a new homgeneous kernel map.

Parameters:

kernelType	type of homogeneous kernel.
gamma	kernel homogeneity degree.
order	approximation order.
period	kernel period.
windowType	type of window used to truncate the kernel.

Returns:

the new homogeneous kernel map.

The function intializes a new homogeneous kernel map for the specified kernel type, homogeneity degree, approximation order, period, and truncation window. See Fundamentals for details.

The homogeneity degree gamma must be positive (the standard kernels are obtained by setting gamma to 1). When unsure, set windowType to VlHomogeneousKernelMapWindowRectangular. The period should be non-negative; specifying a negative or null value causes the function to switch to a default value.

The function returns NULL if there is not enough free memory.

Definition at line 326 of file homkermap.c.