 |
ITK
5.2.0
Insight Toolkit
|
|
ITK
5.2.0
Insight Toolkit
|
#include <itkPathSource.h>
Inheritance diagram for itk::PathSource< TOutputPath >: Collaboration diagram for itk::PathSource< TOutputPath >:Static Public Member Functions | |
| static Pointer | New () |
| 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 () |
| using | DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType |
| OutputPathType * | GetOutput () |
| OutputPathType * | GetOutput (unsigned int idx) |
| virtual void | GraftOutput (OutputPathType *graft) |
| virtual void | GraftNthOutput (unsigned int idx, OutputPathType *graft) |
| DataObjectPointer | MakeOutput (DataObjectPointerArraySizeType idx) override |
| PathSource () | |
| ~PathSource () override=default | |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
Base class for all process objects that output path data.
PathSource is the base class for all process objects that output path data. Specifically, this class defines the GetOutput() method that returns a pointer to the output path. The class also defines some internal private data members that are used to manage streaming of data.
Definition at line 42 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::ConstPointer = SmartPointer<const Self> |
Definition at line 51 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::DataObjectPointer = DataObject::Pointer |
Smart Pointer type to a DataObject.
Definition at line 54 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType |
Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().
Definition at line 177 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::OutputPathIndexType = typename OutputPathType::IndexType |
Definition at line 67 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::OutputPathInputType = typename OutputPathType::InputType |
Definition at line 65 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::OutputPathOffsetType = typename OutputPathType::OffsetType |
Definition at line 68 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::OutputPathOutputType = typename OutputPathType::OutputType |
Definition at line 66 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::OutputPathPointer = typename OutputPathType::Pointer |
Definition at line 64 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::OutputPathType = TOutputPath |
Some convenient type alias.
Definition at line 63 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::Pointer = SmartPointer<Self> |
Definition at line 50 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::Self = PathSource |
Standard class type aliases.
Definition at line 48 of file itkPathSource.h.
| using itk::PathSource< TOutputPath >::Superclass = ProcessObject |
Definition at line 49 of file itkPathSource.h.
|
protected |
Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().
|
overrideprotecteddefault |
Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
Reimplemented in itk::PathToPathFilter< TInputPath, TOutputPath >, itk::PathToPathFilter< TInputPath, TOutputChainCodePath >, itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, and itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ProcessObject.
Reimplemented in itk::ContourExtractor2DImageFilter< TInputImage >, itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >, itk::ChainCodeToFourierSeriesPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, itk::ImageToPathFilter< TInputImage, TOutputPath >, itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >, itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >, itk::PathToChainCodePathFilter< TInputPath, TOutputChainCodePath >, itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >, itk::PathToPathFilter< TInputPath, TOutputPath >, itk::PathToPathFilter< TInputPath, TOutputChainCodePath >, itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, and itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >.
| OutputPathType* itk::PathSource< TOutputPath >::GetOutput | ( | ) |
Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.
In this situation, someFilter and anotherFilter are said to constitute a pipeline.
(In the above example, the two lines of code can be in either order.)
Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.
For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.
| OutputPathType* itk::PathSource< TOutputPath >::GetOutput | ( | unsigned int | idx | ) |
Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().
|
virtual |
Graft the specified data object onto this ProcessObject's idx'th output. This is the similar to GraftOutput method except is allows you specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfIndexedOutputs()). See the GraftOutput for general usage information.
|
virtual |
Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's path data to use as its output's own path data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:
For proper pipeline execution, a filter using a mini-pipeline must implement the GeneratseInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).
|
overridevirtual |
Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().
Reimplemented from itk::ProcessObject.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().
Reimplemented from itk::ProcessObject.
Reimplemented in itk::PathToPathFilter< TInputPath, TOutputPath >, itk::PathToPathFilter< TInputPath, TOutputChainCodePath >, itk::PathToPathFilter< TInputChainCodePath, TOutputFourierSeriesPath >, and itk::PathToPathFilter< TFourierSeriesPath, OrthogonallyCorrected2DParametricPath >.
1.8.16
