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
|
/*=========================================================================
*
* Copyright Insight Software Consortium
*
* 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
*
* http://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 itkTemporalDataObject_h
#define itkTemporalDataObject_h
#include "itkDataObject.h"
#include "itkRingBuffer.h"
#include "itkTemporalRegion.h"
#include "ITKVideoCoreExport.h"
namespace itk
{
/** \class TemporalDataObject
* \brief DataObject subclass with knowledge of temporal region
*
* This class represents a data object that relies on temporal regions. It uses
* an itk::RingBuffer to store DataObject pointers in sequential order. The
* pointers in the ring buffer should correspond to the BufferedTemporalRegion.
* The LargestPossibleTemporalRegion should indicate the maximum extent that
* data object is logically capable of holding, and the RequestedTemporalRegion
* is used in the pipeline to request that a certain temporal region be
* buffered
*
* \ingroup ITKVideoCore
*/
class ITK_FORCE_EXPORT_MACRO(ITKVideoCore) TemporalDataObject : public DataObject
{
public:
/** Standard class typedefs */
typedef TemporalDataObject Self;
typedef DataObject Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
typedef WeakPointer< const Self > ConstWeakPointer;
typedef RingBuffer<DataObject> BufferType;
typedef TemporalRegion TemporalRegionType;
/** Enum for defining the way in which to compare temporal regions */
typedef enum {Frame, RealTime, FrameAndRealTime} TemporalUnitType;
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(TemporalDataObject, DataObject);
/** Get the type of temporal units we care about (Defaults to Frame)*/
virtual TemporalUnitType GetTemporalUnit() const;
/** Explicity set temporal units (Defaults to Frame)*/
virtual void SetTemporalUnitToFrame();
virtual void SetTemporalUnitToRealTime();
virtual void SetTemporalUnitToFrameAndRealTime();
/** Get/Set the number of frames that the internal buffer can hold */
SizeValueType GetNumberOfBuffers();
void SetNumberOfBuffers(SizeValueType num);
virtual void SetLargestPossibleTemporalRegion(
const TemporalRegionType & region);
virtual const TemporalRegionType & GetLargestPossibleTemporalRegion() const;
virtual void SetBufferedTemporalRegion(const TemporalRegionType & region);
virtual const TemporalRegionType & GetBufferedTemporalRegion() const;
virtual void SetRequestedTemporalRegion(const TemporalRegionType & region);
virtual const TemporalRegionType & GetRequestedTemporalRegion() const;
/** Get the portion of the requested region that is not covered by the
* buffered region */
virtual const TemporalRegionType GetUnbufferedRequestedTemporalRegion();
virtual void SetRequestedRegionToLargestPossibleRegion() ITK_OVERRIDE;
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion() ITK_OVERRIDE;
virtual bool VerifyRequestedRegion() ITK_OVERRIDE;
virtual void CopyInformation(const DataObject *) ITK_OVERRIDE;
virtual void SetRequestedRegion(const DataObject *) ITK_OVERRIDE;
virtual void Graft(const DataObject *) ITK_OVERRIDE;
protected:
TemporalDataObject();
virtual ~TemporalDataObject() ITK_OVERRIDE;
virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
/** Buffer for holding component data objects */
BufferType::Pointer m_DataObjectBuffer;
/** We want to keep track of our regions in time. **/
TemporalRegionType m_LargestPossibleTemporalRegion;
TemporalRegionType m_RequestedTemporalRegion;
TemporalRegionType m_BufferedTemporalRegion;
TemporalUnitType m_TemporalUnit;
private:
ITK_DISALLOW_COPY_AND_ASSIGN(TemporalDataObject);
}; // end class TemporalDataObject
} // end namespace itk
#endif
|
