forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itkDataObject.cxx
443 lines (371 loc) · 9.83 KB
/
itkDataObject.cxx
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkDataObject.cxx
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
Portions of this code are covered under the VTK copyright.
See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#include "itkDataObject.h"
#include "itkProcessObject.h"
#include "itkObjectFactory.h"
#include "itkSmartPointerForwardReference.txx"
// Manual instantiation is necessary to prevent link errors
template class itk::SmartPointerForwardReference<itk::ProcessObject>;
namespace itk
{
// after use by filter
bool DataObject::m_GlobalReleaseDataFlag = false;
DataObjectError
::DataObjectError()
: ExceptionObject(), m_DataObject(0)
{
}
DataObjectError
::DataObjectError(const char *file, unsigned int lineNumber)
: ExceptionObject(file, lineNumber), m_DataObject(0)
{
}
DataObjectError
::DataObjectError(const std::string& file, unsigned int lineNumber)
: ExceptionObject(file, lineNumber), m_DataObject(0)
{
}
DataObjectError
::DataObjectError(const DataObjectError &orig)
: ExceptionObject( orig )
{
m_DataObject = orig.m_DataObject;
}
DataObjectError&
DataObjectError
::operator=( const DataObjectError& orig)
{
ExceptionObject::operator= (orig);
m_DataObject = orig.m_DataObject;
return *this;
}
void
DataObjectError
::SetDataObject(DataObject *dobj)
{
m_DataObject = dobj;
}
DataObject*
DataObjectError
::GetDataObject()
{
return m_DataObject;
}
void
DataObjectError
::PrintSelf(std::ostream& os, Indent indent) const
{
ExceptionObject::Print( os);
os << indent << "Data object: ";
if (m_DataObject)
{
os << std::endl;
m_DataObject->PrintSelf(os, indent.GetNextIndent());
}
else
{
os << "(None)" << std::endl;
}
}
InvalidRequestedRegionError
::InvalidRequestedRegionError()
: DataObjectError()
{
}
InvalidRequestedRegionError
::InvalidRequestedRegionError(const char *file, unsigned int lineNumber)
: DataObjectError(file, lineNumber)
{
}
InvalidRequestedRegionError
::InvalidRequestedRegionError(const std::string& file, unsigned int lineNumber)
: DataObjectError(file, lineNumber)
{
}
InvalidRequestedRegionError
::InvalidRequestedRegionError(const InvalidRequestedRegionError &orig)
: DataObjectError( orig )
{
}
InvalidRequestedRegionError&
InvalidRequestedRegionError
::operator=( const InvalidRequestedRegionError& orig)
{
DataObjectError::operator= (orig);
return *this;
}
void
InvalidRequestedRegionError
::PrintSelf(std::ostream& os, Indent indent) const
{
DataObjectError::PrintSelf( os, indent );
}
//----------------------------------------------------------------------------
DataObject::
DataObject() : m_UpdateMTime()
{
m_Source = 0;
m_SourceOutputIndex = 0;
m_ReleaseDataFlag = false;
// We have to assume that if a user is creating the data on their own,
// then they will fill it with valid data.
m_DataReleased = false;
m_PipelineMTime = 0;
}
//----------------------------------------------------------------------------
DataObject
::~DataObject()
{
}
//----------------------------------------------------------------------------
void
DataObject
::Initialize()
{
// We don't modify ourselves because the "ReleaseData" methods depend upon
// no modification when initialized.
//
}
//----------------------------------------------------------------------------
void
DataObject
::SetGlobalReleaseDataFlag(bool val)
{
if (val == m_GlobalReleaseDataFlag)
{
return;
}
m_GlobalReleaseDataFlag = val;
}
//----------------------------------------------------------------------------
bool
DataObject
::GetGlobalReleaseDataFlag()
{
return m_GlobalReleaseDataFlag;
}
//----------------------------------------------------------------------------
void
DataObject
::ReleaseData()
{
this->Initialize();
m_DataReleased = true;
}
//----------------------------------------------------------------------------
bool
DataObject
::ShouldIReleaseData() const
{
return ( m_GlobalReleaseDataFlag || m_ReleaseDataFlag );
}
//----------------------------------------------------------------------------
// Set the process object that generates this data object.
//
void
DataObject
::DisconnectPipeline()
{
itkDebugMacro( "disconnecting from the pipeline." );
// disconnect ourselves from the current process object
if (m_Source)
{
m_Source->SetNthOutput(m_SourceOutputIndex, 0);
}
// set our release data flag to off by default (purposely done after
// we have disconnected from the pipeline so the new output of the
// source can copy our original ReleaseDataFlag)
this->ReleaseDataFlagOff();
// reset our PipelineMTime (there is now nothing upstream from us)
m_PipelineMTime = 0;
this->Modified();
}
bool
DataObject
::DisconnectSource(ProcessObject *arg, unsigned long idx) const
{
if ( m_Source == arg && m_SourceOutputIndex == idx)
{
itkDebugMacro( "disconnecting source " << arg
<< ", source output index " << idx);
m_Source = 0;
m_SourceOutputIndex = 0;
this->Modified();
return true;
}
else
{
itkDebugMacro( "could not disconnect source " << arg
<< ", source output index " << idx);
return false;
}
}
bool
DataObject
::ConnectSource(ProcessObject *arg, unsigned long idx) const
{
if ( m_Source != arg || m_SourceOutputIndex != idx)
{
itkDebugMacro( "connecting source " << arg
<< ", source output index " << idx);
m_Source = arg;
m_SourceOutputIndex = idx;
this->Modified();
return true;
}
else
{
itkDebugMacro( "could not connect source " << arg
<< ", source output index " << idx);
return false;
}
}
//----------------------------------------------------------------------------
SmartPointerForwardReference<ProcessObject>
DataObject
::GetSource() const
{
itkDebugMacro("returning Source address " << m_Source.GetPointer() );
return m_Source.GetPointer();
}
unsigned int
DataObject
::GetSourceOutputIndex() const
{
itkDebugMacro("returning Source index " << m_SourceOutputIndex );
return m_SourceOutputIndex;
}
//----------------------------------------------------------------------------
void
DataObject
::PrintSelf(std::ostream& os, Indent indent) const
{
Object::PrintSelf(os,indent);
if ( m_Source )
{
os << indent << "Source: (" << m_Source.GetPointer() << ") \n";
os << indent << "Source output index: " << m_SourceOutputIndex << "\n";
}
else
{
os << indent << "Source: (none)\n";
os << indent << "Source output index: 0\n";
}
os << indent << "Release Data: "
<< (m_ReleaseDataFlag ? "On\n" : "Off\n");
os << indent << "Data Released: "
<< (m_DataReleased ? "True\n" : "False\n");
os << indent << "Global Release Data: "
<< (m_GlobalReleaseDataFlag ? "On\n" : "Off\n");
os << indent << "PipelineMTime: " << m_PipelineMTime << std::endl;
os << indent << "UpdateMTime: " << m_UpdateMTime << std::endl;
}
// The following methods are used for updating the data processing pipeline.
//
//----------------------------------------------------------------------------
void
DataObject
::Update()
{
this->UpdateOutputInformation();
this->PropagateRequestedRegion();
this->UpdateOutputData();
}
void
DataObject
::UpdateOutputInformation()
{
if (this->GetSource())
{
this->GetSource()->UpdateOutputInformation();
}
}
void
DataObject
::ResetPipeline()
{
this->PropagateResetPipeline();
}
void
DataObject
::PropagateResetPipeline()
{
if (m_Source)
{
m_Source->PropagateResetPipeline();
}
}
//----------------------------------------------------------------------------
void
DataObject
::PropagateRequestedRegion() throw (InvalidRequestedRegionError)
{
// If we need to update due to PipelineMTime, or the fact that our
// data was released, then propagate the update region to the source
// if there is one.
if ( m_UpdateMTime < m_PipelineMTime || m_DataReleased ||
this->RequestedRegionIsOutsideOfTheBufferedRegion() )
{
if ( m_Source )
{
m_Source->PropagateRequestedRegion(this);
}
}
// Check that the requested region lies within the largest possible region
if ( ! this->VerifyRequestedRegion() )
{
// invalid requested region, throw an exception
InvalidRequestedRegionError e(__FILE__, __LINE__);
e.SetLocation(ITK_LOCATION);
e.SetDescription("Requested region is (at least partially) outside the largest possible region.");
e.SetDataObject(this);
throw e;
// return;
}
}
//----------------------------------------------------------------------------
void
DataObject
::UpdateOutputData()
{
// If we need to update due to PipelineMTime, or the fact that our
// data was released, then propagate the UpdateOutputData to the source
// if there is one.
if ( m_UpdateMTime < m_PipelineMTime || m_DataReleased ||
this->RequestedRegionIsOutsideOfTheBufferedRegion() )
{
if ( m_Source )
{
m_Source->UpdateOutputData(this);
}
}
}
//----------------------------------------------------------------------------
void
DataObject
::DataHasBeenGenerated()
{
m_DataReleased = 0;
this->Modified();
m_UpdateMTime.Modified();
}
//----------------------------------------------------------------------------
unsigned long
DataObject
::GetUpdateMTime() const
{
return m_UpdateMTime.GetMTime();
}
} // end namespace itk