ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkDiscreteGaussianImageFilter.h>

+ Inheritance diagram for itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef FixedArray< double,
itkGetStaticConstMacro(ImageDimension) > 
ArrayType
typedef SmartPointer< const SelfConstPointer
typedef TInputImage InputImageType
typedef
TInputImage::InternalPixelType 
InputInternalPixelType
typedef TInputImage::PixelType InputPixelType
typedef NumericTraits
< InputPixelType >::ValueType 
InputPixelValueType
typedef TOutputImage OutputImageType
typedef
TOutputImage::InternalPixelType 
OutputInternalPixelType
typedef TOutputImage::PixelType OutputPixelType
typedef NumericTraits
< OutputPixelType >::ValueType 
OutputPixelValueType
typedef SmartPointer< SelfPointer
typedef DiscreteGaussianImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
typedef OutputImageType::Pointer OutputImagePointer
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
virtual const unsigned int & GetInternalNumberOfStreamDivisions ()
virtual const char * GetNameOfClass () const
virtual void SetInternalNumberOfStreamDivisions (unsigned int _arg)
void SetMaximumError (const typename ArrayType::ValueType v)
void SetMaximumError (const double *v)
void SetMaximumError (const float *v)
void SetUseImageSpacingOff ()
void SetUseImageSpacingOn ()
void SetVariance (const double *v)
void SetVariance (const float *v)
 typedef (Concept::HasNumericTraits< OutputPixelValueType >) OutputHasNumericTraitsCheck
virtual void SetVariance (ArrayType _arg)
virtual const ArrayType GetVariance () const
virtual void SetMaximumError (ArrayType _arg)
virtual const ArrayType GetMaximumError () const
virtual int GetMaximumKernelWidth () const
virtual void SetMaximumKernelWidth (int _arg)
virtual unsigned int GetFilterDimensionality () const
virtual void SetFilterDimensionality (unsigned int _arg)
void SetVariance (const typename ArrayType::ValueType v)
virtual void SetUseImageSpacing (bool _arg)
virtual bool GetUseImageSpacing () const
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput (void) const
const InputImageTypeGetInput (unsigned int idx) const
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)
virtual void SetInput (const InputImageType *image)
virtual void SetInput (unsigned int, const TInputImage *image)
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageTypeGetOutput (void)
const OutputImageTypeGetOutput (void) const
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions

void GenerateData ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~DiscreteGaussianImageFilter ()
 DiscreteGaussianImageFilter ()
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 ImageToImageFilter ()
virtual void VerifyInputInformation ()
 ~ImageToImageFilter ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
virtual void AllocateOutputs ()
virtual void BeforeThreadedGenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~ImageSource ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputInformation ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

 DiscreteGaussianImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

unsigned int m_FilterDimensionality
unsigned int m_InternalNumberOfStreamDivisions
ArrayType m_MaximumError
int m_MaximumKernelWidth
bool m_UseImageSpacing
ArrayType m_Variance

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >

Blurs an image by separable convolution with discrete gaussian kernels. This filter performs Gaussian blurring by separable convolution of an image and a discrete Gaussian operator (kernel).

The Gaussian operator used here was described by Tony Lindeberg (Discrete Scale-Space Theory and the Scale-Space Primal Sketch. Dissertation. Royal Institute of Technology, Stockholm, Sweden. May 1991.) The Gaussian kernel used here was designed so that smoothing and derivative operations commute after discretization.

The variance or standard deviation (sigma) will be evaluated as pixel units if SetUseImageSpacing is off (false) or as physical units if SetUseImageSpacing is on (true, default). The variance can be set independently in each dimension.

When the Gaussian kernel is small, this filter tends to run faster than itk::RecursiveGaussianImageFilter.

See also:
GaussianOperator
Image
Neighborhood
NeighborhoodOperator
RecursiveGaussianImageFilter
Wiki Examples:
Examples:
itkOrthogonalSwath2DPathFilterTest.cxx.

Definition at line 62 of file itkDiscreteGaussianImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef FixedArray< double, itkGetStaticConstMacro(ImageDimension) > itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::ArrayType

Typedef of double containers

Definition at line 99 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef TInputImage itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputImageType
template<class TInputImage , class TOutputImage >
typedef TInputImage::InternalPixelType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputInternalPixelType
template<class TInputImage , class TOutputImage >
typedef TInputImage::PixelType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputPixelType
template<class TInputImage , class TOutputImage >
typedef NumericTraits<InputPixelType>::ValueType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::InputPixelValueType

Pixel value type for Vector pixel types

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

Definition at line 90 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

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

Definition at line 80 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::InternalPixelType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType
template<class TInputImage , class TOutputImage >
typedef TOutputImage::PixelType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

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

Definition at line 84 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef NumericTraits<OutputPixelType>::ValueType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::OutputPixelValueType
template<class TInputImage , class TOutputImage >
typedef SmartPointer< Self > itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef DiscreteGaussianImageFilter itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::Self
template<class TInputImage , class TOutputImage >
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::DiscreteGaussianImageFilter ( )
inlineprotected

End concept checking

Definition at line 239 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::~DiscreteGaussianImageFilter ( )
inlineprotectedvirtual

Definition at line 250 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::DiscreteGaussianImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::GPUDiscreteGaussianImageFilter< TInputImage, TOutputImage >, and itk::GPUImageToImageFilter< TInputImage, TOutputImage, DiscreteGaussianImageFilter< TInputImage, TOutputImage > >.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateData ( )
protectedvirtual

Standard pipeline method. While this class does not implement a ThreadedGenerateData(), its GenerateData() delegates all calculations to an NeighborhoodOperatorImageFilter. Since the NeighborhoodOperatorImageFilter is multithreaded, this filter is multithreaded by default.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::GPUImageToImageFilter< TInputImage, TOutputImage, DiscreteGaussianImageFilter< TInputImage, TOutputImage > >.

template<class TInputImage , class TOutputImage >
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) throw ( InvalidRequestedRegionError )
virtual

DiscreteGaussianImageFilter needs a larger input requested region than the output requested region (larger by the size of the Gaussian kernel). As such, DiscreteGaussianImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also:
ImageToImageFilter::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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

template<class TInputImage , class TOutputImage >
virtual unsigned int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetFilterDimensionality ( ) const
virtual

Set the number of dimensions to smooth. Defaults to the image dimension. Can be set to less than ImageDimension, smoothing all the dimensions less than FilterDimensionality. For instance, to smooth the slices of a volume without smoothing in Z, set the FilterDimensionality to 2.

template<class TInputImage , class TOutputImage >
virtual const unsigned int& itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetInternalNumberOfStreamDivisions ( )
virtual
template<class TInputImage , class TOutputImage >
virtual const ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetMaximumError ( ) const
virtual

The algorithm will size the discrete kernel so that the error resulting from truncation of the kernel is no greater than MaximumError. The default is 0.01 in each dimension.

template<class TInputImage , class TOutputImage >
virtual int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetMaximumKernelWidth ( ) const
virtual

Set the kernel to be no wider than MaximumKernelWidth pixels, even if MaximumError demands it. The default is 32 pixels.

template<class TInputImage , class TOutputImage >
virtual const char* itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual
template<class TInputImage , class TOutputImage >
virtual bool itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetUseImageSpacing ( ) const
virtual

Set/Get whether or not the filter will use the spacing of the input image in its calculations

template<class TInputImage , class TOutputImage >
virtual const ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GetVariance ( ) const
virtual

The variance for the discrete Gaussian kernel. Sets the variance independently for each dimension, but see also SetVariance(const double v). The default is 0.0 in each dimension. If UseImageSpacing is true, the units are the physical units of your image. If UseImageSpacing is false then the units are pixels.

template<class TInputImage , class TOutputImage >
static Pointer itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::New ( )
static
template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GPUDiscreteGaussianImageFilter< TInputImage, TOutputImage >, and itk::GPUImageToImageFilter< TInputImage, TOutputImage, DiscreteGaussianImageFilter< TInputImage, TOutputImage > >.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GPUDiscreteGaussianImageFilter< TInputImage, TOutputImage >, and itk::GPUImageToImageFilter< TInputImage, TOutputImage, DiscreteGaussianImageFilter< TInputImage, TOutputImage > >.

template<class TInputImage , class TOutputImage >
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetFilterDimensionality ( unsigned int  _arg)
virtual

Set the number of dimensions to smooth. Defaults to the image dimension. Can be set to less than ImageDimension, smoothing all the dimensions less than FilterDimensionality. For instance, to smooth the slices of a volume without smoothing in Z, set the FilterDimensionality to 2.

template<class TInputImage , class TOutputImage >
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetInternalNumberOfStreamDivisions ( unsigned int  _arg)
virtual

Set/Get number of pieces to divide the input for the internal composite pipeline. The upstream pipeline will not be effected.

The default value is $ImageDimension^2$.

This parameter was introduced to reduce the memory used by images internally, at the cost of performance.

template<class TInputImage , class TOutputImage >
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError ( ArrayType  _arg)
virtual

The algorithm will size the discrete kernel so that the error resulting from truncation of the kernel is no greater than MaximumError. The default is 0.01 in each dimension.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError ( const typename ArrayType::ValueType  v)
inline

Definition at line 142 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError ( const double *  v)
inline

Definition at line 170 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError ( const float *  v)
inline

Definition at line 181 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumKernelWidth ( int  _arg)
virtual

Set the kernel to be no wider than MaximumKernelWidth pixels, even if MaximumError demands it. The default is 32 pixels.

template<class TInputImage , class TOutputImage >
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetUseImageSpacing ( bool  _arg)
virtual

Set/Get whether or not the filter will use the spacing of the input image in its calculations

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetUseImageSpacingOff ( )
inline

Ignore the image spacing. Use this option if you want to specify Gaussian variance in pixels. Default is ImageSpacingOn.

Definition at line 200 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetUseImageSpacingOn ( )
inline

Use the image spacing information in calculations. Use this option if you want to specify Gaussian variance in real world units. Default is ImageSpacingOn.

Definition at line 195 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance ( ArrayType  _arg)
virtual

The variance for the discrete Gaussian kernel. Sets the variance independently for each dimension, but see also SetVariance(const double v). The default is 0.0 in each dimension. If UseImageSpacing is true, the units are the physical units of your image. If UseImageSpacing is false then the units are pixels.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance ( const typename ArrayType::ValueType  v)
inline

Convenience Set methods for setting all dimensional parameters to the same values.

Definition at line 135 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance ( const double *  v)
inline

Definition at line 148 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
void itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance ( const float *  v)
inline

Definition at line 159 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::typedef ( Concept::HasNumericTraits< OutputPixelValueType )

Begin concept checking This class requires OutputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< OutputPixelValueType > )


Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension
static

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

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

Definition at line 96 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_FilterDimensionality
private

Number of dimensions to process. Default is all dimensions

Definition at line 278 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_InternalNumberOfStreamDivisions
private

Number of pieces to divide the input on the internal composite pipeline. The upstream pipeline will not be effected.

Definition at line 285 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_MaximumError
private

The maximum error of the gaussian blurring kernel in each dimensional direction. For definition of maximum error, see GaussianOperator.

See also:
GaussianOperator

Definition at line 271 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
int itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_MaximumKernelWidth
private

Maximum allowed kernel width for any dimension of the discrete Gaussian approximation

Definition at line 275 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
bool itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing
private

Flag to indicate whether to use image spacing

Definition at line 281 of file itkDiscreteGaussianImageFilter.h.

template<class TInputImage , class TOutputImage >
ArrayType itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::m_Variance
private

The variance of the gaussian blurring kernel in each dimensional direction.

Definition at line 266 of file itkDiscreteGaussianImageFilter.h.


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