mitkMaskImageFilter.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef MITKMASKIMAGEFILTER_H_HEADER_INCLUDED_C1F48A22
#define MITKMASKIMAGEFILTER_H_HEADER_INCLUDED_C1F48A22

#include "MitkAlgorithmsExtExports.h"
#include "mitkCommon.h"
#include "mitkImageTimeSelector.h"
#include "mitkImageToImageFilter.h"

#include "itkImage.h"

namespace mitk
{
  //##Documentation
  //## @brief
  //## @ingroup Process
  class MITKALGORITHMSEXT_EXPORT MaskImageFilter : public ImageToImageFilter
  {
  public:
    mitkClassMacro(MaskImageFilter, ImageToImageFilter);

    itkFactorylessNewMacro(Self);

    itkCloneMacro(Self);

      void SetMask(const mitk::Image *mask);
    const mitk::Image *GetMask() const;

    itkGetMacro(MinValue, mitk::ScalarType);
    itkSetMacro(MinValue, mitk::ScalarType);

    itkGetMacro(MaxValue, mitk::ScalarType);
    itkSetMacro(MaxValue, mitk::ScalarType);

    itkSetMacro(OutsideValue, mitk::ScalarType);

    itkGetMacro(OutsideValue, mitk::ScalarType);

    itkSetMacro(OverrideOutsideValue, bool);
    itkGetMacro(OverrideOutsideValue, bool);
    itkBooleanMacro(OverrideOutsideValue);

  protected:
    MaskImageFilter();

    ~MaskImageFilter() override;

    void GenerateInputRequestedRegion() override;

    void GenerateOutputInformation() override;

    void GenerateData() override;

    template <typename TPixel, unsigned int VImageDimension>
    void InternalComputeMask(itk::Image<TPixel, VImageDimension> *itkImage);

    mitk::Image::Pointer m_Mask;
    mitk::ImageTimeSelector::Pointer m_InputTimeSelector;
    mitk::ImageTimeSelector::Pointer m_MaskTimeSelector;
    mitk::ImageTimeSelector::Pointer m_OutputTimeSelector;

    //##Description
    //## @brief Time when Header was last initialized
    itk::TimeStamp m_TimeOfHeaderInitialization;

    mitk::ScalarType m_OutsideValue;
    mitk::ScalarType m_MinValue;
    mitk::ScalarType m_MaxValue;
    bool m_OverrideOutsideValue;
  };

} // namespace mitk

#endif /* MITKMASKIMAGEFILTER_H_HEADER_INCLUDED_C1F48A22 */