itkRescaleImageUsingHistogramPercentilesFilter.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef itkRescaleImageUsingHistogramPercentilesFilter_h
#define itkRescaleImageUsingHistogramPercentilesFilter_h

#include <itkImageToImageFilter.h>


namespace itk {
  
template<class TInputImage, class TOutputImage>
class ITK_EXPORT RescaleImageUsingHistogramPercentilesFilter:
    public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
  typedef RescaleImageUsingHistogramPercentilesFilter    Self;
  typedef ImageToImageFilter< TInputImage,TOutputImage > Superclass;
  typedef SmartPointer< Self >                           Pointer;
  typedef SmartPointer< const Self >                     ConstPointer;
  
  itkTypeMacro( RescaleImageUsingHistogramPercentilesFilter, ImageToImageFilter );

  itkNewMacro(Self);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  typedef TInputImage                           InputImageType;
  typedef typename InputImageType::Pointer      InputImagePointer;
  typedef typename InputImageType::ConstPointer InputImageConstPointer;
  typedef typename InputImageType::RegionType   InputImageRegionType;
  typedef typename InputImageType::PixelType    InputImagePixelType;
  typedef typename InputImageType::SpacingType  InputImageSpacingType;
  typedef typename InputImageType::PointType    InputImagePointType;

  typedef typename NumericTraits<InputImagePixelType>::RealType RealType;

  typedef TOutputImage                          OutputImageType;
  typedef typename OutputImageType::Pointer     OutputImagePointer;
  typedef typename OutputImageType::RegionType  OutputImageRegionType;
  typedef typename OutputImageType::PixelType   OutputImagePixelType;
  typedef typename OutputImageType::IndexType   OutputImageIndexType;
  typedef typename OutputImageType::PointType   OutputImagePointType;

  typedef OutputImagePointType OriginType;

  void SetDebug(bool b) { itk::Object::SetDebug(b); }
  void DebugOn() { this->SetDebug(true); }
  void DebugOff() { this->SetDebug(false); }

  void SetVerbose(bool b) { m_FlgVerbose = b; }
  void VerboseOn() { this->SetVerbose(true); }
  void VerboseOff() { this->SetVerbose(false); }

  void ClipTheOutput() { m_FlgClipTheOutput = true; }

  itkSetMacro( InLowerPercentile, RealType );
  itkGetMacro( InLowerPercentile, RealType );

  itkSetMacro( InUpperPercentile, RealType );
  itkGetMacro( InUpperPercentile, RealType );

  itkSetMacro( OutLowerLimit, RealType );
  itkGetMacro( OutLowerLimit, RealType );

  itkSetMacro( OutUpperLimit, RealType );
  itkGetMacro( OutUpperLimit, RealType );


#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(InputHasNumericTraitsCheck,
                  (Concept::HasNumericTraits<InputImagePixelType>));
  itkConceptMacro(OutputHasPixelTraitsCheck,
                  (Concept::HasPixelTraits<OutputImagePixelType>));
#endif


protected:
  RescaleImageUsingHistogramPercentilesFilter();
  virtual ~RescaleImageUsingHistogramPercentilesFilter();
  void PrintSelf(std::ostream& os, Indent indent) const;

  virtual void GenerateData(void);
  
  bool m_FlgVerbose;

  bool m_FlgClipTheOutput;

  RealType m_InLowerPercentile;
  RealType m_InUpperPercentile;

  RealType m_OutLowerLimit;
  RealType m_OutUpperLimit;



private:
  RescaleImageUsingHistogramPercentilesFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkRescaleImageUsingHistogramPercentilesFilter.txx"
#endif

#endif