mitkAutoCropImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 
Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$
 
Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.
 
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/

#ifndef __mitkAutoCropImageFilter_h_
#define __mitkAutoCropImageFilter_h_

#include "mitkCommon.h"
#include "MitkExtExports.h"
#include "mitkSubImageSelector.h"
#include "mitkImageTimeSelector.h"

#include <itkImageRegion.h>
#include <itkCropImageFilter.h>

namespace mitk {

class MitkExt_EXPORT AutoCropImageFilter : public SubImageSelector
{
public:

  typedef itk::ImageRegion<3> RegionType;

  mitkClassMacro(AutoCropImageFilter, SubImageSelector);

  itkNewMacro(Self);  

  itkGetConstMacro(BackgroundValue,float);
  itkSetMacro(BackgroundValue,float);

  itkGetConstMacro(MarginFactor,float);
  itkSetMacro(MarginFactor,float);
  
  // Use this method to manually set a region
  void SetCroppingRegion(RegionType overrideRegion);

  virtual const std::type_info& GetOutputPixelType();

protected:

  // default constructor
  AutoCropImageFilter();

  // default destructor
  virtual ~AutoCropImageFilter();

  // This method calculates the actual smallest box
  void ComputeNewImageBounds();

  // Crops the image using the itk::CropImageFilter and creates the new output image
  template < typename TPixel, unsigned int VImageDimension> 
  void ITKCrop3DImage( itk::Image< TPixel, VImageDimension >* inputItkImage, unsigned int timestep );

  // Here, the output image is initialized by the input and the newly calculated region
  virtual void GenerateOutputInformation();

  // Purposely not implemented
  virtual void GenerateInputRequestedRegion();

  // Crops the image on all time steps
  virtual void GenerateData();

  float m_BackgroundValue;

  RegionType m_CroppingRegion;

  float m_MarginFactor;

  typedef itk::Image<float,3>    ImageType;
  typedef ImageType::Pointer      ImagePointer;
  typedef itk::CropImageFilter<ImageType,ImageType> CropFilterType;

  ImageType::RegionType::SizeType m_RegionSize;
  ImageType::RegionType::IndexType m_RegionIndex;

  CropFilterType::SizeType m_LowerBounds;
  CropFilterType::SizeType m_UpperBounds;

  mitk::ImageTimeSelector::Pointer m_TimeSelector;

  mitk::SlicedData::RegionType m_InputRequestedRegion;
  itk::TimeStamp m_TimeOfHeaderInitialization;

  bool m_OverrideCroppingRegion;

};

} // namespace mitk

#endif