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

Casts input pixels to output pixel type and clamps the output pixel values to the range supported by the output pixel type. More...

#include <itkClampImageFilter.h>

Inheritance diagram for itk::ClampImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::ClampImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef ClampImageFilter Self
typedef
UnaryFunctorImageFilter
< TInputImage, TOutputImage,
Functor::Clamp< typename
TInputImage::PixelType,
typename
TOutputImage::PixelType > > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
 typedef (Concept::Convertible< typename TInputImage::PixelType, double >) InputConvertibleToDoubleCheck
 typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
 typedef (Concept::Convertible< typename TOutputImage::PixelType, double >) OutputConvertibleToDoubleCheck

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 ClampImageFilter ()
void GenerateData ()
virtual ~ClampImageFilter ()

Private Member Functions

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

Detailed Description

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

Casts input pixels to output pixel type and clamps the output pixel values to the range supported by the output pixel type.

This filter is templated over the input image type and the output image type.

Author:
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See also:
UnaryFunctorImageFilter
CastImageFilter
Wiki Examples:

Definition at line 88 of file itkClampImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::ClampImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef SmartPointer< Self > itk::ClampImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef ClampImageFilter itk::ClampImageFilter< TInputImage, TOutputImage >::Self
template<class TInputImage , class TOutputImage >
typedef UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Clamp< typename TInputImage::PixelType, typename TOutputImage::PixelType > > itk::ClampImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::ClampImageFilter< TInputImage, TOutputImage >::ClampImageFilter ( ) [inline, protected]

End concept checking

Definition at line 129 of file itkClampImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual itk::ClampImageFilter< TInputImage, TOutputImage >::~ClampImageFilter ( ) [inline, protected, virtual]

Definition at line 130 of file itkClampImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::ClampImageFilter< TInputImage, TOutputImage >::ClampImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::ClampImageFilter< 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::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Clamp< TInputImage::PixelType, TOutputImage::PixelType > >.

template<class TInputImage , class TOutputImage >
void itk::ClampImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [inline, protected, virtual]

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

Definition at line 132 of file itkClampImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual const char* itk::ClampImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]
template<class TInputImage , class TOutputImage >
static Pointer itk::ClampImageFilter< TInputImage, TOutputImage >::New ( ) [static]
template<class TInputImage , class TOutputImage >
void itk::ClampImageFilter< 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::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Clamp< TInputImage::PixelType, TOutputImage::PixelType > >.

template<class TInputImage , class TOutputImage >
itk::ClampImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< typename TOutputImage::PixelType, double >  )

This class requires OutputConvertibleToDoubleCheck in the form of (Concept::Convertible< typename TOutputImage::PixelType, double > )

template<class TInputImage , class TOutputImage >
itk::ClampImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >  )

Begin concept checking This class requires InputConvertibleToOutputCheck in the form of (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >)

template<class TInputImage , class TOutputImage >
itk::ClampImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< typename TInputImage::PixelType, double >  )

This class requires InputConvertibleToDoubleCheck in the form of (Concept::Convertible< typename TInputImage::PixelType, double > )


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