SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::IntensityWindowingImageFilter Class Reference

Applies a linear transformation to the intensity levels of the input Image that are inside a user-defined interval. Values below this interval are mapped to a constant. Values over the interval are mapped to another constant. More...

#include <sitkIntensityWindowingImageFilter.h>

+ Inheritance diagram for itk::simple::IntensityWindowingImageFilter:
+ Collaboration diagram for itk::simple::IntensityWindowingImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = IntensityWindowingImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (Image &&image1)
 
std::string GetName () const
 
double GetOutputMaximum () const
 
double GetOutputMinimum () const
 
double GetWindowMaximum () const
 
double GetWindowMinimum () const
 
 IntensityWindowingImageFilter ()
 
SelfSetOutputMaximum (double OutputMaximum)
 
SelfSetOutputMinimum (double OutputMinimum)
 
SelfSetWindowMaximum (double WindowMaximum)
 
SelfSetWindowMinimum (double WindowMinimum)
 
std::string ToString () const
 
virtual ~IntensityWindowingImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

bool m_InPlace {false}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_OutputMaximum {255.0}
 
double m_OutputMinimum {0.0}
 
double m_WindowMaximum {255.0}
 
double m_WindowMinimum {0.0}
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

Applies a linear transformation to the intensity levels of the input Image that are inside a user-defined interval. Values below this interval are mapped to a constant. Values over the interval are mapped to another constant.

IntensityWindowingImageFilter applies pixel-wise a linear transformation to the intensity values of input image pixels. The linear transformation is defined by the user in terms of the minimum and maximum values that the output image should have and the lower and upper limits of the intensity window of the input image. This operation is very common in visualization, and can also be applied as a convenient preprocessing operation for image segmentation.

All computations are performed in the precision of the input pixel's RealType. Before assigning the computed value to the output pixel.

See also
RescaleIntensityImageFilter
itk::simple::IntensityWindowing for the procedural interface
itk::IntensityWindowingImageFilter for the Doxygen on the original ITK class.

Definition at line 46 of file sitkIntensityWindowingImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 118 of file sitkIntensityWindowingImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkIntensityWindowingImageFilter.h.

◆ Self

Definition at line 48 of file sitkIntensityWindowingImageFilter.h.

Constructor & Destructor Documentation

◆ ~IntensityWindowingImageFilter()

virtual itk::simple::IntensityWindowingImageFilter::~IntensityWindowingImageFilter ( )
virtual

Destructor

◆ IntensityWindowingImageFilter()

itk::simple::IntensityWindowingImageFilter::IntensityWindowingImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::IntensityWindowingImageFilter::Execute ( const Image image1)

◆ Execute() [2/2]

Image itk::simple::IntensityWindowingImageFilter::Execute ( Image &&  image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::IntensityWindowingImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetName()

std::string itk::simple::IntensityWindowingImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 102 of file sitkIntensityWindowingImageFilter.h.

◆ GetOutputMaximum()

double itk::simple::IntensityWindowingImageFilter::GetOutputMaximum ( ) const
inline

Set/Get the values of the maximum and minimum intensities of the output image.

Definition at line 99 of file sitkIntensityWindowingImageFilter.h.

◆ GetOutputMinimum()

double itk::simple::IntensityWindowingImageFilter::GetOutputMinimum ( ) const
inline

Set/Get the values of the maximum and minimum intensities of the output image.

Definition at line 89 of file sitkIntensityWindowingImageFilter.h.

◆ GetWindowMaximum()

double itk::simple::IntensityWindowingImageFilter::GetWindowMaximum ( ) const
inline

Set/Get the values of the maximum and minimum intensities of the input intensity window.

Definition at line 79 of file sitkIntensityWindowingImageFilter.h.

◆ GetWindowMinimum()

double itk::simple::IntensityWindowingImageFilter::GetWindowMinimum ( ) const
inline

Set/Get the values of the maximum and minimum intensities of the input intensity window.

Definition at line 69 of file sitkIntensityWindowingImageFilter.h.

◆ SetOutputMaximum()

Self& itk::simple::IntensityWindowingImageFilter::SetOutputMaximum ( double  OutputMaximum)
inline

Set/Get the values of the maximum and minimum intensities of the output image.

Definition at line 94 of file sitkIntensityWindowingImageFilter.h.

◆ SetOutputMinimum()

Self& itk::simple::IntensityWindowingImageFilter::SetOutputMinimum ( double  OutputMinimum)
inline

Set/Get the values of the maximum and minimum intensities of the output image.

Definition at line 84 of file sitkIntensityWindowingImageFilter.h.

◆ SetWindowMaximum()

Self& itk::simple::IntensityWindowingImageFilter::SetWindowMaximum ( double  WindowMaximum)
inline

Set/Get the values of the maximum and minimum intensities of the input intensity window.

Definition at line 74 of file sitkIntensityWindowingImageFilter.h.

◆ SetWindowMinimum()

Self& itk::simple::IntensityWindowingImageFilter::SetWindowMinimum ( double  WindowMinimum)
inline

Set/Get the values of the maximum and minimum intensities of the input intensity window.

Definition at line 64 of file sitkIntensityWindowingImageFilter.h.

◆ ToString()

std::string itk::simple::IntensityWindowingImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 122 of file sitkIntensityWindowingImageFilter.h.

Member Data Documentation

◆ m_InPlace

bool itk::simple::IntensityWindowingImageFilter::m_InPlace {false}
private

Definition at line 136 of file sitkIntensityWindowingImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::IntensityWindowingImageFilter::m_MemberFactory
private

Definition at line 124 of file sitkIntensityWindowingImageFilter.h.

◆ m_OutputMaximum

double itk::simple::IntensityWindowingImageFilter::m_OutputMaximum {255.0}
private

Definition at line 133 of file sitkIntensityWindowingImageFilter.h.

◆ m_OutputMinimum

double itk::simple::IntensityWindowingImageFilter::m_OutputMinimum {0.0}
private

Definition at line 131 of file sitkIntensityWindowingImageFilter.h.

◆ m_WindowMaximum

double itk::simple::IntensityWindowingImageFilter::m_WindowMaximum {255.0}
private

Definition at line 129 of file sitkIntensityWindowingImageFilter.h.

◆ m_WindowMinimum

double itk::simple::IntensityWindowingImageFilter::m_WindowMinimum {0.0}
private

Definition at line 127 of file sitkIntensityWindowingImageFilter.h.


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