-
-
Notifications
You must be signed in to change notification settings - Fork 661
/
itkStreamingImageFilter.hxx
248 lines (215 loc) · 6.71 KB
/
itkStreamingImageFilter.hxx
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/*=========================================================================
*
* 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 itkStreamingImageFilter_hxx
#define itkStreamingImageFilter_hxx
#include "itkStreamingImageFilter.h"
#include "itkCommand.h"
#include "itkImageAlgorithm.h"
#include "itkImageRegionSplitterSlowDimension.h"
namespace itk
{
/**
*
*/
template< typename TInputImage, typename TOutputImage >
StreamingImageFilter< TInputImage, TOutputImage >
::StreamingImageFilter()
{
// default to 10 divisions
m_NumberOfStreamDivisions = 10;
// create default region splitter
m_RegionSplitter = ImageRegionSplitterSlowDimension::New();
}
/**
*
*/
template< typename TInputImage, typename TOutputImage >
StreamingImageFilter< TInputImage, TOutputImage >
::~StreamingImageFilter()
{}
/**
*
*/
template< typename TInputImage, typename TOutputImage >
void
StreamingImageFilter< TInputImage, TOutputImage >
::PrintSelf(std::ostream & os, Indent indent) const
{
Superclass::PrintSelf(os, indent);
os << indent << "Number of stream divisions: " << m_NumberOfStreamDivisions
<< std::endl;
if ( m_RegionSplitter )
{
os << indent << "Region splitter:" << m_RegionSplitter << std::endl;
}
else
{
os << indent << "Region splitter: (none)" << std::endl;
}
}
/**
*
*/
template< typename TInputImage, typename TOutputImage >
void
StreamingImageFilter< TInputImage, TOutputImage >
::PropagateRequestedRegion(DataObject *output)
{
/**
* check flag to avoid executing forever if there is a loop
*/
if ( this->m_Updating )
{
return;
}
/**
* Give the subclass a chance to indicate that it will provide
* more data then required for the output. This can happen, for
* example, when a source can only produce the whole output.
* Although this is being called for a specific output, the source
* may need to enlarge all outputs.
*/
this->EnlargeOutputRequestedRegion(output);
/**
* Give the subclass a chance to define how to set the requested
* regions for each of its outputs, given this output's requested
* region. The default implementation is to make all the output
* requested regions the same. A subclass may need to override this
* method if each output is a different resolution.
*/
this->GenerateOutputRequestedRegion(output);
// we don't call GenerateInputRequestedRegion since the requested
// regions are manage when the pipeline is execute
// we don't call inputs PropagateRequestedRegion either
// because the pipeline managed later
}
/**
*
*/
template< typename TInputImage, typename TOutputImage >
void
StreamingImageFilter< TInputImage, TOutputImage >
::UpdateOutputData( DataObject *itkNotUsed(output) )
{
unsigned int idx;
/**
* prevent chasing our tail
*/
if ( this->m_Updating )
{
return;
}
/**
* Prepare all the outputs. This may deallocate previous bulk data.
*/
this->PrepareOutputs();
/**
* Make sure we have the necessary inputs
*/
const itk::ProcessObject::DataObjectPointerArraySizeType &ninputs = this->GetNumberOfValidRequiredInputs();
if ( ninputs < this->GetNumberOfRequiredInputs() )
{
itkExceptionMacro(
<< "At least " << static_cast< unsigned int >( this->GetNumberOfRequiredInputs() )
<< " inputs are required but only " << ninputs << " are specified.");
return;
}
/**
* Tell all Observers that the filter is starting, before emiting
* the 0.0 Progress event
*/
this->InvokeEvent( StartEvent() );
this->SetAbortGenerateData(0);
this->UpdateProgress(0.0);
this->m_Updating = true;
/**
* Allocate the output buffer.
*/
OutputImageType *outputPtr = this->GetOutput(0);
const OutputImageRegionType outputRegion = outputPtr->GetRequestedRegion();
outputPtr->SetBufferedRegion(outputRegion);
outputPtr->Allocate();
/**
* Grab the input
*/
InputImageType * inputPtr =
const_cast< InputImageType * >( this->GetInput(0) );
/**
* Determine of number of pieces to divide the input. This will be the
* minimum of what the user specified via SetNumberOfStreamDivisions()
* and what the Splitter thinks is a reasonable value.
*/
unsigned int numDivisions, numDivisionsFromSplitter;
numDivisions = m_NumberOfStreamDivisions;
numDivisionsFromSplitter =
m_RegionSplitter
->GetNumberOfSplits(outputRegion, m_NumberOfStreamDivisions);
if ( numDivisionsFromSplitter < numDivisions )
{
numDivisions = numDivisionsFromSplitter;
}
/**
* Loop over the number of pieces, execute the upstream pipeline on each
* piece, and copy the results into the output image.
*/
unsigned int piece=0;
for (;
piece < numDivisions && !this->GetAbortGenerateData();
piece++ )
{
InputImageRegionType streamRegion = outputRegion;
m_RegionSplitter->GetSplit(piece, numDivisions, streamRegion);
inputPtr->SetRequestedRegion(streamRegion);
inputPtr->PropagateRequestedRegion();
inputPtr->UpdateOutputData();
// copy the result to the proper place in the output. the input
// requested region determined by the RegionSplitter (as opposed
// to what the pipeline might have enlarged it to) is used to
// copy the regions from the input to output
ImageAlgorithm::Copy( inputPtr, outputPtr, streamRegion, streamRegion );
this->UpdateProgress( static_cast<float>(piece) / static_cast<float>(numDivisions) );
}
/**
* If we ended due to aborting, push the progress up to 1.0 (since
* it probably didn't end there)
*/
if ( !this->GetAbortGenerateData() )
{
this->UpdateProgress(1.0);
}
// Notify end event observers
this->InvokeEvent( EndEvent() );
/**
* Now we have to mark the data as up to data.
*/
for ( idx = 0; idx < this->GetNumberOfOutputs(); ++idx )
{
if ( this->GetOutput(idx) )
{
this->GetOutput(idx)->DataHasBeenGenerated();
}
}
/**
* Release any inputs if marked for release
*/
this->ReleaseInputs();
// Mark that we are no longer updating the data in this filter
this->m_Updating = false;
}
} // end namespace itk
#endif