#include <itkHistogramToEntropyImageFilter.h>
Inheritance diagram for itk::HistogramToEntropyImageFilter< THistogram >:
![\[ f(I) = -p \log_2 p \]](form_230.png)
where
![\[ p = \frac{q_I}{\sum_{i \in I} q_I} \]](form_231.png)
where 
is the frequency of measurement vector, I.
is the frequency of a measurement vector by the sum of all frequencies = Probability of the the measurement vector
The output image is of type double.
This is useful in plotting the joint histograms during registration.
Definition at line 101 of file itkHistogramToEntropyImageFilter.h.
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef DataObject::Pointer | DataObjectPointer |
| typedef std::vector< DataObjectPointer > | DataObjectPointerArray |
| typedef Function::HistogramEntropyFunction< unsigned long > | FunctorType |
| typedef HistogramType::SizeType | HistogramSizeType |
| typedef THistogram | HistogramType |
| typedef itk::ImageRegionIteratorWithIndex< Image< OutputPixelType, ::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > > | ImageIteratorType |
| typedef SimpleDataObjectDecorator< HistogramType * > | InputHistogramObjectType |
| typedef HistogramType::MeasurementVectorType | MeasurementVectorType |
| typedef OutputImageType::PixelType | OutputImagePixelType |
| typedef Superclass::Pointer | OutputImagePointer |
| typedef Superclass::OutputImageRegionType | OutputImageRegionType |
| typedef Image< OutputPixelType, ::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > | OutputImageType |
| typedef FunctorType::OutputPixelType | OutputPixelType |
| typedef SmartPointer< Self > | Pointer |
| typedef OutputImageType::PointType | PointType |
| typedef HistogramToEntropyImageFilter | Self |
| typedef HistogramType::SizeType | SizeType |
| typedef OutputImageType::SpacingType | SpacingType |
| typedef ImageSource< Image< OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > > | Superclass |
Public Member Functions | |
| virtual void | AbortGenerateDataOff () |
| virtual void | AbortGenerateDataOn () |
| virtual LightObject::Pointer | CreateAnother () const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| virtual void | Delete () |
| virtual void | EnlargeOutputRequestedRegion (DataObject *) |
| virtual const bool & | GetAbortGenerateData () |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| const FunctorType & | GetFunctor () const |
| Get the functor object The functor is returned by reference *Functors do not have to derive from so they do *not necessarily have a reference count So we cannot return a *SmartPointer *FunctorType & | GetFunctor () |
| const InputHistogramObjectType * | GetInput (void) |
| DataObjectPointerArray & | GetInputs () |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual unsigned long | GetMTime () const |
| MultiThreader * | GetMultiThreader () |
| virtual const char * | GetNameOfClass () const |
| std::vector< DataObjectPointer >::size_type | GetNumberOfInputs () const |
| std::vector< DataObjectPointer >::size_type | GetNumberOfOutputs () const |
| virtual const int & | GetNumberOfThreads () |
| virtual std::vector< DataObjectPointer >::size_type | GetNumberOfValidRequiredInputs () const |
| virtual const PointType & | GetOrigin () |
| Set the origin of the image *sa | GetOrigin ()*/virtual void SetOrigin(PointType _arg) |
| OutputImageType * | GetOutput (unsigned int idx) |
| Get the output data of this process object The output of this *function is not valid until an appropriate either explicitly or implicitly Both the filter *itself and the data object have and both *methods update the data Here are three ways to use * | GetOutput () and make sure the data is valid.In these *examples |
| Return an array with all the outputs of this process object *This is useful for tracing forward in the pipeline to contruct *graphs etc *DataObjectPointerArray & | GetOutputs () |
| virtual const float & | GetProgress () |
| virtual int | GetReferenceCount () const |
| virtual const bool & | GetReleaseDataBeforeUpdateFlag () |
| virtual bool | GetReleaseDataFlag () const |
| virtual HistogramSizeType | GetSize () |
| virtual const SpacingType & | GetSpacing () |
| virtual void | GraftNthOutput (unsigned int idx, DataObject *output) |
| virtual void | GraftOutput (DataObject *output) |
| bool | HasObserver (const EventObject &event) const |
| Get the output data of this process object The output of this *function is not valid until an appropriate either explicitly or implicitly Both the filter *itself and the data object have and both *methods update the data Here are three ways to use *a image is a pointer to some Image and the *particular ProcessObjects involved are filters The same *examples apply to non | image (e.g.Mesh) data as well.**\code *anotherFilter->SetInput(someFilter->GetOutput()) |
| void | InvokeEvent (const EventObject &) const |
| void | InvokeEvent (const EventObject &) |
| itkStaticConstMacro (ImageDimension, unsigned int,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension) | |
| virtual DataObjectPointer | MakeOutput (unsigned int idx) |
| virtual void | Modified () const |
| virtual void | PrepareOutputs () |
| void | Print (std::ostream &os, Indent indent=0) const |
| virtual void | PropagateRequestedRegion (DataObject *output) |
| virtual void | Register () const |
| virtual void | ReleaseDataBeforeUpdateFlagOff () |
| virtual void | ReleaseDataBeforeUpdateFlagOn () |
| void | ReleaseDataFlagOff () |
| void | ReleaseDataFlagOn () |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| virtual void | ResetPipeline () |
| virtual void | SetAbortGenerateData (bool _arg) |
| void | SetDebug (bool debugFlag) const |
| void | SetFunctor (const FunctorType &functor) |
| virtual void | SetInput (const InputHistogramObjectType *inputObject) |
| Set Get the input of this process object *virtual void | SetInput (const HistogramType *histogram) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| Get Set the number of threads to create when executing *virtual void | SetNumberOfThreads (int _arg) |
| virtual void | SetOrigin (const double *values) |
| virtual void | SetProgress (float _arg) |
| virtual void | SetReferenceCount (int) |
| Turn on off the flags to control whether the bulk data belonging *to the outputs of this ProcessObject are released after being *used by a downstream ProcessObject Default value is off Another *options for controlling memory utilization is the *ReleaseDataBeforeUpdateFlag *virtual void | SetReleaseDataFlag (bool flag) |
| virtual void | SetSpacing (const double *values) |
| void | SetTotalFrequency (unsigned long n) |
| Set the | spacing (size of a pixel) of the image.*\sa GetSpacing()*/virtual void SetSpacing(SpacingType _arg) |
| virtual void | UnRegister () const |
| *endcode *In the above the two lines of code can be in *either order **Note that it may be more efficient to *use a pipeline than to call | Update () once for each filter in *turn.**For an image |
| *endcode *In the above 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\b streaming(using a *StreamingImageFilter) is activated |
| *endcode **code *someFilter | Update () |
| *image | Update () |
| *anotherFilter | Update () |
| Get the output data of this process object The output of this *function is not valid until an appropriate either explicitly or implicitly Both the filter *itself and the data object have | Update () methods |
| Get the output data of this process object The output of this *function is not valid until an appropriate | Update () method has *been called |
| virtual void | UpdateLargestPossibleRegion () |
| virtual void | UpdateOutputData (DataObject *output) |
| virtual void | UpdateOutputInformation () |
| void | UpdateProgress (float amount) |
Static Public Member Functions | |
| static void | BreakOnError () |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| static Pointer | New () |
| This is a global flag that controls whether any warning *or error messages are displayed *static void | SetGlobalWarningDisplay (bool flag) |
Public Attributes | |
| Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon | AddObserver )(const EventObject &event, Command *) const |
| This is a global flag that controls whether any | debug |
| *endcode *In the above | example |
| * | image |
| *endcode **In this a someFilter and a anotherFilter are said *to constitute a b pipeline **code * | image |
| Get the output data of this process object The output of this *function is not valid until an appropriate either explicitly or implicitly Both the filter *itself and the data object have and both *methods update the data Here are three ways to use *a image is a pointer to some Image | object |
| *endcode *In the above the two lines of code can be in *either order **Note that it may be more efficient to *use a pipeline than to call the data generated is for the requested * | Region |
| *endcode **In this | situation |
Protected Member Functions | |
| virtual void | AddInput (DataObject *input) |
| virtual void | AddOutput (DataObject *output) |
| virtual void | AfterThreadedGenerateData () |
| virtual void | AllocateOutputs () |
| virtual void | BeforeThreadedGenerateData () |
| virtual void | CacheInputReleaseDataFlags () |
| virtual void | GenerateData () |
| virtual void | GenerateInputRequestedRegion () |
| virtual void | GenerateOutputInformation () |
| virtual void | GenerateOutputRequestedRegion (DataObject *output) |
| const DataObject * | GetInput (unsigned int idx) const |
| Method used internally for getting an input *DataObject * | GetInput (unsigned int idx) |
| virtual const unsigned int & | GetNumberOfRequiredInputs () |
| virtual const unsigned int & | GetNumberOfRequiredOutputs () |
| const DataObject * | GetOutput (unsigned int idx) const |
| HistogramToEntropyImageFilter () | |
| HistogramToImageFilter () | |
| ImageSource () | |
| virtual void | PopBackInput () |
| virtual void | PopFrontInput () |
| bool | PrintObservers (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 void | PropagateResetPipeline () |
| Push Pop an input of this process object These methods allow a *filter to model its input vector as a queue or stack These *routines may not be appropriate for all especially *filters with different types of inputs These routines follow *the semantics of STL *virtual void | PushBackInput (const DataObject *input) |
| virtual void | PushFrontInput (const DataObject *input) |
| virtual void | ReleaseInputs () |
| virtual void | RemoveInput (DataObject *input) |
| virtual void | RemoveOutput (DataObject *output) |
| virtual void | RestoreInputReleaseDataFlags () |
| Protected methods for setting inputs *Subclasses make use of them for setting input *virtual void | SetNthInput (unsigned int num, DataObject *input) |
| Protected methods for setting outputs *Subclasses make use of them for getting output *virtual void | SetNthOutput (unsigned int num, DataObject *output) |
| void | SetNumberOfInputs (unsigned int num) |
| void | SetNumberOfOutputs (unsigned int num) |
| virtual void | SetNumberOfRequiredInputs (unsigned int _arg) |
| virtual void | SetNumberOfRequiredOutputs (unsigned int _arg) |
| virtual int | SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion) |
| virtual void | ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) |
| virtual | ~HistogramToEntropyImageFilter () |
Static Protected Member Functions | |
| static ITK_THREAD_RETURN_TYPE | ThreaderCallback (void *arg) |
Protected Attributes | |
| Push Pop an input of this process object These methods allow a *filter to model its input vector as a queue or stack These *routines may not be appropriate for all | filters |
| FunctorType | m_Functor |
| PointType | m_Origin |
| TimeStamp | m_OutputInformationMTime |
| int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| SizeType | m_Size |
| SpacingType | m_Spacing |
| bool | m_Updating |
| Methods invoked by virtual 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.*/virtual void PrintSelf(std voi | PrintHeader )(std::ostream &os, Indent indent) const |
|
|||||
|
Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramEntropyFunction< unsigned long > >. Definition at line 110 of file itkHistogramToEntropyImageFilter.h. |
|
|
Smart Pointer type to a DataObject. Reimplemented from itk::ProcessObject. Definition at line 62 of file itkImageSource.h. |
|
|
STL Array of SmartPointers to DataObjects Definition at line 103 of file itkProcessObject.h. |
|
|
Standard class typedefs. Definition at line 58 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 92 of file itkHistogramToImageFilter.h. |
|
|
Some convenient typedefs. Definition at line 90 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 78 of file itkHistogramToImageFilter.h. |
|
|
Since histograms are not dataobjects, we use the decorator to push them down the pipeline Definition at line 97 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 91 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 71 of file itkImageSource.h. |
|
|
|
Superclass typedefs. Reimplemented from itk::ImageSource< Image< Function::HistogramEntropyFunction< unsigned long >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >. Definition at line 84 of file itkHistogramToImageFilter.h. |
|
|
Some convenient typedefs. Reimplemented from itk::ImageSource< Image< Function::HistogramEntropyFunction< unsigned long >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >. Definition at line 69 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 59 of file itkHistogramToImageFilter.h. |
|
|||||
|
Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramEntropyFunction< unsigned long > >. Definition at line 109 of file itkHistogramToEntropyImageFilter.h. |
|
|
Definition at line 72 of file itkHistogramToImageFilter.h. |
|
|||||
|
Standard class typedefs. Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramEntropyFunction< unsigned long > >. Definition at line 108 of file itkHistogramToEntropyImageFilter.h. |
|
|
Definition at line 93 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 71 of file itkHistogramToImageFilter.h. |
|
|
|||||||||
|
Definition at line 116 of file itkHistogramToEntropyImageFilter.h. |
|
|||||||||
|
Definition at line 117 of file itkHistogramToEntropyImageFilter.h. |
|
|
|
|
|
Turn on and off the AbortGenerateData flag. |
|
|
|
|
|
|
|
|
If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method. Definition at line 254 of file itkImageSource.h. |
|
|
The GenerateData method normally allocates the buffers for all of the outputs of a filter. Some filters may want to override this default behavior. For example, a filter may have multiple outputs with varying resolution. Or a filter may want to process data in place by grafting its input to its output. |
|
|
If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method. Definition at line 242 of file itkImageSource.h. |
|
|
This method is called when itkExceptionMacro executes. It allows the debugger to break on error. |
|
|
Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs(). |
|
|
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::LightObject. |
|
|
Turn debugging output off. |
|
|
Turn debugging output on. |
|
|
Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting. |
|
|
|
A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.
Reimplemented from itk::ImageSource< Image< Function::HistogramEntropyFunction< unsigned long >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >. |
|
|
|
Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information. Reimplemented from itk::ProcessObject. Definition at line 162 of file itkHistogramToImageFilter.h. |
|
|
Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly. Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type. Reimplemented in itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, and itk::watershed::SegmentTreeGenerator< ScalarType >. |
|
|
Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways. |
|
|
Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used. |
|
|
Get the value of the debug flag. |
|
|
Definition at line 151 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 150 of file itkHistogramToImageFilter.h. |
|
|
|
|
|
|
|
|
|
|
|
|
Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc. Definition at line 108 of file itkProcessObject.h. |
|
|
|
|
|
|
|
|
|
Return the multithreader used by this class. Definition at line 281 of file itkProcessObject.h. |
|
|
Run-time type information (and related methods). Reimplemented from itk::ImageSource< Image< Function::HistogramEntropyFunction< unsigned long >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >. |
|
|
Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null. Definition at line 115 of file itkProcessObject.h. |
|
|
Definition at line 132 of file itkProcessObject.h. |
|
|
|
|
|
|
|
|
|
|
|
Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector. Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. |
|
|
Get the origin of the image. |
|
|
|
|
|
|
|
|
Reimplemented from itk::ProcessObject. |
|
|
|
|
|
Definition at line 130 of file itkProcessObject.h. |
|
|
Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. |
|
|
Gets the reference count on this object. Definition at line 98 of file itkLightObject.h. |
|
|
|
|
|
|
|
|
Get the size of the histogram. |
|
|
Get the spacing (size of a pixel) of the image. For ImageBase and Image, the default data spacing is unity. |
|
|
Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
||||||||||||
|
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::GetNumberOfOutputs()). See the GraftOutput for general usage information. |
|
|
Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk 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:
// setup the mini-pipeline to process the input to this filter firstFilterInMiniPipeline->SetInput( this->GetInput() ); // setup the mini-pipeline to calculate the correct regions // and write to the appropriate bulk data block lastFilterInMiniPipeline->GraftOutput( this->GetOutput() ); // execute the mini-pipeline lastFilterInMiniPipeline->Update(); // graft the mini-pipeline output back onto this filter's output. // this is needed to get the appropriate regions passed back. this->GraftOutput( lastFilterInMiniPipeline->GetOutput() ); For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), 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). |
|
|
Return true if an observer is registered for this event. |
|
|
|
|
|
|
|
|
|
|
|
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object. |
|
|
Call Execute on all the Commands observing this event id. |
|
||||||||||||||||
|
Determine the image dimension. |
|
|
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. |
|
|
|||||||||
|
Method for creation through the object factory. Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramEntropyFunction< unsigned long > >. |
|
|
|
|
An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default. Reimplemented in itk::WatershedImageFilter< TInputImage >. |
|
||||||||||||
|
Cause the object to print itself out. |
|
||||||||||||
|
|
|
||||||||||||
|
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::ProcessObject. |
|
||||||||||||
|
|
|
|
Send the requested region information back up the pipeline (to the filters that preceed this one). Reimplemented in itk::VTKImageImport< TOutputImage >. |
|
|
Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject. |
|
|
|
|
Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject. |
|
|
|
|
|
|
|
|
Definition at line 254 of file itkProcessObject.h. |
|
|
Definition at line 253 of file itkProcessObject.h. |
|
|
|
Remove all observers . |
|
|
|
|
|
Remove the observer with this tag value. |
|
|
|
|
|
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. |
|
|
Restore the cached input ReleaseDataFlags. |
|
|
Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways. |
|
|
Set the value of the debug flag. A non-zero value turns debugging on. |
|
|
Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator!=() be defined on the functor (or the compiler's default implementation of operator!=() being appropriate). Definition at line 140 of file itkHistogramToImageFilter.h. |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
|
|
|
|
|
|
|
|
|
||||||||||||
|
||||||||||||
|
|
Called to allocate the input array. Copies old inputs. |
|
|
Called to allocate the output array. Copies old outputs. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked. |
|
|
Sets the reference count (use with care) Reimplemented from itk::LightObject. |
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||||||
|
Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num". |
|
||||||||||||
|
If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).
|
|
|
Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData(). |
|
|
Decrease the reference count (release by another object). Reimplemented from itk::LightObject. |
|
|
Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead. Reimplemented from itk::ProcessObject. |
|
|
Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead. Reimplemented from itk::ProcessObject. |
|
|
Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead. Reimplemented from itk::ProcessObject. |
|
|
Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead. Reimplemented from itk::ProcessObject. |
|
|
Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead. Reimplemented from itk::ProcessObject. |
|
|
Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead. Reimplemented from itk::ProcessObject. |
|
|
Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead. Reimplemented from itk::ProcessObject. |
|
|
Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update(). |
|
|
Actually generate new output Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >. |
|
|
Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information. Reimplemented in itk::watershed::Segmenter< TInputImage >, and itk::VTKImageImport< TOutputImage >. |
|
|
Update the progress of the process object. Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress. |
|
|
|
|
|
Definition at line 94 of file itkObject.h. |
|
|
Definition at line 100 of file itkImageSource.h. |
|
|
|
Definition at line 98 of file itkImageSource.h. |
|
|
Definition at line 92 of file itkImageSource.h. |
|
|
Definition at line 165 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 169 of file itkHistogramToImageFilter.h. |
|
|
Time when GenerateOutputInformation was last called. Definition at line 428 of file itkProcessObject.h. |
|
|
Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h. |
|
|
Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h. |
|
|
Definition at line 167 of file itkHistogramToImageFilter.h. |
|
|
Definition at line 168 of file itkHistogramToImageFilter.h. |
|
|
This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops. Definition at line 425 of file itkProcessObject.h. |
|
|
Definition at line 79 of file itkImageSource.h. |
|
|
|
|
|
Definition at line 110 of file itkImageSource.h. |
|
|
Definition at line 88 of file itkImageSource.h. |
1.4.2 written by Dimitri van Heesch,
© 1997-2000