itkOrthogonalSwath2DPathFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.txt
 *
 *  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 itkOrthogonalSwath2DPathFilter_h
#define itkOrthogonalSwath2DPathFilter_h

#include "itkPathAndImageToPathFilter.h"
#include "itkOrthogonallyCorrected2DParametricPath.h"

namespace itk
{
template< typename TFourierSeriesPath, typename TSwathMeritImage >
class OrthogonalSwath2DPathFilter:public
  PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage,
                            OrthogonallyCorrected2DParametricPath >
{
public:
  typedef OrthogonalSwath2DPathFilter Self;
  typedef PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage,
                                    OrthogonallyCorrected2DParametricPath > Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(OrthogonalSwath2DPathFilter, PathAndImageToPathFilter);

  typedef TFourierSeriesPath                InputPathType;
  typedef typename InputPathType::Pointer   InputPathPointer;
  typedef typename InputPathType::InputType InputPathInputType;

  typedef TSwathMeritImage                 ImageType;
  typedef typename ImageType::ConstPointer ImageConstPointer;

  typedef OrthogonallyCorrected2DParametricPath OutputPathType;
  typedef typename OutputPathType::Pointer      OutputPathPointer;
  typedef typename OutputPathType::InputType    OutputPathInputType;
  typedef typename OutputPathType::OrthogonalCorrectionTableType
  OrthogonalCorrectionTableType;
  typedef typename OutputPathType::OrthogonalCorrectionTablePointer
  OrthogonalCorrectionTablePointer;

  typedef typename InputPathType::IndexType  IndexType;
  typedef typename InputPathType::OffsetType OffsetType;
  typedef typename ImageType::SizeType       SizeType;

protected:
  OrthogonalSwath2DPathFilter();
  virtual ~OrthogonalSwath2DPathFilter();
  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  void GenerateData(void) ITK_OVERRIDE;

private:
  OrthogonalSwath2DPathFilter(const Self &) ITK_DELETE_FUNCTION;
  void operator=(const Self &) ITK_DELETE_FUNCTION;

  // Find the "L" for the maximum merit over the range L-1 to L+1 at F & x.
  // This value is both returned and stored in m_StepValues.
  // The merits for F & x at L-1 to L+1 must have already been calculated.
  unsigned int FindAndStoreBestErrorStep(unsigned int x, unsigned int F,
                                         unsigned int L);

  // m_StepValues & m_MeritValues are stored as datatype[x][F][L] which requres
  // cols*rows*rows bytes of storage where rows and cols are the dimensions of
  // the processed image.
  //
  // This ordering of elements is most efficient when L is incremented in the
  // inner-most loop and x is incremented in the outer-most loop.
  //
  // m_StepValues & m_MeritValues should always be accessed using the
  // StepValue()
  // and MeritValue() access functions.  StepValue() and MeritValue() can each
  // be
  // used on both the left and right hand of assignments for reads & writes, ex:
  // StepValue(1,1,1) = 2+MeritValue(0,0,3);
  inline int & StepValue(int f, int l, int x)
  {
    int rows = m_SwathSize[1];

    return m_StepValues[( x * rows * rows ) + ( f * rows ) + ( l )];
  }

  inline double & MeritValue(int f, int l, int x)
  {
    int rows = m_SwathSize[1];

    return m_MeritValues[( x * rows * rows ) + ( f * rows ) + ( l )];
  }

  int *   m_StepValues; // best y=error coordinate @ x of image for (0,F) ->
                        // (x+1,L)
  double *m_MeritValues;

  int *                            m_OptimumStepsValues;  // best step (e value)
                                                          // sequence for a
                                                          // closed path
  OrthogonalCorrectionTablePointer m_FinalOffsetValues;

  SizeType m_SwathSize;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkOrthogonalSwath2DPathFilter.hxx"
#endif

#endif