freSpatialRegionOfInterestImageFilterController.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: freSpatialRegionOfInterestImageFilterController.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 __freSpatialRegionOfInterestImageFilterController_h
#define __freSpatialRegionOfInterestImageFilterController_h

#include "freImageToImageFilterControllerBase.h"

#include "freSpatialRegionOfInterestImageFilter.h"
#include "itkEllipseSpatialObject.h"

namespace FREE
{
/*TODO add real spatial object support when got some time. right now it is alwas an ellipse*/

  freControllerIDMacro(SpatialRegionOfInterestImageFilterControllerBase, "SpatialRegionOfInterestImageFilterBase");
template <class TInputImage>
class SpatialRegionOfInterestImageFilterControllerBase : public ImageToImageFilterControllerBase< FREE::SpatialRegionOfInterestImageFilter<TInputImage, TInputImage> >
{
public:  
  typedef FREE::SpatialRegionOfInterestImageFilter<TInputImage, TInputImage> ComponentType;
  typedef ImageToImageFilterControllerBase<ComponentType> Superclass;
  typedef SpatialRegionOfInterestImageFilterControllerBase<TInputImage> Self;

  typedef typename ComponentType::Pointer ComponentPointer;
  typedef typename Superclass::GenericComponentType GenericComponentType;
  typedef typename Superclass::GenericComponentPointer GenericComponentPointer;
  typedef typename Superclass::GenericMediaPointer GenericMediaPointer;
  typedef TInputImage InputImage;

  DeclareParameterMacro(OutsideValue);
  DeclareParameterMacro(SpatialObject);
  DeclareParameterMacro(Origin);

  itkTypeMacro(SpatialRegionOfInterestImageFilterControllerBase, ImageToImageFilterControllerBase);

protected:
  SpatialRegionOfInterestImageFilterControllerBase()
  {
    //Profile settings
    this->UpdateControllerID(ControllerID::SpatialRegionOfInterestImageFilterControllerBase);
    this->m_Description = "Basis for FREE::SpatialRegionOfInterestImageFilter";
  };

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

    //Parameters
    profile.Parameters().AddParameter(cParam_OutsideValue,Parameter::PVTDouble,cParamDsc_OutsideValue,1,"0.0");
    profile.Parameters().AddParameter(cParam_SpatialObject,Parameter::PVTDouble,cParamDsc_SpatialObject,1,"30.0");
    profile.Parameters().AddParameter(cParam_Origin,Parameter::PVTDouble,cParamDsc_Origin,InputImage::ImageDimension,"0.0");
  };

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

    typedef itk::EllipseSpatialObject<InputImage::ImageDimension> SpatialObjectType;
    
          double dOutsideValue;
          double dSpatialObject;
          double dOrigin;
    
    typename ComponentType::SpatialObjectType::TransformType::OffsetType offset;

    try
    {
      SessionAccessor::GetParameterValue(pComponentCache,cParam_OutsideValue,dOutsideValue);
      SessionAccessor::GetParameterValue(pComponentCache,cParam_SpatialObject,dSpatialObject);
      for (unsigned int iIndex = 0; iIndex<InputImage::ImageDimension; iIndex++)
      {
        SessionAccessor::GetParameterValue(pComponentCache,cParam_Origin,dOrigin,iIndex);
        offset[iIndex] = dOrigin;
      }
    }
    catchAllNPassMacro("Error while retrieving parameter values.");

          pMainComponent->SetOutsideValue(dOutsideValue);
    
    typename SpatialObjectType::Pointer object = SpatialObjectType::New();
    object->SetRadius(dSpatialObject);
    object->GetObjectToParentTransform()->SetOffset(offset);
    object->ComputeObjectToWorldTransform();
    pMainComponent->SetSpatialRegionOfInterest(object);
  };

};

template <class TInputImage>
const char* const SpatialRegionOfInterestImageFilterControllerBase<TInputImage> :: cParam_OutsideValue = "OutsideValue";
template <class TInputImage>
const char* const SpatialRegionOfInterestImageFilterControllerBase<TInputImage> :: cParamDsc_OutsideValue = "Value for all pixels that are within the bounding box of the spatial object, but outside the object itself";
template <class TInputImage>
const char* const SpatialRegionOfInterestImageFilterControllerBase<TInputImage> :: cParam_SpatialObject = "SpatialObject";
template <class TInputImage>
const char* const SpatialRegionOfInterestImageFilterControllerBase<TInputImage> :: cParamDsc_SpatialObject = "";
template <class TInputImage>
const char* const SpatialRegionOfInterestImageFilterControllerBase<TInputImage> :: cParam_Origin = "Origin";
template <class TInputImage>
const char* const SpatialRegionOfInterestImageFilterControllerBase<TInputImage> :: cParamDsc_Origin = "";

freControllerIDMacro(SpatialRegionOfInterest2DImageFilterController, "Spatial ROI 2D Image Filter");
class SpatialRegionOfInterest2DImageFilterController : public SpatialRegionOfInterestImageFilterControllerBase< ImageTypes<2>::InternalImageType >
{
public:  
  typedef SpatialRegionOfInterestImageFilterControllerBase< ImageTypes<2>::InternalImageType > Superclass;
  typedef SpatialRegionOfInterest2DImageFilterController Self;

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

  itkTypeMacro(SpatialRegionOfInterest2DImageFilterController, SpatialRegionOfInterestImageFilterControllerBase);

  SpatialRegionOfInterest2DImageFilterController();
};

freControllerIDMacro(SpatialRegionOfInterest3DImageFilterController, "Spatial ROI 3D Image Filter");
class SpatialRegionOfInterest3DImageFilterController : public SpatialRegionOfInterestImageFilterControllerBase< ImageTypes<3>::InternalImageType >
{
public:  
  typedef SpatialRegionOfInterestImageFilterControllerBase< ImageTypes<3>::InternalImageType > Superclass;
  typedef SpatialRegionOfInterest3DImageFilterController Self;

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

  itkTypeMacro(SpatialRegionOfInterest3DImageFilterController, SpatialRegionOfInterestImageFilterControllerBase);

  SpatialRegionOfInterest3DImageFilterController();
};

} //end of namespace free

#endif

---