File: itkMeanShiftModeCacheMethod.h

package info (click to toggle)
insighttoolkit 3.18.0-5
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 110,432 kB
  • ctags: 74,559
  • sloc: cpp: 412,627; ansic: 196,210; fortran: 28,000; python: 3,852; tcl: 2,005; sh: 1,186; java: 583; makefile: 458; csh: 220; perl: 193; xml: 20
file content (153 lines) | stat: -rw-r--r-- 4,786 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMeanShiftModeCacheMethod.h,v $
  Language:  C++
  Date:      $Date: 2009-03-04 15:23:58 $
  Version:   $Revision: 1.6 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#ifndef __itkMeanShiftModeCacheMethod_h
#define __itkMeanShiftModeCacheMethod_h

#include <map>
#include "itkMacro.h"
#include "itkObject.h"
#include "itkMeasurementVectorTraits.h"

namespace itk { 
namespace Statistics {
  
/** \class MeanShiftModeCacheMethod
 * \brief This class stores mappings between a query point and its
 * resulting mode point.
 *
 * To increase the mean shift mode search performance, this class
 * stores mappings between a query point (starting position of search)
 * and the result so that if there is a mapping stored for a specific
 * query point, mode seeker can return the resulting mode point stored
 * in this class.
 *
 * You can specify how many mappings stored in this class using the
 * SetMaximumEntries method. The cache is destroyed and the rebuild
 * starts when the hit ratio (the number of successful mapping found
 * divided by the number of failure) is below the hit ratio threshold
 * set by the SetHitRatioThreshold method or the number of consecutive
 * failure exceeds the limit set by the SetMaximumConsecutiveFailures
 * method.
 *
 * <b>Recent API changes:</b>
 * The static const macro to get the length of a measurement vector,
 * \c MeasurementVectorSize  has been removed to allow the length of a measurement
 * vector to be specified at run time. It is now obtained at run time from the
 * measurement vectors.
 * 
 * \sa MeanShiftModeSeekerBase
 */

template< class TMeasurementVector >
class MeanShiftModeCacheMethod :
    public Object
{
public:
  /** Standard class typedefs. */
  typedef MeanShiftModeCacheMethod Self;
  typedef Object                   Superclass;
  typedef SmartPointer<Self>       Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  /** Standard Macros */
  itkTypeMacro(MeanShiftModeCacheMethod, Object);
  itkNewMacro(Self);
  
  typedef TMeasurementVector MeasurementVectorType;

  struct LessMeasurementVector
    {
    bool operator()(const MeasurementVectorType& mv1, 
                    const MeasurementVectorType& mv2) const
      {
      // It is assumed that mv1 and mv2 are of the same length. For efficieny,
      // no checking is performed here.
      for ( unsigned int i = 0; 
            i < MeasurementVectorTraits::GetLength( &mv1 );
            ++i )
        {
        if (mv1[i] < mv2[i])
          {
          return true;
          }
        }
      return false;
      }
  }; // end of struct

  typedef std::map< MeasurementVectorType, MeasurementVectorType, LessMeasurementVector > CacheTableType;

  void SetMaximumConsecutiveFailures(unsigned int number)
    { m_MaximumConsecutiveFailures = number; }

  unsigned int GetMaximumConsecutiveFailures()
    { return m_MaximumConsecutiveFailures; }
  
  void SetHitRatioThreshold(float threshold)
    { m_HitRatioThreshold = threshold; }

  void SetMaximumEntries(unsigned int number)
    { m_MaximumEntries = number; }

  unsigned int GetMaximumEntries()
    { return m_MaximumEntries; }

  bool SetMeasurementVector(MeasurementVectorType& source, 
                            MeasurementVectorType& target);

  bool GetMeasurementVector(MeasurementVectorType& source,
                            MeasurementVectorType& target);

  bool IsFull();

  void DestroyCacheTable();

protected:
  MeanShiftModeCacheMethod();
  virtual ~MeanShiftModeCacheMethod();
  void PrintSelf(std::ostream& os, Indent indent) const;

private:
  unsigned int m_MaximumEntries;
  float        m_HitRatioThreshold;
  unsigned int m_MaximumConsecutiveFailures;

  unsigned int m_NumberOfRequests;
  unsigned int m_ConsecutiveFailures;
  unsigned int m_HitsSuccess;

  unsigned long m_TotalHitsSuccess;
  unsigned long m_TotalHitsFailure;

  unsigned long m_TotalTableSize;
  unsigned int  m_TimesOfRebuilding;

  unsigned int m_TimesOfRebuildingByHitRatio;
  unsigned int m_TimesOfRebuildingByConsecutiveFailures;

  CacheTableType m_CacheTable;
}; // end of class
    
} // end of namespace Statistics 
} // end of namespace itk 

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMeanShiftModeCacheMethod.txx"
#endif

#endif