itkLevelSetEquationTermBase.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 __itkLevelSetEquationTermBase_h
#define __itkLevelSetEquationTermBase_h

#include "itkObject.h"
#include "itkHeavisideStepFunctionBase.h"
#include "itksys/hash_set.hxx"

namespace itk
{
template< class TInputImage, // Input image
          class TLevelSetContainer >
class LevelSetEquationTermBase : public Object
{
public:
  typedef LevelSetEquationTermBase   Self;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
  typedef Object                     Superclass;

  itkTypeMacro( LevelSetEquationTermBase, Object );

  typedef TInputImage                                     InputImageType;
  typedef typename InputImageType::Pointer                InputImagePointer;
  typedef typename InputImageType::PixelType              InputPixelType;
  typedef typename NumericTraits< InputPixelType >::RealType
                                                          InputPixelRealType;

  typedef TLevelSetContainer                              LevelSetContainerType;
  typedef typename LevelSetContainerType::LevelSetIdentifierType
                                                          LevelSetIdentifierType;
  typedef typename LevelSetContainerType::Pointer         LevelSetContainerPointer;
  typedef typename LevelSetContainerType::LevelSetType    LevelSetType;
  typedef typename LevelSetContainerType::LevelSetPointer LevelSetPointer;
  typedef typename LevelSetContainerType::OutputType      LevelSetOutputPixelType;
  typedef typename LevelSetContainerType::OutputRealType  LevelSetOutputRealType;
  typedef typename LevelSetContainerType::InputIndexType  LevelSetInputIndexType;
  typedef typename LevelSetContainerType::GradientType    LevelSetGradientType;
  typedef typename LevelSetContainerType::HessianType     LevelSetHessianType;
  typedef typename LevelSetContainerType::LevelSetDataType
                                                          LevelSetDataType;

  typedef typename LevelSetContainerType::DomainMapImageFilterType  DomainMapImageFilterType;
  typedef typename LevelSetContainerType::CacheImageType            CacheImageType;

  typedef HeavisideStepFunctionBase< LevelSetOutputRealType,
                                     LevelSetOutputRealType >
                                          HeavisideType;
//  typedef typename HeavisideType::Pointer HeavisidePointer;
  typedef typename HeavisideType::ConstPointer HeavisideConstPointer;

  itkSetObjectMacro( Input, InputImageType );
  itkGetObjectMacro( Input, InputImageType );

  itkSetMacro( Coefficient, LevelSetOutputRealType );
  itkGetMacro( Coefficient, LevelSetOutputRealType );

  itkSetMacro( CurrentLevelSetId, LevelSetIdentifierType );
  itkGetMacro( CurrentLevelSetId, LevelSetIdentifierType );

  itkGetObjectMacro( CurrentLevelSetPointer, LevelSetType );

  virtual void SetLevelSetContainer( LevelSetContainerType*ptr );
  itkGetObjectMacro( LevelSetContainer, LevelSetContainerType );

  virtual LevelSetOutputRealType Evaluate( const LevelSetInputIndexType& iP );

  virtual LevelSetOutputRealType Evaluate( const LevelSetInputIndexType& iP,
                                           const LevelSetDataType& iData );

  virtual void Initialize( const LevelSetInputIndexType& iP ) = 0;

  virtual void InitializeParameters() = 0;

  virtual void UpdatePixel( const LevelSetInputIndexType& iP,
                           const LevelSetOutputRealType & oldValue,
                           const LevelSetOutputRealType & newValue ) = 0;

  itkGetConstMacro( CFLContribution, LevelSetOutputRealType );

  itkSetStringMacro( TermName );
  itkGetStringMacro( TermName );

  virtual void Update() = 0;

  typedef itksys::hash_set< std::string > RequiredDataType;

  const RequiredDataType & GetRequiredData() const;

protected:
  LevelSetEquationTermBase();

  virtual ~LevelSetEquationTermBase();

  void SetUp();

  virtual LevelSetOutputRealType Value( const LevelSetInputIndexType& iP ) = 0;

  virtual LevelSetOutputRealType Value( const LevelSetInputIndexType& iP,
                                        const LevelSetDataType& iData ) = 0;

  InputImagePointer        m_Input;

  LevelSetContainerPointer m_LevelSetContainer;

  LevelSetIdentifierType   m_CurrentLevelSetId;

  LevelSetPointer          m_CurrentLevelSetPointer;

  LevelSetOutputRealType   m_Coefficient;

  LevelSetOutputRealType   m_CFLContribution;

  HeavisideConstPointer         m_Heaviside;

  std::string               m_TermName;

  RequiredDataType          m_RequiredData;

private:
  LevelSetEquationTermBase( const Self& ); // purposely not implemented
  void operator = ( const Self& ); // purposely not implemented
};
}

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

#endif