ITK
6.0.0
Insight Toolkit
|
#include <itkTemporalDataObject.h>
DataObject subclass with knowledge of temporal region.
This class represents a data object that relies on temporal regions. It uses an itk::RingBuffer to store DataObject pointers in sequential order. The pointers in the ring buffer should correspond to the BufferedTemporalRegion. The LargestPossibleTemporalRegion should indicate the maximum extent that data object is logically capable of holding, and the RequestedTemporalRegion is used in the pipeline to request that a certain temporal region be buffered
Definition at line 65 of file itkTemporalDataObject.h.
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::DataObject | |
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 () |
Protected Member Functions | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
TemporalDataObject () | |
~TemporalDataObject () override | |
Protected Member Functions inherited from itk::DataObject | |
DataObject () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | PropagateResetPipeline () |
~DataObject () override | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Protected Attributes | |
TemporalRegionType | m_BufferedTemporalRegion {} |
BufferType::Pointer | m_DataObjectBuffer {} |
TemporalRegionType | m_LargestPossibleTemporalRegion {} |
TemporalRegionType | m_RequestedTemporalRegion {} |
TemporalUnitEnum | m_TemporalUnit { TemporalUnitEnum::Frame } |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
Definition at line 77 of file itkTemporalDataObject.h.
using itk::TemporalDataObject::ConstPointer = SmartPointer<const Self> |
Definition at line 74 of file itkTemporalDataObject.h.
using itk::TemporalDataObject::ConstWeakPointer = WeakPointer<const Self> |
Definition at line 75 of file itkTemporalDataObject.h.
Definition at line 73 of file itkTemporalDataObject.h.
Standard class type aliases
Definition at line 71 of file itkTemporalDataObject.h.
Definition at line 72 of file itkTemporalDataObject.h.
Definition at line 78 of file itkTemporalDataObject.h.
Definition at line 80 of file itkTemporalDataObject.h.
Definition at line 81 of file itkTemporalDataObject.h.
|
protected |
|
overrideprotected |
|
overridevirtual |
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.
Reimplemented from itk::DataObject.
|
virtual |
|
virtual |
|
overridevirtual |
Reimplemented from itk::DataObject.
Reimplemented in itk::VideoStream< TFrameType >.
SizeValueType itk::TemporalDataObject::GetNumberOfBuffers | ( | ) |
Get/Set the number of frames that the internal buffer can hold
|
virtual |
|
virtual |
Get the type of temporal units we care about (Defaults to Frame)
|
virtual |
Get the portion of the requested region that is not covered by the buffered region
|
overridevirtual |
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.
Reimplemented from itk::DataObject.
Reimplemented in itk::VideoStream< TFrameType >.
|
static |
|
overrideprotectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::DataObject.
Reimplemented in itk::VideoStream< TFrameType >.
|
overridevirtual |
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 from itk::DataObject.
|
virtual |
|
virtual |
void itk::TemporalDataObject::SetNumberOfBuffers | ( | SizeValueType | num | ) |
Get/Set the number of frames that the internal buffer can hold
|
overridevirtual |
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.
Reimplemented from itk::DataObject.
|
overridevirtual |
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().
Reimplemented from itk::DataObject.
|
virtual |
|
virtual |
Explicitly set temporal units (Defaults to Frame)
|
virtual |
Explicitly set temporal units (Defaults to Frame)
|
virtual |
Explicitly set temporal units (Defaults to Frame)
|
overridevirtual |
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).
Reimplemented from itk::DataObject.
|
protected |
Definition at line 164 of file itkTemporalDataObject.h.
|
protected |
Buffer for holding component data objects
Definition at line 159 of file itkTemporalDataObject.h.
|
protected |
We want to keep track of our regions in time.
Definition at line 162 of file itkTemporalDataObject.h.
|
protected |
Definition at line 163 of file itkTemporalDataObject.h.
|
protected |
Definition at line 166 of file itkTemporalDataObject.h.