/*=========================================================================
  Program:   vv                     http://www.creatis.insa-lyon.fr/rio/vv

  Authors belong to: 
  - University of LYON              http://www.universite-lyon.fr/
  - Léon Bérard cancer center       http://oncora1.lyon.fnclcc.fr
  - CREATIS CNRS laboratory         http://www.creatis.insa-lyon.fr

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the copyright notices for more information.

  It is distributed under dual licence

  - BSD        See included LICENSE.txt file
  - CeCILL-B   http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  ======================================================================-====*/

#ifndef CLITKSLICEBYSLICERELATIVEPOSITIONFILTER_H
#define CLITKSLICEBYSLICERELATIVEPOSITIONFILTER_H

// clitk
#include "clitkFilterBase.h"
#include "clitkAddRelativePositionConstraintToLabelImageFilter.h"

namespace clitk {
  
  //--------------------------------------------------------------------
  /*
    Perform Relative Position filtering in a slice by slice manner. 
  */
  //--------------------------------------------------------------------
  
  template <class ImageType>
  class ITK_EXPORT SliceBySliceRelativePositionFilter:
    public AddRelativePositionConstraintToLabelImageFilter<ImageType>
  {

  public:
    /** Standard class typedefs. */
    typedef AddRelativePositionConstraintToLabelImageFilter<ImageType>   Superclass;
    typedef SliceBySliceRelativePositionFilter              Self;
    typedef itk::SmartPointer<Self>                         Pointer;
    typedef itk::SmartPointer<const Self>                   ConstPointer;
       
    /** Method for creation through the object factory. */
    itkNewMacro(Self);
    
    /** Run-time type information (and related methods). */
    itkTypeMacro(SliceBySliceRelativePositionFilter, ImageToImageFilter);
    FILTERBASE_INIT;

    /** ImageDimension constants */
    itkStaticConstMacro(ImageDimension, unsigned int, ImageType::ImageDimension);
    typedef itk::Image<float, ImageDimension> FloatImageType;
    typedef itk::Image<float, ImageDimension-1> FloatSliceType;

    /** Some convenient typedefs. */
    typedef typename ImageType::ConstPointer ImageConstPointer;
    typedef typename ImageType::Pointer      ImagePointer;
    typedef typename ImageType::RegionType   RegionType; 
    typedef typename ImageType::PixelType    PixelType;
    typedef typename ImageType::SpacingType  SpacingType;
    typedef typename ImageType::SizeType     SizeType;
    typedef itk::Image<PixelType, ImageDimension-1> SliceType;
    typedef clitk::AddRelativePositionConstraintToLabelImageFilter<SliceType> RelPosFilterType;
    typedef typename RelPosFilterType::OrientationTypeEnumeration OrientationTypeEnumeration;
    
    /** Input : initial image and object */
    virtual void SetInput(const ImageType * image) ITK_OVERRIDE;
    void SetInputObject(const ImageType * image);

    // Options
    void PrintOptions(std::ostream & os = std::cout);
    itkGetConstMacro(Direction, int);
    itkSetMacro(Direction, int);

    itkGetConstMacro(UniqueConnectedComponentBySliceFlag, bool);
    itkSetMacro(UniqueConnectedComponentBySliceFlag, bool);
    itkBooleanMacro(UniqueConnectedComponentBySliceFlag);

    itkGetConstMacro(IgnoreEmptySliceObjectFlag, bool);
    itkSetMacro(IgnoreEmptySliceObjectFlag, bool);
    itkBooleanMacro(IgnoreEmptySliceObjectFlag);

    itkGetConstMacro(UseTheLargestObjectCCLFlag, bool);
    itkSetMacro(UseTheLargestObjectCCLFlag, bool);
    itkBooleanMacro(UseTheLargestObjectCCLFlag);

    itkGetConstMacro(ObjectCCLSelectionFlag, bool);
    itkSetMacro(ObjectCCLSelectionFlag, bool);
    itkBooleanMacro(ObjectCCLSelectionFlag);
    itkGetConstMacro(ObjectCCLSelectionDimension, int);
    itkSetMacro(ObjectCCLSelectionDimension, int);
    itkGetConstMacro(ObjectCCLSelectionDirection, int);
    itkSetMacro(ObjectCCLSelectionDirection, int);
    itkGetConstMacro(ObjectCCLSelectionIgnoreSingleCCLFlag, bool);
    itkSetMacro(ObjectCCLSelectionIgnoreSingleCCLFlag, bool);
    itkBooleanMacro(ObjectCCLSelectionIgnoreSingleCCLFlag);

    itkGetConstMacro(VerboseSlicesFlag, bool);
    itkSetMacro(VerboseSlicesFlag, bool);
    itkBooleanMacro(VerboseSlicesFlag);

  protected:
    SliceBySliceRelativePositionFilter();
    virtual ~SliceBySliceRelativePositionFilter() {}
    
    virtual void GenerateOutputInformation() ITK_OVERRIDE;
    virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
    virtual void GenerateData() ITK_OVERRIDE;

    ImagePointer input;
    ImagePointer object;
    ImagePointer m_working_input;
    ImagePointer m_working_object;
    bool         m_UniqueConnectedComponentBySliceFlag;
    int          m_Direction;
    bool         m_IgnoreEmptySliceObjectFlag;
    bool         m_UseTheLargestObjectCCLFlag;
    bool         m_ObjectCCLSelectionFlag;
    int          m_ObjectCCLSelectionDimension;
    int          m_ObjectCCLSelectionDirection;
    bool         m_ObjectCCLSelectionIgnoreSingleCCLFlag;
    bool         m_VerboseSlicesFlag;

  private:
    SliceBySliceRelativePositionFilter(const Self&); //purposely not implemented
    void operator=(const Self&); //purposely not implemented
    
  }; // end class
  //--------------------------------------------------------------------

} // end namespace clitk
//--------------------------------------------------------------------

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