#include <itkDataObject.h>

Inheritance diagram for itk::DataObject:

Collaboration diagram for itk::DataObject:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type

using	Pointer = SmartPointer< Self >

using	Self = DataObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const char *	GetNameOfClass () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual void	Initialize ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

bool	ShouldIReleaseData () const

virtual void	Update ()

virtual void	UpdateOutputData ()

virtual void	UpdateOutputInformation ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static Pointer	New ()

static void	SetGlobalReleaseDataFlag (bool val)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

WeakPointer< ProcessObject >	m_Source

DataObjectIdentifierType	m_SourceOutputName

TimeStamp	m_UpdateMTime

RealTimeStamp	m_RealTimeStamp

bool	m_ReleaseDataFlag

bool	m_DataReleased

ModifiedTimeType	m_PipelineMTime

static bool *	m_GlobalReleaseDataFlag

class	ProcessObject

class	DataObjectError

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

virtual void	PrepareForNewData ()

virtual void	DataHasBeenGenerated ()

virtual void	SetRequestedRegionToLargestPossibleRegion ()

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()

virtual bool	VerifyRequestedRegion ()

virtual void	CopyInformation (const DataObject *)

virtual void	SetRequestedRegion (const DataObject *)

virtual void	Graft (const DataObject *)

	DataObject ()

	~DataObject () override

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	PropagateResetPipeline ()

bool	ConnectSource (ProcessObject *arg, const DataObjectIdentifierType &name)

bool	DisconnectSource (ProcessObject *arg, const DataObjectIdentifierType &name)

	itkGetGlobalDeclarationMacro (bool, GlobalReleaseDataFlag)

Additional Inherited Members
Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

void	PrintSelf (std::ostream &os, Indent indent) const override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

Base class for all data objects in ITK.

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::DynamicThreadedGenerateData() 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 (whereas 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(const 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.

See also: ProcessObject; ImageBase; Mesh

Definition at line 293 of file itkDataObject.h.

Member Typedef Documentation

◆ ConstPointer

using itk::DataObject::ConstPointer = SmartPointer<const Self>

Definition at line 302 of file itkDataObject.h.

◆ DataObjectIdentifierType

using itk::DataObject::DataObjectIdentifierType = std::string

Definition at line 304 of file itkDataObject.h.

◆ DataObjectPointerArraySizeType

using itk::DataObject::DataObjectPointerArraySizeType = std::vector<Pointer>::size_type

Which of the source's outputs corresponds to this data object?

Definition at line 335 of file itkDataObject.h.

◆ Pointer

using itk::DataObject::Pointer = SmartPointer<Self>

Definition at line 301 of file itkDataObject.h.

◆ Self

using itk::DataObject::Self = DataObject

Standard class type aliases.

Definition at line 299 of file itkDataObject.h.

◆ Superclass

using itk::DataObject::Superclass = Object

Definition at line 300 of file itkDataObject.h.

Constructor & Destructor Documentation

◆ DataObject()

itk::DataObject::DataObject ( )

protected

Who generated this data?

◆ ~DataObject()

itk::DataObject::~DataObject ( )

overrideprotected

Who generated this data?

Member Function Documentation

◆ ConnectSource()

bool itk::DataObject::ConnectSource	(	ProcessObject *	arg,
		const DataObjectIdentifierType &	name
	)

private

Connect the specified process object to the data object. This should only be called from a process object. The second parameter indicates which of the source's outputs corresponds to this data object.

◆ CopyInformation()

virtual void itk::DataObject::CopyInformation ( const DataObject * )

inlinevirtual

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Definition at line 527 of file itkDataObject.h.

◆ DataHasBeenGenerated()

virtual void itk::DataObject::DataHasBeenGenerated ( )

virtual

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.

Reimplemented in itk::GPUImage< TPixel, VImageDimension >.

◆ DisconnectPipeline()

void itk::DataObject::DisconnectPipeline ( )

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.

◆ DisconnectSource()

bool itk::DataObject::DisconnectSource	(	ProcessObject *	arg,
		const DataObjectIdentifierType &	name
	)

private

Disconnect the specified process object from the data object. This should only be called from a process object. An application should call DataObject::DisconnectPipeline() if it wants to disconnect a data object from a pipeline. The second parameter indicates which of the source's outputs corresponds to this data object. If the specified source output name does not match the name cached when the data object was connected to the pipeline (see ConnectSource), then nothing is done.

◆ GetDataReleased()

bool itk::DataObject::GetDataReleased ( ) const

inline

Get the flag indicating the data has been released.

Definition at line 389 of file itkDataObject.h.

◆ GetGlobalReleaseDataFlag()

static bool itk::DataObject::GetGlobalReleaseDataFlag ( )

static

◆ GetNameOfClass()

virtual const char* itk::DataObject::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

◆ GetPipelineMTime()

virtual const ModifiedTimeType& itk::DataObject::GetPipelineMTime ( ) const

virtual

Who generated this data?

◆ GetRealTimeStamp()

virtual const RealTimeStamp& itk::DataObject::GetRealTimeStamp ( ) const

virtual

Who generated this data?

◆ GetReleaseDataFlag()

virtual const bool& itk::DataObject::GetReleaseDataFlag ( ) const

virtual

◆ GetSource()

SmartPointer<ProcessObject> itk::DataObject::GetSource ( ) const

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. )

◆ GetSourceOutputIndex()

DataObjectPointerArraySizeType itk::DataObject::GetSourceOutputIndex ( ) const

◆ GetSourceOutputName()

const DataObjectIdentifierType& itk::DataObject::GetSourceOutputName ( ) const

Which of the source's outputs corresponds to this data object?

◆ GetUpdateMTime()

virtual ModifiedTimeType itk::DataObject::GetUpdateMTime ( ) const

virtual

MTime for the last time this DataObject was generated.

◆ GlobalReleaseDataFlagOff()

static void itk::DataObject::GlobalReleaseDataFlagOff ( )

inlinestatic

Definition at line 370 of file itkDataObject.h.

◆ GlobalReleaseDataFlagOn()

static void itk::DataObject::GlobalReleaseDataFlagOn ( )

inlinestatic

Definition at line 365 of file itkDataObject.h.

◆ Graft()

virtual void itk::DataObject::Graft ( const DataObject * )

inlinevirtual

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Definition at line 545 of file itkDataObject.h.

Referenced by itk::Statistics::Sample< ImageJointDomainTraits< TImage >::MeasurementVectorType >::Graft().

◆ Initialize()

virtual void itk::DataObject::Initialize ( )

virtual

Restore the data object to its initial state. This means releasing memory.

◆ itkGetGlobalDeclarationMacro()

itk::DataObject::itkGetGlobalDeclarationMacro	(	bool	,
		GlobalReleaseDataFlag
	)

private

Only used to synchronize the global variable across static libraries.

◆ New()

static Pointer itk::DataObject::New ( )

static

Method for creation through the object factory.

◆ PrepareForNewData()

virtual void itk::DataObject::PrepareForNewData ( )

inlinevirtual

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 465 of file itkDataObject.h.

◆ PrintSelf()

void itk::DataObject::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Who generated this data?

Reimplemented from itk::LightObject.

Referenced by itk::Statistics::Sample< ImageJointDomainTraits< TImage >::MeasurementVectorType >::PrintSelf().

◆ PropagateRequestedRegion()

virtual void itk::DataObject::PropagateRequestedRegion ( )

virtual

Methods to update the pipeline. Called internally by the pipeline mechanism.

◆ PropagateResetPipeline()

virtual void itk::DataObject::PropagateResetPipeline ( )

protectedvirtual

Propagate a call to ResetPipeline(). Called only from ProcessObject.

◆ ReleaseData()

void itk::DataObject::ReleaseData ( )

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.

◆ ReleaseDataFlagOff()

virtual void itk::DataObject::ReleaseDataFlagOff ( )

virtual

◆ ReleaseDataFlagOn()

virtual void itk::DataObject::ReleaseDataFlagOn ( )

virtual

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

virtual bool itk::DataObject::RequestedRegionIsOutsideOfTheBufferedRegion ( )

inlinevirtual

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::ImageBase< TLabelObject::ImageDimension >, itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >, itk::ImageBase< TImage::ImageDimension >, itk::SpatialObject< VDimension >, itk::SpatialObject< TDimension >, itk::SpatialObject< TMesh::PointDimension >, itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >, itk::LevelSetBase< TMesh::PointIdentifier, TMesh::PointDimension, TMesh::PixelType, TMesh >, itk::LevelSetBase< TInput, VDimension, TOutput, ImageBase< VDimension > >, itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >, itk::LevelSetBase< Index< VDimension >, VDimension, TImage::PixelType, ImageBase< VDimension > >, itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::PointSet< TPixel, VDimension, TTraits >, itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, and itk::TemporalDataObject.

Definition at line 494 of file itkDataObject.h.

◆ ResetPipeline()

virtual void itk::DataObject::ResetPipeline ( )

virtual

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.

◆ SetGlobalReleaseDataFlag()

static void itk::DataObject::SetGlobalReleaseDataFlag ( bool val )

static

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.

◆ SetPipelineMTime()

void itk::DataObject::SetPipelineMTime ( ModifiedTimeType time )

inline

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 436 of file itkDataObject.h.

◆ SetRealTimeStamp()

virtual void itk::DataObject::SetRealTimeStamp ( RealTimeStamp _arg )

virtual

RealTime stamp for the last time this DataObject was generated. By default, the real time stamp is initialized to the origin of the Unix epoch. That is the time 00:00:00 UTC on 1 January 1970 (or 1970-01-01T00:00:00Z ISO 8601)

◆ SetReleaseDataFlag()

void itk::DataObject::SetReleaseDataFlag ( bool flag )

inline

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 347 of file itkDataObject.h.

◆ SetRequestedRegion()

virtual void itk::DataObject::SetRequestedRegion ( const DataObject * )

inlinevirtual

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Definition at line 536 of file itkDataObject.h.

◆ SetRequestedRegionToLargestPossibleRegion()

virtual void itk::DataObject::SetRequestedRegionToLargestPossibleRegion ( )

inlinevirtual

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Definition at line 481 of file itkDataObject.h.

Referenced by itk::ExtractOrthogonalSwath2DImageFilter< TImage >::EnlargeOutputRequestedRegion().

◆ ShouldIReleaseData()

bool itk::DataObject::ShouldIReleaseData ( ) const

Return flag indicating whether data should be released after use by a filter.

◆ Update()

virtual void itk::DataObject::Update ( )

virtual

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

Examples: Examples/Segmentation/ThresholdSegmentationLevelSetImageFilter.cxx.

◆ UpdateOutputData()

virtual void itk::DataObject::UpdateOutputData ( )

virtual

◆ UpdateOutputInformation()

virtual void itk::DataObject::UpdateOutputInformation ( )

virtual

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Default implementation simply call's it's source's UpdateOutputInformation().

◆ VerifyRequestedRegion()

virtual bool itk::DataObject::VerifyRequestedRegion ( )

inlinevirtual

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).

Definition at line 512 of file itkDataObject.h.

Friends And Related Function Documentation

◆ DataObjectError

friend class DataObjectError

friend

Who generated this data?

Definition at line 606 of file itkDataObject.h.

◆ ProcessObject

friend class ProcessObject

friend

Friends of DataObject

Definition at line 605 of file itkDataObject.h.

Member Data Documentation

◆ m_DataReleased

bool itk::DataObject::m_DataReleased

private

Who generated this data?

Definition at line 573 of file itkDataObject.h.

◆ m_GlobalReleaseDataFlag

bool* itk::DataObject::m_GlobalReleaseDataFlag

staticprivate

Static member that controls global data release after use by filter.

Definition at line 580 of file itkDataObject.h.

◆ m_PipelineMTime

ModifiedTimeType itk::DataObject::m_PipelineMTime

private

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 577 of file itkDataObject.h.

◆ m_RealTimeStamp

RealTimeStamp itk::DataObject::m_RealTimeStamp

private

When, in real time, this data was generated.

Definition at line 570 of file itkDataObject.h.

◆ m_ReleaseDataFlag

bool itk::DataObject::m_ReleaseDataFlag

private

Who generated this data?

Definition at line 572 of file itkDataObject.h.

◆ m_Source

WeakPointer<ProcessObject> itk::DataObject::m_Source

private

Who generated this data?

Definition at line 560 of file itkDataObject.h.

◆ m_SourceOutputName

DataObjectIdentifierType itk::DataObject::m_SourceOutputName

private

Who generated this data?

Definition at line 561 of file itkDataObject.h.

◆ m_UpdateMTime

TimeStamp itk::DataObject::m_UpdateMTime

private

When was this data last generated? This time stamp is an integer number and it is intended to synchronize the activities of the pipeline. It doesn't relates to the clock time of acquiring or processing the data.

Definition at line 567 of file itkDataObject.h.

The documentation for this class was generated from the following file:

itkDataObject.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectIdentifierType

◆ DataObjectPointerArraySizeType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ DataObject()

◆ ~DataObject()

Member Function Documentation

◆ ConnectSource()

◆ CopyInformation()

◆ DataHasBeenGenerated()

◆ DisconnectPipeline()

◆ DisconnectSource()

◆ GetDataReleased()

◆ GetGlobalReleaseDataFlag()

◆ GetNameOfClass()

◆ GetPipelineMTime()

◆ GetRealTimeStamp()

◆ GetReleaseDataFlag()

◆ GetSource()

◆ GetSourceOutputIndex()

◆ GetSourceOutputName()

◆ GetUpdateMTime()

◆ GlobalReleaseDataFlagOff()

◆ GlobalReleaseDataFlagOn()

◆ Graft()

◆ Initialize()

◆ itkGetGlobalDeclarationMacro()

◆ New()

◆ PrepareForNewData()

◆ PrintSelf()

◆ PropagateRequestedRegion()

◆ PropagateResetPipeline()

◆ ReleaseData()

◆ ReleaseDataFlagOff()

◆ ReleaseDataFlagOn()

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

◆ ResetPipeline()

◆ SetGlobalReleaseDataFlag()

◆ SetPipelineMTime()

◆ SetRealTimeStamp()

◆ SetReleaseDataFlag()

◆ SetRequestedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

◆ ShouldIReleaseData()

◆ Update()

◆ UpdateOutputData()

◆ UpdateOutputInformation()

◆ VerifyRequestedRegion()

Friends And Related Function Documentation

◆ DataObjectError

◆ ProcessObject

Member Data Documentation

◆ m_DataReleased

◆ m_GlobalReleaseDataFlag

◆ m_PipelineMTime

◆ m_RealTimeStamp

◆ m_ReleaseDataFlag

◆ m_Source

◆ m_SourceOutputName

◆ m_UpdateMTime