cmtkMultiChannelRegistrationFunctionalBase.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2010 Torsten Rohlfing
//
//  Copyright 2004-2010 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2398 $
//
//  $LastChangedDate: 2010-10-05 14:54:37 -0700 (Tue, 05 Oct 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkMultiChannelRegistrationFunctionalBase_h_included_
#define __cmtkMultiChannelRegistrationFunctionalBase_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkFunctional.h>

#include <Base/cmtkUniformVolume.h>
#include <System/cmtkSmartPtr.h>

#include <Base/cmtkUniformVolumeInterpolator.h>
#include <Base/cmtkLinearInterpolator.h>

#include <vector>

namespace
cmtk
{


class MultiChannelRegistrationFunctionalBase :
  public Functional
{
public:
  typedef MultiChannelRegistrationFunctionalBase Self;
  
  typedef SmartPointer<Self> SmartPtr;

  typedef Functional Superclass;

  MultiChannelRegistrationFunctionalBase() : m_NumberOfChannels( 0 ), m_NormalizedMI( false ) {}
  
  virtual ~MultiChannelRegistrationFunctionalBase()
  {
    this->ClearAllChannels();
  }

  void SetNormalizedMI( const bool nmi = true )
  {
    this->m_NormalizedMI = nmi;
  }

  virtual void ClearAllChannels();

  virtual void AddReferenceChannel( UniformVolume::SmartPtr& channel );

  template <class ForwardIterator>
  void AddReferenceChannels( ForwardIterator first, ForwardIterator last )
  {
    while ( first != last )
      {
      this->AddReferenceChannel( *first );
      ++first;
      }
  }

  size_t GetNumberOfReferenceChannels() const { return this->m_ReferenceChannels.size(); }

  UniformVolume::SmartPtr& GetReferenceChannel( const size_t idx ) { return this->m_ReferenceChannels[idx]; }

  const UniformVolume* GetReferenceChannel( const size_t idx ) const { return this->m_ReferenceChannels[idx]; }

  virtual void AddFloatingChannel( UniformVolume::SmartPtr& channel );

  template <class ForwardIterator>
  void AddFloatingChannels( ForwardIterator first, ForwardIterator last )
  {
    while ( first != last )
      {
      this->AddFloatingChannel( *first );
      ++first;
      }
  }

  size_t GetNumberOfFloatingChannels() const { return this->m_FloatingChannels.size(); }

  UniformVolume::SmartPtr& GetFloatingChannel( const size_t idx ) { return this->m_FloatingChannels[idx]; }

  const UniformVolume* GetFloatingChannel( const size_t idx ) const { return this->m_FloatingChannels[idx]; }

  std::vector<UniformVolume::SmartPtr> m_ReferenceChannels;

  std::vector<UniformVolume::SmartPtr> m_FloatingChannels;

protected:
  size_t m_NumberOfChannels;

  DataGrid::IndexType m_ReferenceDims;

  UniformVolume::CoordinateVectorType m_ReferenceSize;

  UniformVolume::CoordinateVectorType m_ReferenceInvDelta;

  DataGrid::RegionType m_ReferenceCropRegion;
  
  DataGrid::IndexType m_FloatingDims;

  UniformVolume::CoordinateVectorType m_FloatingSize;

  UniformVolume::CoordinateVectorType m_FloatingInverseDelta;

  UniformVolume::CoordinateRegionType m_FloatingCropRegion;
 
  virtual void NewReferenceChannelGeometry() {}

protected:
  bool m_NormalizedMI;

private:
  void VerifyImageSize( const UniformVolume* imgA, const UniformVolume* imgB );
};


} // namespace cmtk

#endif // #ifndef __cmtkMultiChannelRegistrationFunctionalBase_h_included_