freCheckerBoardImageFilterController.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freCheckerBoardImageFilterController.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  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 __freCheckerBoardImageFilterController_h
#define __freCheckerBoardImageFilterController_h

#include "freImageToImageFilterControllerBase.h"

#include "itkCheckerBoardImageFilter.h"

namespace FREE
{

  freControllerIDMacro(CheckerBoardImageFilterControllerBase, "CheckerBoardImageFilterBase");
template <class TInputImage>
class CheckerBoardImageFilterControllerBase : public ImageToImageFilterControllerBase< itk::CheckerBoardImageFilter<TInputImage> >
{
public:  
  typedef itk::CheckerBoardImageFilter<TInputImage> ComponentType;
  typedef ImageToImageFilterControllerBase<ComponentType> Superclass;
  typedef CheckerBoardImageFilterControllerBase<ComponentType> Self;

  typedef typename ComponentType::Pointer               ComponentPointer;
  typedef typename Superclass::GenericComponentType     GenericComponentType;
  typedef typename Superclass::GenericComponentPointer  GenericComponentPointer;
  typedef typename Superclass::GenericMediaPointer      GenericMediaPointer;
  typedef typename ComponentType::OutputImageType       OutputImageType;
  typedef typename ComponentType::OutputImagePointer    OutputImagePointer;

  DeclareParameterMacro(CheckerPattern);

  itkTypeMacro(CheckerBoardImageFilterControllerBase, ImageToImageFilterControllerBase);

  virtual ValidityTag::Pointer GetMediaValidityTagRequirement(const MediaID& mediaID, SessionComponentCache* pComponentCache) const
  {
    if (mediaID == "output")
    {
      ValidityTag::Pointer smpReq = ValidityTag::New(this->GetMediaValidityTag(mediaID,pComponentCache)->GetTimeStamp());
      this->CompareValidityTagRequirement("input",smpReq,pComponentCache);
      this->CompareValidityTagRequirement("input2",smpReq,pComponentCache);
      return smpReq;
    }

    return Superclass::GetMediaValidityTagRequirement(mediaID, pComponentCache);
  }; 

protected:
  CheckerBoardImageFilterControllerBase()
  {
    //Profile settings
    this->UpdateControllerID(ControllerID::CheckerBoardImageFilterControllerBase);
    this->m_Description = "Basic class for controller of itk based binary functor image filters.";
  };

  virtual void GenerateProfile(CtrlProfile::ControllerProfile& profile,
                  const SessionComponentCache* pComponentCache,
                  bool bRegardOldSetup) const
  {
    Superclass::GenerateProfile(profile,pComponentCache,bRegardOldSetup);

    //Parameters
    profile.Parameters().AddParameter(cParam_CheckerPattern, Parameter::PVTInteger, cParamDsc_CheckerPattern, ComponentType::InputImageType::ImageDimension, "1");

    //Media
    profile.MediaMap().AddMedia("input2", ControllerID::IntensityImageMediaControllerBase, DASet, ComponentType::InputImageType::ImageDimension);
  };

  virtual void SetMediaCasted(const MediaID& mediaID, GenericMediaType* pMedia, ComponentType* pComponent, SessionComponentCache* pComponentCache,
                              SessionInfo* pSessionInfo) const
  {
    if (mediaID == "input2")
    {
      pComponent->SetInput2(dynamic_cast<typename ComponentType::InputImageType*>(pMedia));
    }
    else Superclass::SetMediaCasted(mediaID, pMedia, pComponent, pComponentCache, pSessionInfo);
  }; 

        virtual void ActualizeMainComponent(ComponentType* pMainComponent,
                                      SessionComponentCache* pComponentCache,
                                      SessionInfo* pSessionInfo,
                                                                                                                                                        const unsigned int& iActLevel) const
  {
    Superclass::ActualizeMainComponent(pMainComponent,pComponentCache, pSessionInfo, iActLevel);


          int iPatternSize;
    typename ComponentType::PatternArrayType pattern;

    try
    {
      Parameter::Pointer smpPatternParam = SessionAccessor::GetParameter(pComponentCache,cParam_CheckerPattern);
      if (smpPatternParam.IsNull()) throwCtrlExceptionMacro("","Error. Parameter "<<cParam_CheckerPattern<<" is missing. Please check your setup.");

      for (unsigned int iIndex = 0; iIndex<TInputImage::GetImageDimension(); iIndex++)
      {
        smpPatternParam->GetParameterValue(iPatternSize,iIndex);
        pattern[iIndex] = iPatternSize;
      }
    }
    catchAllNPassMacro("Error while setting checker pattern.");

    pMainComponent->SetCheckerPattern(pattern);
  };
};

template <class TInputImage>
const char* const CheckerBoardImageFilterControllerBase<TInputImage> :: cParam_CheckerPattern = "CheckerPattern";
template <class TInputImage>
const char* const CheckerBoardImageFilterControllerBase<TInputImage> :: cParamDsc_CheckerPattern = "Indicates the pattern size of the checker board. It is the size of on field in pixel per dimension for all dimensions.";

freControllerIDMacro(CheckerBoard2DImageFilterController, "Checker Board 2D Image Filter");
class CheckerBoard2DImageFilterController : public CheckerBoardImageFilterControllerBase< ImageTypes<2>::InternalImageType >
{
public:  
  typedef CheckerBoardImageFilterControllerBase< ImageTypes<2>::InternalImageType > Superclass;
  typedef CheckerBoard2DImageFilterController Self;

  typedef Superclass::ComponentType ComponentType;
  typedef ComponentType::Pointer ComponentPointer;
  typedef Superclass::GenericComponentType GenericComponentType;
  typedef Superclass::GenericComponentPointer GenericComponentPointer;
  typedef Superclass::GenericMediaPointer GenericMediaPointer;

  itkTypeMacro(CheckerBoard2DImageFilterController, CheckerBoardImageFilterControllerBase);

  CheckerBoard2DImageFilterController();
};

freControllerIDMacro(CheckerBoard3DImageFilterController, "Checker Board 3D Image Filter");
class CheckerBoard3DImageFilterController : public CheckerBoardImageFilterControllerBase< ImageTypes<3>::InternalImageType >
{
public:  
  typedef CheckerBoardImageFilterControllerBase< ImageTypes<3>::InternalImageType > Superclass;
  typedef CheckerBoard3DImageFilterController Self;

  typedef Superclass::ComponentType ComponentType;
  typedef ComponentType::Pointer ComponentPointer;
  typedef Superclass::GenericComponentType GenericComponentType;
  typedef Superclass::GenericComponentPointer GenericComponentPointer;
  typedef Superclass::GenericMediaPointer GenericMediaPointer;

  itkTypeMacro(CheckerBoard3DImageFilterController, CheckerBoardImageFilterControllerBase);

  CheckerBoard3DImageFilterController();
};

} //end of namespace free
#endif

---