#include <itkDataObject.h>
Inheritance diagram for itk::DataObject:
[NOHEADER] | |
| void | GlobalReleaseDataFlagOn () |
| void | GlobalReleaseDataFlagOff () |
| void | SetGlobalReleaseDataFlag (const bool val) |
| bool | GetGlobalReleaseDataFlag () |
Public Types | |
| typedef DataObject | Self |
| typedef Object | Superclass |
| typedef SmartPointer< Self > | Pointer |
| typedef SmartPointer< const Self > | ConstPointer |
Public Member Functions | |
| virtual const char * | GetNameOfClass () const |
| void | DisconnectPipeline () |
| SmartPointerForwardReference< ProcessObject > | GetSource () const |
| unsigned int | GetSourceOutputIndex () const |
| virtual void | Initialize () |
| void | ReleaseData () |
| bool | ShouldIReleaseData () const |
| bool | GetDataReleased () const |
| virtual void | Update () |
| virtual void | UpdateOutputInformation () |
| virtual void | ResetPipeline () |
| virtual unsigned long | GetUpdateMTime () const |
| virtual void | PrepareForNewData () |
| void | DataHasBeenGenerated () |
| virtual void | SetRequestedRegionToLargestPossibleRegion () |
| virtual bool | RequestedRegionIsOutsideOfTheBufferedRegion () |
| virtual bool | VerifyRequestedRegion () |
| virtual void | CopyInformation (const DataObject *) |
| virtual void | SetRequestedRegion (DataObject *) |
| virtual void | Graft (const DataObject *) |
| void | SetReleaseDataFlag (bool flag) |
| virtual const bool & | GetReleaseDataFlag () |
| virtual void | ReleaseDataFlagOn () |
| virtual void | ReleaseDataFlagOff () |
| virtual void | PropagateRequestedRegion () throw (InvalidRequestedRegionError) |
| virtual void | UpdateOutputData () |
| void | SetPipelineMTime (unsigned long time) |
| virtual const unsigned long & | GetPipelineMTime () |
Protected Member Functions | |
| DataObject () | |
| ~DataObject () | |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | PropagateResetPipeline () |
Friends | |
| class | ProcessObject |
| class | DataObjectError |
This is the base class for all data objects in the Insight data processing pipeline. A data object is an object that represents and provides access to data. ProcessObjects (i.e., filters) operate on input data objects, producing new data objects as output. ProcessObject and DataObject are connected together into data flow pipelines.
The data flow pipeline architecture requires that DataObjects and ProcessObjects negotiate the flow of information. When the tail of a pipeline is instructed to Update(), a series of requests are propagated up the pipeline (from a ProcessObject to its inputs (DataObjects), from these inputs to their sources (ProcessObjects), etc.). A call to Update() entails 3 passes up the pipeline (though not all passes will traverse the entire pipeline). The first pass up the pipeline determines when various components of the pipeline were last modified and hence which components will need to be updated. As this first pass in unwinding, meta information about the DataObjects (for instance image spacing and data size) are passed down the pipeline. The second pass up the pipeline propagates a request for a specific piece of information (for instance a sub-region of an image). A request for a piece of a DataObject is propagated to its source, from there to its inputs, etc. allowing each ProcessObject to determine whether (1) it can already satisfy the request (the requested block of data is already available) or (2) the ProcessObject will need to request a new block of data on input to satisfy the output request. Finally, a pass is made up the pipeline to actually calculate the values for the various blocks of data requested (i.e. pixel values are finally calculated). This final pass will only traverse up the pipeline as far as the first two passes have identified. For instance, to satisfy a given request at the tail of a pipeline, only the lower few ProcessObjects may have to re-execute.
There are three types of information negotiated by the pipeline (prior to actual calculation of the bulk data): modified times, meta data, and regions. The modified times keep track of when various data objects were last modified and/updated and the when the various process objects were modified. The meta data is any extra information about the data object that is not part of the bulk data. For instance, an Image maintains pixel spacing and origin meta data. Finally, the pipeline negotiation process passes requests up the pipeline in the form of Regions. A DataObject can have as many as three regions (which themselves could be considered meta data): LargestPossibleRegion, RequestedRegion, and BufferedRegion. The LargestPossibleRegion is the entirety of the dataset (for instance how big is the dataset on disk). LargestPossibleRegions are negotiated during the first pass of a pipeline update (via the method ProcessObject::GenerateOutputInformation() which is called from ProcessObject::UpdateOutputInformation(). The RequestedRegion is the amount of the DataObject that is requested by the user or pipeline. RequestedRegions are negotiated during the second pass of a pipeline update (via the methods ProcessObject::EnlargeOutputRequestedRegion(), ProcessObject::GenerateOutputRequestedRegion(), ProcessObject::GenerateInputRequestedRegion() which are called from ProcessObject::PropagateRequestedRegion()). The BufferedRegion is the amount of the DataObject that is currently in memory. BufferedRegions are defined during the final pass of a pipeline update (when ProcessObjects finally calculate the bulk data via the methods ProcessObject::GenerateData() or ProcessObject::ThreadedGenerateData() which are called by ProcessObject::UpdateOutputData()). These three regions can be different but must satisfy the relationship RequestedRegion <= BufferedRegion <= LargestPossibleRegion. For instance, an Image could be 512x512x200 on disk (LargestPossibleRegion) but the application may only have a 256x256x50 section of the dataset in memory (BufferedRegion) and the user wants to operate on a 100x100x1 section of the buffer (RequestedRegion).
Region negotiation is not applicable for all types of DataObjects. For instance, an EquivalencyTable of segmentation labels can be passed from ProcessObject to ProcessObject as any other DataObject but an EquivalencyTable does not support the concept of a sub-region. Therefore, the region negotiations at the DataObject (superclass) level are implemented as "abstract" concepts (not to be confused with a C++ abstract methods), allowing subclasses to provide specialized implementations on an as needed basis. There are five methods provided in DataObject that a subclass of DataObject may have to override for that particular type of DataObject to flow through the pipeline. These methods should only have to be specialized for DataObjects that do support regions. These methods are:
void UpdateOutputInformation(): This method implements the first pass of the pipeline update mechanism outlined above. It is responsible for identifying when upstream components of the pipeline have been change (ModifiedTimes and Pipeline ModifiedTimes) and is responsible for propagating meta data through the pipeline. In the simplest case, this method simply calls the DataObject's source's UpdateOutputInformation() method (this is the default implementation). For DataObjects that support streaming, this method also propagates LargestPossibleRegions to downstream ProcessObjects.
bool VerifyRequestedRegion(): Verify that the RequestedRegion is within the LargestPossibleRegion. For DataObjects that do not support Regions, this method always returns true.
bool RequestedRegionIsOutsideOfTheBufferedRegion(): Determine whether the RequestedRegion is outside of the current BufferedRegion. This method is used by the second pass of a pipeline update outlined above. It is used to determine whether a filter needs to re-execute in order to satisfy a given request. For DataObjects that do not support Regions, this method always returns false. By always returning false, these types of DataObjects will update solely on the basis of modified times (wherease Images update based on either modified times or the RequestedRegion needs). If this method always returned true, the DataObject would be updated on every single call to Update() (not recommended).
void SetRequestedRegion(DataObject *): Sets the RequestedRegion of this DataObject to match the RequestedRegion of the DataObject that is passed in as a parameter. This method is used by ProcessObject::GenerateOutputRequestedRegion() and by ProcessObject::SetNthOutput(). In the former case, it used as an abstract API so that a ProcessObject can copy a requested region from one output to all its outputs without knowing the particular subclass of DataObject. In the latter case, it used when a ProcessObject has to create an output object to replace one of its outputs (and needs to copy the former object's RequestedRegion). In either case, it allows ProcessObject to perform these actions without knowing the specifics about the particular subclass of DataObject. For DataObjects that do not support Regions, this method does nothing.
void SetRequestedRegionToLargestPossibleRegion(): Sets the RequestedRegion of this DataObject to match its LargestPossibleRegion. This method is used to force a filter to produce all of its output on the next call to Update(). For DataObjects that do not support Regions, this method does nothing.
Definition at line 262 of file itkDataObject.h.
|
|
|
|
|
|
|
|
|
|
|
|
|
Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use. |
|
|
Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input. |
|
|
Get the flag indicating the data has been released. Definition at line 334 of file itkDataObject.h. |
|
|
|
|
|
|
The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object. |
|
|
Turn on/off a flag to control whether this object's data is released after being used by a filter. |
|
|
Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.) GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source. |
|
|
Which of the source's outputs corresponds to this data object? |
|
|
MTime for the last time this DataObject was generated. |
|
|
Definition at line 319 of file itkDataObject.h. |
|
|
Definition at line 317 of file itkDataObject.h. |
|
|
|
|
Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management). Definition at line 389 of file itkDataObject.h. |
|
||||||||||||
|
|
|
Propagate a call to ResetPipeline(). Called only from ProcessObject. |
|
|
Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object. |
|
|
Turn on/off a flag to control whether this object's data is released after being used by a filter. |
|
|
Turn on/off a flag to control whether this object's data is released after being used by a filter. |
|
|
Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute Reimplemented in itk::ImageBase< VImageDimension >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::SpatialObject< TDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >. Definition at line 413 of file itkDataObject.h. |
|
|
Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called. |
|
|
Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects. |
|
|
The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object. Definition at line 373 of file itkDataObject.h. |
|
|
Turn on/off a flag to control whether this object's data is released after being used by a filter. Definition at line 304 of file itkDataObject.h. |
|
|
|
|
Return flag indicating whether data should be released after use by a filter. |
|
|
|
|
|
|
Definition at line 502 of file itkDataObject.h. |
|
|
Friends of DataObject Definition at line 501 of file itkDataObject.h. |
1.3.5 written by Dimitri van Heesch,
© 1997-2000