ITK  4.3.0
Insight Segmentation and Registration Toolkit
itkTemporalRegion.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef __itkTemporalRegion_h
19 #define __itkTemporalRegion_h
20 
21 #include "itkRegion.h"
22 #include "itkRealTimeStamp.h"
23 #include "itkRealTimeInterval.h"
24 #include "itkNumericTraits.h"
25 #include <climits>
26 
28 #define ITK_INFINITE_FRAME_DURATION itk::NumericTraits<itk::SizeValueType>::max()
29 #define ITK_INFINITE_REAL_DURATION RealTimeInterval(ITK_INFINITE_FRAME_DURATION, 0)
30 
31 namespace itk
32 {
41 class ITK_EXPORT TemporalRegion : public Region
42 {
43 public:
44 
47  typedef Region Superclass;
48 
49  itkTypeMacro(TemporalRegion, Region);
50 
53 
55  void SetRealStart(const RealTimeStamp s);
56  RealTimeStamp GetRealStart() const;
58 
60  void SetRealDuration(const RealTimeInterval d);
61  RealTimeInterval GetRealDuration() const;
63 
65  void SetFrameStart(const FrameOffsetType s);
66  FrameOffsetType GetFrameStart() const;
68 
70  void SetFrameDuration(const FrameOffsetType d);
71  FrameOffsetType GetFrameDuration() const;
73 
75  virtual RegionType GetRegionType() const;
76 
79 
81  virtual ~TemporalRegion();
82 
84  virtual bool IsEqualInFrames(const Self & region) const;
85 
87  bool IsEqualInRealTime(const Self & region) const;
88 
90  bool operator==(const Self & region) const;
91 
92  bool operator!=(const Self & region) const;
93 
94 protected:
95 
96  virtual void PrintSelf(std::ostream & os, Indent indent) const;
97 
103 
104 }; // end class TemporalRegion
105 
107 std::ostream & operator<<(std::ostream & os, const TemporalRegion & region);
108 
109 } // end namespace itk
110 
111 #endif
112