dsift.h File Reference

Dense SIFT (Dense Scale Invariant Feature Transform (DSIFT)) More...

#include "generic.h"

Include dependency graph for dsift.h:

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

Go to the source code of this file.

Classes
struct	VlDsiftDescriptorGeometry_
	Dense SIFT descriptor geometry. More...
struct	VlDsiftFilter_
	Dense SIFT filter. More...
struct	VlDsiftKeypoint_
	Dense SIFT keypoint. More...
Typedefs
typedef struct VlDsiftDescriptorGeometry_	VlDsiftDescriptorGeometry
	Dense SIFT descriptor geometry.
typedef struct VlDsiftFilter_	VlDsiftFilter
	Dense SIFT filter.
typedef struct VlDsiftKeypoint_	VlDsiftKeypoint
	Dense SIFT keypoint.
Functions
VL_EXPORT void	_vl_dsift_update_buffers (VlDsiftFilter *self)
VL_EXPORT void	vl_dsift_delete (VlDsiftFilter *self)
	Delete DSIFT filter.
VL_EXPORT VlDsiftFilter *	vl_dsift_new (int width, int height)
	Create a new DSIFT filter.
VL_EXPORT VlDsiftFilter *	vl_dsift_new_basic (int width, int height, int step, int binSize)
	Create a new DSIFT filter (basic interface)
VL_EXPORT void	vl_dsift_process (VlDsiftFilter *self, float const *im)
	Compute keypoints and descriptors.
VL_INLINE void	vl_dsift_transpose_descriptor (float *dst, float const *src, int numBinT, int numBinX, int numBinY)
	Transpose descriptor.
Setting parameters
VL_INLINE void	vl_dsift_set_steps (VlDsiftFilter *self, int stepX, int stepY)
	Set steps.
VL_INLINE void	vl_dsift_set_bounds (VlDsiftFilter *self, int minX, int minY, int maxX, int maxY)
	Set bounds.
VL_INLINE void	vl_dsift_set_geometry (VlDsiftFilter *self, VlDsiftDescriptorGeometry const *geom)
	Set SIFT descriptor geometry.
VL_INLINE void	vl_dsift_set_flat_window (VlDsiftFilter *self, vl_bool useFlatWindow)
	Set flat window flag.
VL_INLINE void	vl_dsift_set_window_size (VlDsiftFilter *self, double windowSize)
	Set SIFT descriptor Gaussian window size.
Retrieving data and parameters
VL_INLINE float const *	vl_dsift_get_descriptors (VlDsiftFilter const *self)
	Get descriptors.
VL_INLINE int	vl_dsift_get_descriptor_size (VlDsiftFilter const *self)
	Get descriptor size.
VL_INLINE int	vl_dsift_get_keypoint_num (VlDsiftFilter const *self)
	Get number of keypoints.
VL_INLINE VlDsiftKeypoint const *	vl_dsift_get_keypoints (VlDsiftFilter const *self)
	Get keypoints.
VL_INLINE void	vl_dsift_get_bounds (VlDsiftFilter const *self, int *minX, int *minY, int *maxX, int *maxY)
	Get bounds.
VL_INLINE void	vl_dsift_get_steps (VlDsiftFilter const *self, int *stepX, int *stepY)
	Get steps.
VL_INLINE VlDsiftDescriptorGeometry const *	vl_dsift_get_geometry (VlDsiftFilter const *self)
	Get SIFT descriptor geometry.
VL_INLINE vl_bool	vl_dsift_get_flat_window (VlDsiftFilter const *self)
	Get flat window flag.
VL_INLINE double	vl_dsift_get_window_size (VlDsiftFilter const *self)
	Get SIFT descriptor Gaussian window size.

---

Detailed Description

Dense SIFT (Dense Scale Invariant Feature Transform (DSIFT))

Author:

Andrea Vedaldi

Brian Fulkerson

Definition in file dsift.h.

---

Typedef Documentation

typedef struct VlDsiftDescriptorGeometry_ VlDsiftDescriptorGeometry

Dense SIFT descriptor geometry.

typedef struct VlDsiftFilter_ VlDsiftFilter

Dense SIFT filter.

typedef struct VlDsiftKeypoint_ VlDsiftKeypoint

Dense SIFT keypoint.

---

Function Documentation

VL_EXPORT void _vl_dsift_update_buffers

(

VlDsiftFilter *

self

)

------------------------------------------------------------------

Definition at line 346 of file dsift.c.

VL_EXPORT void vl_dsift_delete

(

VlDsiftFilter *

self

)

Delete DSIFT filter.

------------------------------------------------------------------

Parameters:

self	DSIFT filter.

Definition at line 484 of file dsift.c.

void vl_dsift_get_bounds	(	VlDsiftFilter const *	self,
		int *	minX,
		int *	minY,
		int *	maxX,
		int *	maxY
	)

Get bounds.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.
minX	bounding box minimum X coordinate.
minY	bounding box minimum Y coordinate.
maxX	bounding box maximum X coordinate.
maxY	bounding box maximum Y coordinate.

Definition at line 190 of file dsift.h.

int vl_dsift_get_descriptor_size

(

VlDsiftFilter const *

self

)

Get descriptor size.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.

Returns:

size of a descriptor.

Definition at line 130 of file dsift.h.

float const * vl_dsift_get_descriptors

(

VlDsiftFilter const *

self

)

Get descriptors.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.

Returns:

descriptors.

Definition at line 142 of file dsift.h.

int vl_dsift_get_flat_window

(

VlDsiftFilter const *

self

)

Get flat window flag.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.

Returns:

TRUE if the DSIFT filter uses a flat window.

Definition at line 206 of file dsift.h.

VlDsiftDescriptorGeometry const * vl_dsift_get_geometry

(

VlDsiftFilter const *

self

)

Get SIFT descriptor geometry.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.

Returns:

DSIFT descriptor geometry.

Definition at line 175 of file dsift.h.

int vl_dsift_get_keypoint_num

(

VlDsiftFilter const *

self

)

Get number of keypoints.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.

Definition at line 164 of file dsift.h.

VlDsiftKeypoint const * vl_dsift_get_keypoints

(

VlDsiftFilter const *

self

)

Get keypoints.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.

Definition at line 153 of file dsift.h.

void vl_dsift_get_steps	(	VlDsiftFilter const *	self,
		int *	stepX,
		int *	stepY
	)

Get steps.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.
stepX	sampling step along X.
stepY	sampling step along Y.

Definition at line 219 of file dsift.h.

VL_INLINE double vl_dsift_get_window_size

(

VlDsiftFilter const *

self

)

Get SIFT descriptor Gaussian window size.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.

Returns:

window size.

Definition at line 348 of file dsift.h.

VL_EXPORT VlDsiftFilter* vl_dsift_new	(	int	imWidth,
		int	imHeight
	)

Create a new DSIFT filter.

------------------------------------------------------------------

Parameters:

imWidth	width of the image.
imHeight	height of the image

Returns:

new filter.

Definition at line 415 of file dsift.c.

VL_EXPORT VlDsiftFilter* vl_dsift_new_basic	(	int	imWidth,
		int	imHeight,
		int	step,
		int	binSize
	)

Create a new DSIFT filter (basic interface)

------------------------------------------------------------------

Parameters:

imWidth	width of the image.
imHeight	height of the image.
step	sampling step.
binSize	bin size.

Returns:

new filter.

The descriptor geometry matches the standard SIFT descriptor.

Definition at line 467 of file dsift.c.

VL_EXPORT void vl_dsift_process	(	VlDsiftFilter *	self,
		float const *	im
	)

Compute keypoints and descriptors.

------------------------------------------------------------------

Parameters:

self	DSIFT filter.
im	image data.

Definition at line 664 of file dsift.c.

void vl_dsift_set_bounds	(	VlDsiftFilter *	self,
		int	minX,
		int	minY,
		int	maxX,
		int	maxY
	)

Set bounds.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.
minX	bounding box minimum X coordinate.
minY	bounding box minimum Y coordinate.
maxX	bounding box maximum X coordinate.
maxY	bounding box maximum Y coordinate.

Definition at line 254 of file dsift.h.

void vl_dsift_set_flat_window	(	VlDsiftFilter *	self,
		vl_bool	useFlatWindow
	)

Set flat window flag.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.
useFlatWindow	true if the DSIFT filter should use a flat window.

Definition at line 285 of file dsift.h.

void vl_dsift_set_geometry	(	VlDsiftFilter *	self,
		VlDsiftDescriptorGeometry const *	geom
	)

Set SIFT descriptor geometry.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.
geom	descriptor geometry parameters.

Definition at line 271 of file dsift.h.

void vl_dsift_set_steps	(	VlDsiftFilter *	self,
		int	stepX,
		int	stepY
	)

Set steps.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.
stepX	sampling step along X.
stepY	sampling step along Y.

Definition at line 235 of file dsift.h.

void vl_dsift_set_window_size	(	VlDsiftFilter *	self,
		double	windowSize
	)

Set SIFT descriptor Gaussian window size.

------------------------------------------------------------------

Parameters:

self	DSIFT filter object.
windowSize	window size.

Definition at line 335 of file dsift.h.

VL_INLINE void vl_dsift_transpose_descriptor	(	float *	dst,
		float const *	src,
		int	numBinT,
		int	numBinX,
		int	numBinY
	)

Transpose descriptor.

------------------------------------------------------------------

Parameters:

dst	destination buffer.
src	source buffer.
numBinT
numBinX
numBinY	The function writes to dst the transpose of the SIFT descriptor src. Let I be an image. The transpose operator satisfies the equation transpose(dsift(I,x,y)) = dsift(transpose(I),y,x)

Definition at line 307 of file dsift.h.