quickshift.h

Go to the documentation of this file.

/*
Copyright (C) 2007-12 Andrea Vedaldi and Brian Fulkerson.
All rights reserved.

This file is part of the VLFeat library and is made available under
the terms of the BSD license (see the COPYING file).
*/

#ifndef VL_QUICKSHIFT_H
#define VL_QUICKSHIFT_H

#include "generic.h"
#include "mathop.h"

typedef double vl_qs_type ;

#define VL_QS_INF VL_INFINITY_D /* Change to _F for float math */

typedef struct _VlQS
{
  vl_qs_type *image ;   
  int height;           
  int width;            
  int channels;         
  vl_bool medoid;
  vl_qs_type sigma;
  vl_qs_type tau;

  int *parents ;
  vl_qs_type *dists ;
  vl_qs_type *density ;
} VlQS ;

VL_EXPORT
VlQS*  vl_quickshift_new (vl_qs_type const * im, int height, int width,
                          int channels);

VL_EXPORT
void   vl_quickshift_delete (VlQS *q) ;
VL_EXPORT
void   vl_quickshift_process (VlQS *q) ;

VL_INLINE vl_qs_type    vl_quickshift_get_max_dist      (VlQS const *q) ;
VL_INLINE vl_qs_type    vl_quickshift_get_kernel_size    (VlQS const *q) ;
VL_INLINE vl_bool       vl_quickshift_get_medoid   (VlQS const *q) ;

VL_INLINE int *        vl_quickshift_get_parents  (VlQS const *q) ;
VL_INLINE vl_qs_type * vl_quickshift_get_dists    (VlQS const *q) ;
VL_INLINE vl_qs_type * vl_quickshift_get_density  (VlQS const *q) ;
VL_INLINE void vl_quickshift_set_max_dist    (VlQS *f, vl_qs_type tau) ;
VL_INLINE void vl_quickshift_set_kernel_size  (VlQS *f, vl_qs_type sigma) ;
VL_INLINE void vl_quickshift_set_medoid (VlQS *f, vl_bool medoid) ;
/* -------------------------------------------------------------------
 *                                     Inline functions implementation
 * ---------------------------------------------------------------- */

VL_INLINE vl_qs_type
vl_quickshift_get_max_dist (VlQS const *q)
{
  return q->tau ;
}

VL_INLINE vl_qs_type
vl_quickshift_get_kernel_size (VlQS const *q)
{
  return q->sigma ;
}

VL_INLINE vl_bool
vl_quickshift_get_medoid (VlQS const *q)
{
  return q->medoid ;
}

VL_INLINE int *
vl_quickshift_get_parents (VlQS const *q)
{
  return q->parents ;
}

VL_INLINE vl_qs_type *
vl_quickshift_get_dists (VlQS const *q)
{
  return q->dists ;
}

VL_INLINE vl_qs_type *
vl_quickshift_get_density (VlQS const *q)
{
  return q->density ;
}

VL_INLINE void
vl_quickshift_set_kernel_size (VlQS *q, vl_qs_type sigma)
{
  q -> sigma = sigma ;
}

VL_INLINE void
vl_quickshift_set_max_dist (VlQS *q, vl_qs_type tau)
{
  q -> tau = tau ;
}

VL_INLINE void
vl_quickshift_set_medoid (VlQS *q, vl_bool medoid)
{
  q -> medoid = medoid ;
}


#endif