ITK  5.2.0
Insight Toolkit
itkTemporalProcessObject.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  * 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 itkTemporalProcessObject_h
19 #define itkTemporalProcessObject_h
20 
21 #include "itkProcessObject.h"
22 #include "itkTemporalRegion.h"
23 #include "ITKVideoCoreExport.h"
24 
25 namespace itk
26 {
27 
28 // Forward reference because of circular dependencies
29 class ITK_FORWARD_EXPORT TemporalDataObject;
30 
66 class ITKVideoCore_EXPORT TemporalProcessObject : public ProcessObject
67 {
68 public:
69  ITK_DISALLOW_COPY_AND_ASSIGN(TemporalProcessObject);
70 
71  /*-TYPEDEFS----------------------------------------------------------------*/
72 
78 
80  itkTypeMacro(TemporalProcessObject, ProcessObject);
81 
82  /*-PUBLIC METHODS----------------------------------------------------------*/
83 
86  void
87  EnlargeOutputRequestedRegion(DataObject * output) override;
88 
89  void
90  GenerateOutputRequestedRegion(DataObject * output) override;
91 
92  void
93  GenerateInputRequestedRegion() override;
94 
98  itkGetMacro(UnitInputNumberOfFrames, SizeValueType);
99 
103  itkGetMacro(UnitOutputNumberOfFrames, SizeValueType);
104 
110  void
111  UpdateOutputInformation() override;
112 
124  void
125  UpdateOutputData(DataObject * output) override;
126 
137  void
138  GenerateData() override;
139 
146  virtual void
147  TemporalStreamingGenerateData();
148 
149 protected:
150  /*-PROTECTED METHODS-------------------------------------------------------*/
151 
154 
156  ~TemporalProcessObject() override = default;
157 
159  void
160  PrintSelf(std::ostream & os, Indent indent) const override;
161 
166  virtual void
167  EnlargeOutputRequestedTemporalRegion(TemporalDataObject * output);
168 
176  virtual void
177  GenerateOutputRequestedTemporalRegion(TemporalDataObject * output);
178 
190  virtual void
191  GenerateInputRequestedTemporalRegion();
192 
201  virtual std::vector<TemporalRegion>
202  SplitRequestedTemporalRegion();
203 
208  virtual void
210  {}
211 
216  virtual void
218  {}
219 
223  virtual TemporalRegion
224  GenerateDefaultLargestPossibleTemporalRegion();
225 
226  itkSetMacro(UnitInputNumberOfFrames, SizeValueType);
227  itkSetMacro(UnitOutputNumberOfFrames, SizeValueType);
228  itkSetMacro(FrameSkipPerOutput, OffsetValueType);
229  itkSetMacro(InputStencilCurrentFrameIndex, SizeValueType);
230  itkGetMacro(InputStencilCurrentFrameIndex, SizeValueType);
231 
232  /*-PROTECTED MEMBERS-------------------------------------------------------*/
233 
236  SizeValueType m_UnitInputNumberOfFrames{ 1 };
237  SizeValueType m_UnitOutputNumberOfFrames{ 1 };
238 
242  OffsetValueType m_FrameSkipPerOutput{ 1 };
243 
249  SizeValueType m_InputStencilCurrentFrameIndex{ 0 };
250 }; // end class TemporalProcessObject
251 
252 } // end namespace itk
253 
254 #endif
itk::TemporalProcessObject::BeforeTemporalStreamingGenerateData
virtual void BeforeTemporalStreamingGenerateData()
Definition: itkTemporalProcessObject.h:209
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::TemporalProcessObject
TemporalProcessObject implements a ProcessObject for the itk pipeline with the notion of a temporal r...
Definition: itkTemporalProcessObject.h:66
itk::TemporalProcessObject::AfterTemporalStreamingGenerateData
virtual void AfterTemporalStreamingGenerateData()
Definition: itkTemporalProcessObject.h:217
itk::TemporalRegion
Region subclass that holds a region in time.
Definition: itkTemporalRegion.h:43
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkProcessObject.h
itkTemporalRegion.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::OffsetValueType
signed long OffsetValueType
Definition: itkIntTypes.h:94
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ProcessObject
class ITK_FORWARD_EXPORT ProcessObject
Definition: itkDataObject.h:41
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:83
itk::TemporalDataObject
DataObject subclass with knowledge of temporal region.
Definition: itkTemporalDataObject.h:65
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293