otbNCCRegistrationFilter.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbNCCRegistrationFilter_hxx
#define otbNCCRegistrationFilter_hxx
#include "otbNCCRegistrationFilter.h"
 
namespace otb
{
 
/*
 * Default constructor
 */
template <class TFixedImage, class TMovingImage, class TDisplacementField>
NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::NCCRegistrationFilter()
{
 
  typename NCCRegistrationFunctionType::Pointer drfp;
  drfp = NCCRegistrationFunctionType::New();
 
  drfp->SetDisplacementField(this->GetDisplacementField());
 
  this->SetDifferenceFunction(static_cast<FiniteDifferenceFunctionType*>(drfp.GetPointer()));
}
 
template <class TFixedImage, class TMovingImage, class TDisplacementField>
void NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::PrintSelf(std::ostream& os, itk::Indent indent) const
{
  Superclass::PrintSelf(os, indent);
  os << indent << "NCC Radius: " << this->GetNCCRadius() << std::endl;
}
 
/*
 * Set the function state values before each iteration
 */
template <class TFixedImage, class TMovingImage, class TDisplacementField>
void NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::InitializeIteration()
{
 
  // call the superclass  implementation
  Superclass::InitializeIteration();
 
  // set the gradient selection flag
  NCCRegistrationFunctionType* drfp = dynamic_cast<NCCRegistrationFunctionType*>(this->GetDifferenceFunction().GetPointer());
 
  if (!drfp)
  {
    itkExceptionMacro(<< "Could not cast difference function to NCCRegistrationFunction");
  }
 
  /*
   * Smooth the displacement field
 
  if ( this->GetSmoothDisplacementField() )
    {
    this->SmoothDisplacementField();
    }
   */
}
 
/*
 * Get the metric value from the difference function
 */
template <class TFixedImage, class TMovingImage, class TDisplacementField>
double NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::GetMetric() const
{
 
  NCCRegistrationFunctionType* drfp = dynamic_cast<NCCRegistrationFunctionType*>(this->GetDifferenceFunction().GetPointer());
 
  if (!drfp)
  {
    itkExceptionMacro(<< "Could not cast difference function to NCCRegistrationFunction");
  }
 
  return drfp->GetEnergy();
}
 
/*
 *
 */
template <class TFixedImage, class TMovingImage, class TDisplacementField>
typename NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::RadiusType
NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::GetNCCRadius() const
{
 
  NCCRegistrationFunctionType* drfp = dynamic_cast<NCCRegistrationFunctionType*>(this->GetDifferenceFunction().GetPointer());
 
  if (!drfp)
  {
    itkExceptionMacro(<< "Could not cast difference function to NCCRegistrationFunction");
  }
 
  return drfp->GetRadius();
}
 
/*
 *
 */
template <class TFixedImage, class TMovingImage, class TDisplacementField>
void NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::SetNCCRadius(RadiusType radius)
{
 
  NCCRegistrationFunctionType* drfp = dynamic_cast<NCCRegistrationFunctionType*>(this->GetDifferenceFunction().GetPointer());
 
  if (!drfp)
  {
    itkExceptionMacro(<< "Could not cast difference function to NCCRegistrationFunction");
  }
 
  drfp->SetRadius(radius);
 
  this->Modified();
}
 
template <class TFixedImage, class TMovingImage, class TDisplacementField>
void NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::GenerateInputRequestedRegion()
{
  // get pointers to the input and output
  typename Superclass::FixedImagePointer  fixedPtr  = const_cast<TFixedImage*>(this->GetFixedImage());
  typename Superclass::MovingImagePointer movingPtr = const_cast<TMovingImage*>(this->GetMovingImage());
  typename TDisplacementField::Pointer    outputPtr = this->GetOutput();
 
  if (!fixedPtr || !movingPtr || !outputPtr)
  {
    return;
  }
 
  // get a copy of the input requested region (should equal the output
  // requested region)
  typename TDisplacementField::RegionType requestedRegion;
  requestedRegion = outputPtr->GetRequestedRegion();
 
  // pad the input requested region by the operator radius
  requestedRegion.PadByRadius(this->GetNCCRadius());
 
  // crop the input requested region at the input's largest possible region
  if (requestedRegion.Crop(fixedPtr->GetLargestPossibleRegion()))
  {
    if (requestedRegion.Crop(movingPtr->GetLargestPossibleRegion()))
    {
      fixedPtr->SetRequestedRegion(requestedRegion);
      movingPtr->SetRequestedRegion(requestedRegion);
      return;
    }
    else
    {
      // Couldn't crop the region (requested region is outside the largest
      // possible region).  Throw an exception.
 
      // store what we tried to request (prior to trying to crop)
      movingPtr->SetRequestedRegion(requestedRegion);
 
      // build an exception
      itk::InvalidRequestedRegionError e(__FILE__, __LINE__);
      e.SetLocation(ITK_LOCATION);
      e.SetDescription("Requested region is (at least partially) outside the largest possible region of the moving image.");
      e.SetDataObject(movingPtr);
      throw e;
    }
  }
  else
  {
    // Couldn't crop the region (requested region is outside the largest
    // possible region).  Throw an exception.
 
    // store what we tried to request (prior to trying to crop)
    fixedPtr->SetRequestedRegion(requestedRegion);
 
    // build an exception
    itk::InvalidRequestedRegionError e(__FILE__, __LINE__);
    e.SetLocation(ITK_LOCATION);
    e.SetDescription("Requested region is (at least partially) outside the largest possible region of the fixed image.");
    e.SetDataObject(fixedPtr);
    throw e;
  }
}
 
/*
 * Get the metric value from the difference function
 */
template <class TFixedImage, class TMovingImage, class TDisplacementField>
void NCCRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>::ApplyUpdate(TimeStepType dt)
{
  // If we smooth the update buffer before applying it, then the are
  // approximating a viscuous problem as opposed to an elastic problem
  /*  if ( this->GetSmoothUpdateField() )
      {
      this->SmoothUpdateField();
      }
    */
  this->Superclass::ApplyUpdate(dt);
 
  NCCRegistrationFunctionType* drfp = dynamic_cast<NCCRegistrationFunctionType*>(this->GetDifferenceFunction().GetPointer());
 
  if (!drfp)
  {
    itkExceptionMacro(<< "Could not cast difference function to NCCRegistrationFunction");
  }
 
  //  this->SetRMSChange( drfp->GetRMSChange() );
}
 
} // end namespace otb
 
#endif