ITK  6.0.0
Insight Toolkit
itkTemporalRegion.h
Go to the documentation of this file.
1/*=========================================================================
2 *
3 * Copyright NumFOCUS
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 * https://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#include "ITKVideoCoreExport.h"
27
29#define ITK_INFINITE_FRAME_DURATION itk::NumericTraits<itk::SizeValueType>::max()
30#define ITK_INFINITE_REAL_DURATION RealTimeInterval(ITK_INFINITE_FRAME_DURATION, 0)
31
32namespace itk
33{
43class ITKVideoCore_EXPORT TemporalRegion : public Region
44{
45public:
46
50
51 itkOverrideGetNameOfClassMacro(TemporalRegion);
52
55
57 void
60 GetRealStart() const;
64 void
71 void
78 void
86 GetRegionType() const override;
87
90
92 ~TemporalRegion() override;
93
95 virtual bool
96 IsEqualInFrames(const Self & region) const;
97
99 bool
100 IsEqualInRealTime(const Self & region) const;
101
103 bool
104 operator==(const Self & region) const;
105
107
108protected:
109 void
110 PrintSelf(std::ostream & os, Indent indent) const override;
111
115 RealTimeStamp m_RealStart{};
116
119 RealTimeInterval m_RealDuration{};
120
122 FrameOffsetType m_FrameStart{ 0 };
123
125 FrameOffsetType m_FrameDuration{ 0 };
126
127}; // end class TemporalRegion
128
130ITKVideoCore_EXPORT std::ostream &
131 operator<<(std::ostream & os, const TemporalRegion & region);
132
133} // end namespace itk
134
135#endif
Control indentation during Print() invocation.
Definition: itkIndent.h:50
A data structure for representing the time span between two RealTimeStamps, with similar high precisi...
The RealTimeStamp is a data structure for representing time with high precision and a large dynamic r...
A region represents some portion or piece of data.
Definition: itkRegion.h:66
Region subclass that holds a region in time.
bool IsEqualInRealTime(const Self &region) const
void SetRealStart(const RealTimeStamp s)
virtual bool IsEqualInFrames(const Self &region) const
void SetFrameStart(const FrameOffsetType s)
void SetRealDuration(const RealTimeInterval d)
RealTimeStamp GetRealStart() const
RegionEnum GetRegionType() const override
RealTimeInterval GetRealDuration() const
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self)
void PrintSelf(std::ostream &os, Indent indent) const override
itk::SizeValueType FrameOffsetType
~TemporalRegion() override
FrameOffsetType GetFrameStart() const
void SetFrameDuration(const FrameOffsetType d)
FrameOffsetType GetFrameDuration() const
bool operator==(const Self &region) const
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
ITKCommon_EXPORT std::ostream & operator<<(std::ostream &out, typename AnatomicalOrientation::CoordinateEnum value)
unsigned long SizeValueType
Definition: itkIntTypes.h:86