itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel > Class Template Reference

The class takes a histogram as an input and gives the log probability image as the output. A pixel, at position I, in the output image is given by. More...

#include <itkHistogramToLogProbabilityImageFilter.h>

Inheritance diagram for itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >:

[legend]

Collaboration diagram for itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >:

[legend]

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef Function::HistogramLogProbabilityFunction < unsigned long, TOutputPixel >	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 HistogramToLogProbabilityImageFilter	Self
typedef HistogramType::SizeType	SizeType
typedef OutputImageType::SpacingType	SpacingType
typedef HistogramToImageFilter < THistogram, Function::HistogramLogProbabilityFunction < unsigned long, TOutputPixel > >	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
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual const PointType &	GetOrigin ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () 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
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
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
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)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
void	SetTotalFrequency (unsigned long n)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)


const FunctorType &	GetFunctor () const
FunctorType &	GetFunctor ()
const InputHistogramObjectType *	GetInput (void)
virtual void	SetInput (const InputHistogramObjectType *inputObject)
virtual void	SetInput (const HistogramType *histogram)
virtual void	SetOrigin (const double *values)
virtual void	SetOrigin (PointType _arg)
virtual void	SetSpacing (const double *values)
virtual void	SetSpacing (SpacingType _arg)


OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput (void)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension
static const unsigned int	OutputImageDimension
Protected Member Functions
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)
	HistogramToLogProbabilityImageFilter ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) ITK_NO_RETURN
virtual	~HistogramToLogProbabilityImageFilter ()
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
FunctorType	m_Functor
PointType	m_Origin
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
SizeType	m_Size
SpacingType	m_Spacing
bool	m_Updating

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)

DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual const int &	GetNumberOfThreads ()
DataObjectPointerArray &	GetOutputs ()
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
virtual void	SetNumberOfThreads (int _arg)
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual void	SetReleaseDataFlag (bool flag)
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
const DataObject *	GetInput (unsigned int idx) const
DataObject *	GetInput (unsigned int idx)
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
const DataObject *	GetOutput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
typedef int	InternalReferenceCountType

Detailed Description

template<class THistogram, class TOutputPixel = double>
class itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >

The class takes a histogram as an input and gives the log probability image as the output. A pixel, at position I, in the output image is given by.

$f(I) = \log_2( \frac{q_I}{\sum_{i \in I} q_I} )$

where $q_I$ is the frequency of measurement vector, I.

This is the log of the frequency of a measurement vector by the sum of all frequencies.

The output image is of type double.

This is useful in plotting the joint histograms during registration.

See also:: HistogramToImageFilter, HistogramToProbabilityImageFilter, HistogramToIntensityImageFilter, HistogramToEntropyImageFilter

Definition at line 94 of file itkHistogramToLogProbabilityImageFilter.h.

Member Typedef Documentation

template<class THistogram , class TOutputPixel = double>

typedef SmartPointer<const Self> itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >::ConstPointer

Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >.

Definition at line 109 of file itkHistogramToLogProbabilityImageFilter.h.

typedef DataObject::Pointer itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 62 of file itkImageSource.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

typedef Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::FunctorType [inherited]

Standard class typedefs.

Definition at line 58 of file itkHistogramToImageFilter.h.

typedef HistogramType::SizeType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::HistogramSizeType [inherited]

Definition at line 92 of file itkHistogramToImageFilter.h.

typedef THistogram itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::HistogramType [inherited]

Some convenient typedefs.

Definition at line 90 of file itkHistogramToImageFilter.h.

typedef itk::ImageRegionIteratorWithIndex< Image<OutputPixelType, ::itk::Statistics::GetHistogramDimension<THistogram >::HistogramDimension> > itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::ImageIteratorType [inherited]

Definition at line 78 of file itkHistogramToImageFilter.h.

typedef SimpleDataObjectDecorator< HistogramType* > itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::InputHistogramObjectType [inherited]

Since histograms are not dataobjects, we use the decorator to push them down the pipeline

Definition at line 97 of file itkHistogramToImageFilter.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef HistogramType::MeasurementVectorType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::MeasurementVectorType [inherited]

Definition at line 91 of file itkHistogramToImageFilter.h.

typedef OutputImageType::PixelType itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::OutputImagePixelType [inherited]

Definition at line 71 of file itkImageSource.h.

typedef Superclass::Pointer itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::OutputImagePointer [inherited]

Reimplemented from itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >.

Definition at line 70 of file itkHistogramToImageFilter.h.

typedef Superclass::OutputImageRegionType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::OutputImageRegionType [inherited]

Superclass typedefs.

Reimplemented from itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >.

Definition at line 84 of file itkHistogramToImageFilter.h.

typedef Image<OutputPixelType, ::itk::Statistics::GetHistogramDimension<THistogram >::HistogramDimension > itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::OutputImageType [inherited]

Some convenient typedefs.

Reimplemented from itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >.

Definition at line 69 of file itkHistogramToImageFilter.h.

typedef FunctorType::OutputPixelType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::OutputPixelType [inherited]

Definition at line 59 of file itkHistogramToImageFilter.h.

template<class THistogram , class TOutputPixel = double>

typedef SmartPointer<Self> itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >::Pointer

Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >.

Definition at line 108 of file itkHistogramToLogProbabilityImageFilter.h.

typedef OutputImageType::PointType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::PointType [inherited]

Definition at line 72 of file itkHistogramToImageFilter.h.

template<class THistogram , class TOutputPixel = double>

typedef HistogramToLogProbabilityImageFilter itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >::Self

Standard class typedefs.

Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >.

Definition at line 101 of file itkHistogramToLogProbabilityImageFilter.h.

typedef HistogramType::SizeType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SizeType [inherited]

Definition at line 93 of file itkHistogramToImageFilter.h.

typedef OutputImageType::SpacingType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SpacingType [inherited]

Definition at line 71 of file itkHistogramToImageFilter.h.

template<class THistogram , class TOutputPixel = double>

typedef HistogramToImageFilter< THistogram, Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > > itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >::Superclass

Standard "Superclass" typedef.

Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >.

Definition at line 106 of file itkHistogramToLogProbabilityImageFilter.h.

Constructor & Destructor Documentation

template<class THistogram , class TOutputPixel = double>

itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >::HistogramToLogProbabilityImageFilter ( ) [inline, protected]

Definition at line 118 of file itkHistogramToLogProbabilityImageFilter.h.

template<class THistogram , class TOutputPixel = double>

virtual itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >::~HistogramToLogProbabilityImageFilter ( ) [inline, protected, virtual]

Definition at line 119 of file itkHistogramToLogProbabilityImageFilter.h.

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

virtual void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

This is a global flag that controls whether any debug, warning or error messages are displayed.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

virtual void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual void itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::AfterThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

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 265 of file itkImageSource.h.

virtual void itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::AllocateOutputs ( ) [protected, virtual, inherited]

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.

virtual void itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::BeforeThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

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 253 of file itkImageSource.h.

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

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

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

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.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 225 of file itkProcessObject.h.

virtual void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::GenerateData ( void ) [protected, virtual, inherited]

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.

See also:: ThreadedGenerateData()

Reimplemented from itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >.

virtual void itk::ProcessObject::GenerateInputRequestedRegion ( ) [protected, virtual, inherited]

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

virtual void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::GenerateOutputInformation ( ) [protected, virtual, inherited]

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.

virtual void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output ) [protected, virtual, inherited]

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)>, itk::watershed::Segmenter< InputImageType >, and itk::watershed::SegmentTreeGenerator< ScalarType >.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

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.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

const FunctorType& itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::GetFunctor ( ) const [inline, inherited]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 151 of file itkHistogramToImageFilter.h.

FunctorType& itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::GetFunctor ( ) [inline, inherited]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 150 of file itkHistogramToImageFilter.h.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

const DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) const [protected, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Reimplemented in itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) [protected, inherited]

Method used internally for getting an input.

const InputHistogramObjectType* itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::GetInput ( void ) [inherited]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

DataObjectPointerArray& itk::ProcessObject::GetInputs ( ) [inline, inherited]

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.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) [inline, inherited]

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.h.

template<class THistogram , class TOutputPixel = double>

virtual const char* itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const [inline, inherited]

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 118 of file itkProcessObject.h.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 135 of file itkProcessObject.h.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().

virtual DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

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, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

virtual const PointType& itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::GetOrigin ( void ) [virtual, inherited]

Get the origin of the image.

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

OutputImageType* itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::GetOutput ( unsigned int idx ) [inherited]

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.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();

   someFilter->Update();
   image = someFilter->GetOutput();

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

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

Reimplemented from itk::ProcessObject.

OutputImageType* itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::GetOutput ( void ) [inherited]

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.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();

   someFilter->Update();
   image = someFilter->GetOutput();

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

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

virtual const float& itk::ProcessObject::GetProgress ( ) [virtual, inherited]

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.

Referenced by itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual bool itk::ProcessObject::GetReleaseDataFlag ( ) const [virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual HistogramSizeType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::GetSize ( void ) [virtual, inherited]

Get the size of the histogram.

virtual const SpacingType& itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::GetSpacing ( void ) [virtual, inherited]

Get the spacing (size of a pixel) of the image. For ImageBase and Image, the default data spacing is unity.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)			`[virtual, inherited]`

Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to 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.

virtual void itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::GraftOutput ( DataObject * output ) [virtual, inherited]

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

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual DataObjectPointer itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::MakeOutput ( unsigned int idx ) [virtual, inherited]

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.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class THistogram , class TOutputPixel = double>

static Pointer itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::HistogramToImageFilter< THistogram, Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >.

virtual void itk::ProcessObject::PopBackInput ( ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual void itk::ProcessObject::PopFrontInput ( ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual void itk::ProcessObject::PrepareOutputs ( ) [virtual, inherited]

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

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Define the type of the reference count according to the target. This allows the use of atomic operations

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

virtual void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Define the type of the reference count according to the target. This allows the use of atomic operations

virtual void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output ) [virtual, inherited]

Send the requested region information back up the pipeline (to the filters that preceed this one).

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >, and itk::VTKImageImport< TOutputImage >.

virtual void itk::ProcessObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

virtual void itk::ProcessObject::PushBackInput ( const DataObject * input ) [protected, virtual, inherited]

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, especially filters with different types of inputs. These routines follow the semantics of STL.

virtual void itk::ProcessObject::PushFrontInput ( const DataObject * input ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( ) [virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( ) [virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

void itk::ProcessObject::ReleaseDataFlagOff ( ) [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 257 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( ) [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 256 of file itkProcessObject.h.

virtual void itk::ProcessObject::ReleaseInputs ( ) [protected, virtual, inherited]

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See also:: InPlaceImageFilter::ReleaseInputs()

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

virtual void itk::ProcessObject::RemoveInput ( DataObject * input ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::ProcessObject::RemoveOutput ( DataObject * output ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual void itk::ProcessObject::ResetPipeline ( ) [virtual, inherited]

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.

virtual void itk::ProcessObject::RestoreInputReleaseDataFlags ( ) [protected, virtual, inherited]

Restore the cached input ReleaseDataFlags.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SetFunctor ( const FunctorType & functor ) [inline, inherited]

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.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SetInput ( const InputHistogramObjectType * inputObject ) [virtual, inherited]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

virtual void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SetInput ( const HistogramType * histogram ) [virtual, inherited]

Set/Get the input of this process object.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::ProcessObject::SetNthInput	(	unsigned int	num,
		DataObject *	input
	)			`[protected, virtual, inherited]`

Protected methods for setting inputs. Subclasses make use of them for setting input.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

virtual void itk::ProcessObject::SetNthOutput	(	unsigned int	num,
		DataObject *	output
	)			`[protected, virtual, inherited]`

Protected methods for setting outputs. Subclasses make use of them for getting output.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< InputImageType >::SetSegmentTable().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num ) [protected, inherited]

Called to allocate the input array. Copies old inputs.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num ) [protected, inherited]

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

Get/Set the number of threads to create when executing.

virtual void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SetOrigin ( const double * values ) [virtual, inherited]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

virtual void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SetOrigin ( PointType _arg ) [virtual, inherited]

Set the origin of the image.

See also:: GetOrigin()

virtual void itk::ProcessObject::SetProgress ( float _arg ) [virtual, inherited]

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.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

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 itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SetSpacing ( const double * values ) [virtual, inherited]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

virtual void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SetSpacing ( SpacingType _arg ) [virtual, inherited]

Set the spacing (size of a pixel) of the image.

See also:: GetSpacing()

void itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::SetTotalFrequency ( unsigned long n ) [inherited]

virtual int itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::SplitRequestedRegion	(	int	i,
		int	num,
		OutputImageRegionType &	splitRegion
	)			`[protected, virtual, inherited]`

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

virtual void itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		int	threadId
	)			`[protected, virtual, inherited]`

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

See also:: GenerateData(), SplitRequestedRegion()

static ITK_THREAD_RETURN_TYPE itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::ThreaderCallback ( void * arg ) [static, protected, inherited]

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

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::Update ( ) [virtual, inherited]

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 in itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, and itk::ImageSeriesWriter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateLargestPossibleRegion ( ) [virtual, inherited]

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

virtual void itk::ProcessObject::UpdateOutputData ( DataObject * output ) [virtual, inherited]

Actually generate new output

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateOutputInformation ( ) [virtual, inherited]

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 >, itk::VTKImageImport< TOutputImage >, and itk::watershed::Segmenter< InputImageType >.

void itk::ProcessObject::UpdateProgress ( float amount ) [inherited]

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.

Member Data Documentation

const unsigned int itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::ImageDimension [static, inherited]

Determine the image dimension.

Definition at line 101 of file itkHistogramToImageFilter.h.

FunctorType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::m_Functor [protected, inherited]

Definition at line 165 of file itkHistogramToImageFilter.h.

PointType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::m_Origin [protected, inherited]

Definition at line 169 of file itkHistogramToImageFilter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

SizeType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::m_Size [protected, inherited]

Definition at line 167 of file itkHistogramToImageFilter.h.

SpacingType itk::HistogramToImageFilter< THistogram , Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel > >::m_Spacing [protected, inherited]

Definition at line 168 of file itkHistogramToImageFilter.h.

bool itk::ProcessObject::m_Updating [protected, inherited]

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 428 of file itkProcessObject.h.

const unsigned int itk::ImageSource< Image< Function::HistogramLogProbabilityFunction< unsigned long, TOutputPixel >::OutputPixelType,::itk::Statistics::GetHistogramDimension< THistogram >::HistogramDimension > >::OutputImageDimension [static, inherited]

ImageDimension constant

Definition at line 75 of file itkImageSource.h.

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

itkHistogramToLogProbabilityImageFilter.h

itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

template<class THistogram, class TOutputPixel = double> class itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class THistogram, class TOutputPixel = double>
class itk::HistogramToLogProbabilityImageFilter< THistogram, TOutputPixel >