mitkBoundingObjectCutter.h
Go to the documentation of this file.
00001 /*========================================================================= 00002 00003 Program: Medical Imaging & Interaction Toolkit 00004 Language: C++ 00005 Date: $Date$ 00006 Version: $Revision$ 00007 00008 Copyright (c) German Cancer Research Center, Division of Medical and 00009 Biological Informatics. All rights reserved. 00010 See MITKCopyright.txt or https://www.mitk.org/copyright.html for details. 00011 00012 This software is distributed WITHOUT ANY WARRANTY; without even 00013 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 00014 PURPOSE. See the above copyright notices for more information. 00015 00016 =========================================================================*/ 00017 00018 00019 #ifndef BOUNDINGOBJECTCUTTER_H_HEADER_INCLUDED_C10B22CD 00020 #define BOUNDINGOBJECTCUTTER_H_HEADER_INCLUDED_C10B22CD 00021 00022 #include "mitkCommon.h" 00023 #include "MitkExtExports.h" 00024 #include "mitkImageToImageFilter.h" 00025 #include "mitkBoundingObject.h" 00026 #include "mitkImageTimeSelector.h" 00027 #include "itkImage.h" 00028 00029 00030 namespace mitk { 00031 00032 //##Documentation 00033 //## @brief Cuts an Boundingobject out of an mitk Image 00034 //## 00035 //## Input Parameters are a mitk::BoundingObject and optionally an mitk::Image 00036 //## if no mitk::Image is provided, the resulting image will have m_InsideValue as pixelvalue on inside pixel, 00037 //## otherwise it will have the pixelvalue of the input image. 00038 //## Pixel on the outside of the BoundingObject will have a pixelvalue of m_OutsideValue 00039 //## \todo What Image resolution/spacing should be used, if no input image is given? 00040 //## @ingroup Process 00041 class MitkExt_EXPORT BoundingObjectCutter : public ImageToImageFilter 00042 { 00043 public: 00044 mitkClassMacro(BoundingObjectCutter, ImageToImageFilter); 00045 itkNewMacro(Self); 00046 00047 void SetBoundingObject( const mitk::BoundingObject* boundingObject ); 00048 const mitk::BoundingObject* GetBoundingObject() const; 00049 //##Description 00050 //## @brief Set for inside pixels, used when m_UseInsideValue is @a true 00051 itkSetMacro(InsideValue, ScalarType); 00052 itkGetMacro(InsideValue, ScalarType); 00053 //##Description 00054 //## @brief Set value for outside pixels, used when m_AutoOutsideValue is \a false 00055 itkSetMacro(OutsideValue, ScalarType); 00056 itkGetMacro(OutsideValue, ScalarType); 00057 itkSetMacro(UseInsideValue, bool); 00058 itkGetMacro(UseInsideValue, bool); 00059 itkBooleanMacro(UseInsideValue); 00060 //##Description 00061 //## @brief If set to \a true the minimum of the ouput pixel type is 00062 //## used as outside value. 00063 itkSetMacro(AutoOutsideValue, bool); 00064 itkGetMacro(AutoOutsideValue, bool); 00065 itkBooleanMacro(AutoOutsideValue); 00066 00067 itkGetMacro(InsidePixelCount, unsigned int); 00068 itkGetMacro(OutsidePixelCount, unsigned int); 00069 00070 itkSetMacro(UseWholeInputRegion, bool); 00071 itkGetMacro(UseWholeInputRegion, bool); 00072 00073 protected: 00074 BoundingObjectCutter(); 00075 virtual ~BoundingObjectCutter(); 00076 00077 virtual const std::type_info& GetOutputPixelType(); 00078 00079 virtual void GenerateInputRequestedRegion(); 00080 virtual void GenerateOutputInformation(); 00081 virtual void GenerateData(); 00082 00083 template < typename TPixel, unsigned int VImageDimension, typename TOutputPixel > 00084 friend void CutImageWithOutputTypeSelect( itk::Image< TPixel, VImageDimension >* inputItkImage, mitk::BoundingObjectCutter* cutter, int boTimeStep=0, TOutputPixel* dummy=NULL ); 00085 template < typename TPixel, unsigned int VImageDimension > 00086 friend void CutImage( itk::Image< TPixel, VImageDimension >* itkImage, mitk::BoundingObjectCutter* cutter, int boTimeStep ); 00087 virtual void ComputeData(mitk::Image* input3D, int boTimeStep); 00088 00089 //##Description 00090 //## @brief BoundingObject that will be cut 00091 mitk::BoundingObject::Pointer m_BoundingObject; 00092 //##Description 00093 //## @brief Value for inside pixels, used when m_UseInsideValue is @a true 00094 //## 00095 //## \sa m_UseInsideValue 00096 ScalarType m_InsideValue; 00097 //##Description 00098 //## @brief Value for outside pixels (default: 0) 00099 //## 00100 //## Used only if m_AutoOutsideValue is \a false. 00101 ScalarType m_OutsideValue; 00102 //##Description 00103 //## @brief If \a true the minimum of the ouput pixel type is 00104 //## used as outside value (default: \a false) 00105 bool m_AutoOutsideValue; 00106 //##Description 00107 //## @brief Use m_InsideValue for inside pixels (default: \a false) 00108 //## 00109 //## If @a true, pixels that are inside m_BoundingObject 00110 //## will get m_InsideValue in the cutting process 00111 //## If @a false, they keep their original value. 00112 //## \sa m_InsideValue 00113 bool m_UseInsideValue; 00114 00115 unsigned int m_OutsidePixelCount; 00116 unsigned int m_InsidePixelCount; 00117 00118 //##Description 00119 //## @brief Region of input needed for cutting 00120 mitk::SlicedData::RegionType m_InputRequestedRegion; 00121 00122 //##Description 00123 //## @brief Time when Header was last initialized 00124 itk::TimeStamp m_TimeOfHeaderInitialization; 00125 00126 mitk::ImageTimeSelector::Pointer m_InputTimeSelector; 00127 mitk::ImageTimeSelector::Pointer m_OutputTimeSelector; 00128 00129 bool m_UseWholeInputRegion; 00130 }; 00131 } // namespace mitk 00132 00133 #endif /* BOUNDINGOBJECTCUTTER_H_HEADER_INCLUDED_C10B22CD */ 00134 00135 00136
