File: itkRingBuffer.hxx

package info (click to toggle)
insighttoolkit5 5.4.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 704,404 kB
  • sloc: cpp: 783,697; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 461; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (171 lines) | stat: -rw-r--r-- 4,418 bytes parent folder | download | duplicates (2)
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkRingBuffer_hxx
#define itkRingBuffer_hxx

#include "itkMath.h"
#include "itkPrintHelper.h"

namespace itk
{

template <typename TElement>
RingBuffer<TElement>::RingBuffer()
  : m_PointerVector()
{
  // Default to 3 buffers
  this->SetNumberOfBuffers(3);
}

template <typename TElement>
void
RingBuffer<TElement>::PrintSelf(std::ostream & os, Indent indent) const
{
  using namespace print_helper;

  Superclass::PrintSelf(os, indent);

  os << indent << "PointerVector: " << m_PointerVector << std::endl;
}

template <typename TElement>
void
RingBuffer<TElement>::MoveHead(OffsetValueType offset)
{
  // Compute the new Head index
  this->m_HeadIndex = this->GetOffsetBufferIndex(offset);

  // Mark as modified
  this->Modified();
}

template <typename TElement>
void
RingBuffer<TElement>::MoveHeadForward()
{
  this->MoveHead(1);
}

template <typename TElement>
void
RingBuffer<TElement>::MoveHeadBackward()
{
  this->MoveHead(-1);
}

template <typename TElement>
bool
RingBuffer<TElement>::BufferIsFull(OffsetValueType offset)
{
  auto bufferIndex = static_cast<size_t>(this->GetOffsetBufferIndex(offset));

  return !(this->m_PointerVector[bufferIndex].IsNull());
}

template <typename TElement>
typename TElement::Pointer
RingBuffer<TElement>::GetBufferContents(OffsetValueType offset)
{
  // Get the right buffer
  auto bufferIndex = static_cast<size_t>(this->GetOffsetBufferIndex(offset));

  // Return the resulting image
  return this->m_PointerVector[bufferIndex];
}

template <typename TElement>
void
RingBuffer<TElement>::SetBufferContents(OffsetValueType offset, ElementPointer element)
{
  // Get the right buffer
  auto bufferIndex = static_cast<size_t>(this->GetOffsetBufferIndex(offset));

  // Set the pointer
  this->m_PointerVector[bufferIndex] = element;

  // Mark as modified
  this->Modified();
}

template <typename TElement>
auto
RingBuffer<TElement>::GetNumberOfBuffers() -> SizeValueType
{
  return static_cast<typename RingBuffer<TElement>::SizeValueType>(this->m_PointerVector.size());
}

template <typename TElement>
void
RingBuffer<TElement>::SetNumberOfBuffers(SizeValueType n)
{
  size_t currentSize = this->m_PointerVector.size();

  // If larger than current size, insert difference after tail
  if (n > currentSize)
  {
    for (size_t i = 0; i < n - currentSize; ++i)
    {
      ElementPointer newPointer = nullptr;
      this->m_PointerVector.insert(this->m_PointerVector.begin() + this->m_HeadIndex, newPointer);

      // Increment head index if this wasn't the first one added
      if (this->m_PointerVector.size() > 1)
      {
        this->m_HeadIndex++;
      }
    }
  }

  // If smaller than current size, remove difference starting at tail
  else if (n < currentSize)
  {
    for (size_t i = 0; i < currentSize - n; ++i)
    {
      const auto tailIndex = static_cast<SizeValueType>(this->GetOffsetBufferIndex(1));
      this->m_PointerVector.erase(this->m_PointerVector.begin() + tailIndex);

      // Decrement head index if necessary
      if (this->m_HeadIndex > tailIndex)
      {
        this->m_HeadIndex--;
      }
    }
  }

  this->Modified();
}

template <typename TElement>
auto
RingBuffer<TElement>::GetOffsetBufferIndex(OffsetValueType offset) -> OffsetValueType
{
  OffsetValueType moddedOffset = itk::Math::abs(offset) % this->GetNumberOfBuffers();
  auto            signedHeadIndex = static_cast<OffsetValueType>(m_HeadIndex);
  if (offset >= 0)
  {
    return (signedHeadIndex + moddedOffset) % this->GetNumberOfBuffers();
  }
  else
  {
    return (signedHeadIndex + (this->GetNumberOfBuffers() - moddedOffset)) % this->GetNumberOfBuffers();
  }
}

} // end namespace itk

#endif