itk::Statistics::ImageToHistogramFilter< TImageType > Class Template Reference

This class generates an histogram from an image. More...

#include <itkImageToHistogramFilter.h>

Inheritance diagram for itk::Statistics::ImageToHistogramFilter< TImageType >:

[legend]

Collaboration diagram for itk::Statistics::ImageToHistogramFilter< TImageType >:

[legend]

List of all members.

Public Types
typedef AdaptorType::Pointer	AdaptorPointer
typedef ImageToListSampleAdaptor < ImageType >	AdaptorType
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef DenseFrequencyContainer2	FrequencyContainerType
typedef GeneratorType::Pointer	GeneratorPointer
typedef SampleToHistogramFilter < AdaptorType, HistogramType >	GeneratorType
typedef HistogramType::ConstPointer	HistogramConstPointer
typedef HistogramType::MeasurementType	HistogramMeasurementType
typedef HistogramType::MeasurementVectorType	HistogramMeasurementVectorType
typedef HistogramType::Pointer	HistogramPointer
typedef HistogramType::SizeType	HistogramSizeType
typedef Histogram< ValueRealType >	HistogramType
typedef TImageType	ImageType
typedef SimpleDataObjectDecorator < bool >	InputBooleanObjectType
typedef SimpleDataObjectDecorator < HistogramMeasurementType >	InputHistogramMeasurementObjectType
typedef SimpleDataObjectDecorator < HistogramMeasurementVectorType >	InputHistogramMeasurementVectorObjectType
typedef SimpleDataObjectDecorator < HistogramSizeType >	InputHistogramSizeObjectType
typedef ImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef ImageToHistogramFilter	Self
typedef ProcessObject	Superclass
typedef NumericTraits < ValueType >::RealType	ValueRealType
typedef NumericTraits < PixelType >::ValueType	ValueType
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 ()
virtual const SimpleDataObjectDecorator < bool > *	GetAutoMinimumMaximumInput () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const SimpleDataObjectDecorator < HistogramSizeType > *	GetHistogramSizeInput () const
virtual const SimpleDataObjectDecorator < HistogramSizeType > *	GetInput1 () const
virtual const SimpleDataObjectDecorator < HistogramMeasurementType > *	GetInput2 () const
virtual const SimpleDataObjectDecorator < bool > *	GetInput5 () const
DataObjectPointerArray &	GetInputs ()
virtual const SimpleDataObjectDecorator < HistogramMeasurementType > *	GetMarginalScaleInput () const
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
const HistogramType *	GetOutput () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual void	GraftOutput (DataObject *output)
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
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)
virtual void	SetAutoMinimumMaximum (const bool &_arg)
virtual void	SetAutoMinimumMaximumInput (const SimpleDataObjectDecorator< bool > *_arg)
void	SetDebug (bool debugFlag) const
virtual void	SetHistogramSize (const HistogramSizeType &_arg)
virtual void	SetHistogramSizeInput (const SimpleDataObjectDecorator< HistogramSizeType > *_arg)
virtual void	SetInput1 (const SimpleDataObjectDecorator< HistogramSizeType > *_arg)
virtual void	SetInput2 (const SimpleDataObjectDecorator< HistogramMeasurementType > *_arg)
virtual void	SetInput5 (const SimpleDataObjectDecorator< bool > *_arg)
virtual void	SetMarginalScale (const HistogramMeasurementType &_arg)
virtual void	SetMarginalScaleInput (const SimpleDataObjectDecorator< HistogramMeasurementType > *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)


virtual const SimpleDataObjectDecorator < HistogramMeasurementVectorType > *	GetHistogramBinMaximumInput () const
virtual const SimpleDataObjectDecorator < HistogramMeasurementVectorType > *	GetHistogramBinMinimumInput () const
const ImageType *	GetInput () const
virtual const SimpleDataObjectDecorator < HistogramMeasurementVectorType > *	GetInput3 () const
virtual const SimpleDataObjectDecorator < HistogramMeasurementVectorType > *	GetInput4 () const
virtual void	SetHistogramBinMaximum (const HistogramMeasurementVectorType &_arg)
virtual void	SetHistogramBinMaximumInput (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)
virtual void	SetHistogramBinMinimum (const HistogramMeasurementVectorType &_arg)
virtual void	SetHistogramBinMinimumInput (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)
void	SetInput (const ImageType *)
virtual void	SetInput3 (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)
virtual void	SetInput4 (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Protected Member Functions
virtual void	CacheInputReleaseDataFlags ()
void	GenerateData (void)
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
	ImageToHistogramFilter ()
DataObject::Pointer	MakeOutput (unsigned int)
bool	PrintObservers (std::ostream &os, Indent indent) const
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	~ImageToHistogramFilter ()
Protected Attributes
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
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
DataObject *	GetOutput (unsigned int idx)
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 TImageType>
class itk::Statistics::ImageToHistogramFilter< TImageType >

This class generates an histogram from an image.

The concept of Histogram in ITK is quite generic. It has been designed to manage multiple components data. This class facilitates the computation of an histogram from an image. Internally it creates a List that is feed into the SampleToHistogramFilter.

Definition at line 44 of file itkImageToHistogramFilter.h.

Member Typedef Documentation

template<class TImageType >

typedef AdaptorType::Pointer itk::Statistics::ImageToHistogramFilter< TImageType >::AdaptorPointer

Definition at line 61 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef ImageToListSampleAdaptor< ImageType > itk::Statistics::ImageToHistogramFilter< TImageType >::AdaptorType

Definition at line 60 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef SmartPointer<const Self> itk::Statistics::ImageToHistogramFilter< TImageType >::ConstPointer

Reimplemented from itk::ProcessObject.

Definition at line 51 of file itkImageToHistogramFilter.h.

typedef DataObject::Pointer itk::ProcessObject::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Definition at line 97 of file itkProcessObject.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.

template<class TImageType >

typedef DenseFrequencyContainer2 itk::Statistics::ImageToHistogramFilter< TImageType >::FrequencyContainerType

Definition at line 65 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef GeneratorType::Pointer itk::Statistics::ImageToHistogramFilter< TImageType >::GeneratorPointer

Definition at line 77 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef SampleToHistogramFilter< AdaptorType, HistogramType > itk::Statistics::ImageToHistogramFilter< TImageType >::GeneratorType

Definition at line 75 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef HistogramType::ConstPointer itk::Statistics::ImageToHistogramFilter< TImageType >::HistogramConstPointer

Definition at line 69 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef HistogramType::MeasurementType itk::Statistics::ImageToHistogramFilter< TImageType >::HistogramMeasurementType

Definition at line 71 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef HistogramType::MeasurementVectorType itk::Statistics::ImageToHistogramFilter< TImageType >::HistogramMeasurementVectorType

Definition at line 72 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef HistogramType::Pointer itk::Statistics::ImageToHistogramFilter< TImageType >::HistogramPointer

Definition at line 68 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef HistogramType::SizeType itk::Statistics::ImageToHistogramFilter< TImageType >::HistogramSizeType

Definition at line 70 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef Histogram< ValueRealType > itk::Statistics::ImageToHistogramFilter< TImageType >::HistogramType

Definition at line 67 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef TImageType itk::Statistics::ImageToHistogramFilter< TImageType >::ImageType

Definition at line 57 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef SimpleDataObjectDecorator< bool > itk::Statistics::ImageToHistogramFilter< TImageType >::InputBooleanObjectType

Type of DataObjects to use for AutoMinimumMaximum input

Definition at line 105 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef SimpleDataObjectDecorator< HistogramMeasurementType > itk::Statistics::ImageToHistogramFilter< TImageType >::InputHistogramMeasurementObjectType

Type of DataObjects to use for Marginal Scale inputs

Definition at line 97 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef SimpleDataObjectDecorator< HistogramMeasurementVectorType > itk::Statistics::ImageToHistogramFilter< TImageType >::InputHistogramMeasurementVectorObjectType

Type of DataObjects to use for Minimum and Maximums values of the histogram bins.

Definition at line 102 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef SimpleDataObjectDecorator< HistogramSizeType > itk::Statistics::ImageToHistogramFilter< TImageType >::InputHistogramSizeObjectType

Type of DataObjects to use for Size inputs

Definition at line 93 of file itkImageToHistogramFilter.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.

template<class TImageType >

typedef ImageType::PixelType itk::Statistics::ImageToHistogramFilter< TImageType >::PixelType

Definition at line 62 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef SmartPointer<Self> itk::Statistics::ImageToHistogramFilter< TImageType >::Pointer

Reimplemented from itk::ProcessObject.

Definition at line 50 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef ImageToHistogramFilter itk::Statistics::ImageToHistogramFilter< TImageType >::Self

Standard typedefs

Reimplemented from itk::ProcessObject.

Definition at line 48 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef ProcessObject itk::Statistics::ImageToHistogramFilter< TImageType >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 49 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef NumericTraits< ValueType >::RealType itk::Statistics::ImageToHistogramFilter< TImageType >::ValueRealType

Definition at line 64 of file itkImageToHistogramFilter.h.

template<class TImageType >

typedef NumericTraits< PixelType >::ValueType itk::Statistics::ImageToHistogramFilter< TImageType >::ValueType

Definition at line 63 of file itkImageToHistogramFilter.h.

Constructor & Destructor Documentation

template<class TImageType >

itk::Statistics::ImageToHistogramFilter< TImageType >::ImageToHistogramFilter ( ) [protected]

template<class TImageType >

virtual itk::Statistics::ImageToHistogramFilter< TImageType >::~ImageToHistogramFilter ( ) [inline, protected, virtual]

Definition at line 138 of file itkImageToHistogramFilter.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.

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.

template<class TImageType >

void itk::Statistics::ImageToHistogramFilter< TImageType >::GenerateData ( void ) [protected, virtual]

Triggers the Computation of the histogram

Reimplemented from itk::ProcessObject.

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

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.

template<class TImageType >

virtual const SimpleDataObjectDecorator< bool >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetAutoMinimumMaximumInput ( ) const [virtual]

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.

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

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

template<class TImageType >

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetHistogramBinMaximumInput ( ) const [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetHistogramBinMinimumInput ( ) const [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual const SimpleDataObjectDecorator< HistogramSizeType >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetHistogramSizeInput ( ) const [virtual]

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.

template<class TImageType >

const ImageType* itk::Statistics::ImageToHistogramFilter< TImageType >::GetInput ( ) const

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual const SimpleDataObjectDecorator< HistogramSizeType >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetInput1 ( ) const [virtual]

template<class TImageType >

virtual const SimpleDataObjectDecorator< HistogramMeasurementType >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetInput2 ( ) const [virtual]

template<class TImageType >

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetInput3 ( ) const [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetInput4 ( ) const [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual const SimpleDataObjectDecorator< bool >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetInput5 ( ) const [virtual]

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.

template<class TImageType >

virtual const SimpleDataObjectDecorator< HistogramMeasurementType >* itk::Statistics::ImageToHistogramFilter< TImageType >::GetMarginalScaleInput ( ) const [virtual]

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

virtual const char* itk::Statistics::ImageToHistogramFilter< TImageType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

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

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.

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

Method used internally for getting an output.

Referenced by itk::watershed::Segmenter< InputImageType >::GetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetEquivalencyTable(), itk::TwoOutputExampleImageFilter< TImage >::GetInverseOutput(), itk::watershed::Segmenter< InputImageType >::GetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::GetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetOutputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::GetOutputSegmentTree(), and itk::watershed::Segmenter< InputImageType >::GetSegmentTable().

template<class TImageType >

const HistogramType* itk::Statistics::ImageToHistogramFilter< TImageType >::GetOutput ( ) const

Return the output histogram.

Warning:: This output is only valid after the Compute() method has been invoked

See also:: Compute

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.

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

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::GraftOutput ( DataObject * output ) [virtual]

Method that facilitates the use of this filter in the internal pipeline of another filter.

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.

template<class TImageType >

DataObject::Pointer itk::Statistics::ImageToHistogramFilter< TImageType >::MakeOutput ( unsigned int ) [protected, virtual]

Method that construct the outputs

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

static Pointer itk::Statistics::ImageToHistogramFilter< TImageType >::New ( ) [static]

standard New() method support

Reimplemented from itk::Object.

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]`

template<class TImageType >

void itk::Statistics::ImageToHistogramFilter< TImageType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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.

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetAutoMinimumMaximum ( const bool & _arg ) [virtual]

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetAutoMinimumMaximumInput ( const SimpleDataObjectDecorator< bool > * _arg ) [virtual]

Methods for setting and getting the boolean flag that defines whether the minimum and maximum of the histogram are going to be computed automatically from the values of the sample

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

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

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

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetHistogramBinMaximum ( const HistogramMeasurementVectorType & _arg ) [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetHistogramBinMaximumInput ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > * _arg ) [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetHistogramBinMinimum ( const HistogramMeasurementVectorType & _arg ) [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetHistogramBinMinimumInput ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > * _arg ) [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetHistogramSize ( const HistogramSizeType & _arg ) [virtual]

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetHistogramSizeInput ( const SimpleDataObjectDecorator< HistogramSizeType > * _arg ) [virtual]

Methods for setting and getting the histogram size. The histogram size is encapsulated inside a decorator class. For this reason, it is possible to set and get the decorator class, but it is only possible to set the histogram size by value. This macro declares the methods SetHistogramSize(), SetHistogramSizeInput(), GetHistogramSizeInput().

template<class TImageType >

void itk::Statistics::ImageToHistogramFilter< TImageType >::SetInput ( const ImageType * )

Connects the input image for which the histogram is going to be computed

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetInput1 ( const SimpleDataObjectDecorator< HistogramSizeType > * _arg ) [virtual]

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetInput2 ( const SimpleDataObjectDecorator< HistogramMeasurementType > * _arg ) [virtual]

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetInput3 ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > * _arg ) [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetInput4 ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > * _arg ) [virtual]

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetInput5 ( const SimpleDataObjectDecorator< bool > * _arg ) [virtual]

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetMarginalScale ( const HistogramMeasurementType & _arg ) [virtual]

template<class TImageType >

virtual void itk::Statistics::ImageToHistogramFilter< TImageType >::SetMarginalScaleInput ( const SimpleDataObjectDecorator< HistogramMeasurementType > * _arg ) [virtual]

Methods for setting and getting the Marginal scale value. The marginal scale is used when the type of the measurement vector componets are of integer type.

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

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.

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.

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

itkImageToHistogramFilter.h

itk::Statistics::ImageToHistogramFilter< TImageType > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class TImageType> class itk::Statistics::ImageToHistogramFilter< TImageType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TImageType>
class itk::Statistics::ImageToHistogramFilter< TImageType >