elxConfiguration.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 __elxConfiguration_H__
#define __elxConfiguration_H__
 
#include "itkObject.h"
#include "elxBaseComponent.h"
 
#include "itkParameterFileParser.h"
#include "itkParameterMapInterface.h"
#include <map>
#include "xoutmain.h"
 
namespace elastix
{
 
class Configuration : public itk::Object, public BaseComponent
{
public:
 
  typedef Configuration                   Self;
  typedef itk::Object                     Superclass1;
  typedef BaseComponent                   Superclass2;
  typedef itk::SmartPointer< Self >       Pointer;
  typedef itk::SmartPointer< const Self > ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( Configuration, itk::Object );
 
  typedef std::map< std::string, std::string >   CommandLineArgumentMapType;
  typedef CommandLineArgumentMapType::value_type CommandLineEntryType;
 
  typedef itk::ParameterFileParser           ParameterFileParserType;
  typedef ParameterFileParserType::Pointer   ParameterFileParserPointer;
  typedef itk::ParameterMapInterface         ParameterMapInterfaceType;
  typedef ParameterMapInterfaceType::Pointer ParameterMapInterfacePointer;
 
  std::string GetCommandLineArgument( const std::string & key ) const;
 
  void SetCommandLineArgument( const std::string & key, const std::string & value );
 
  itkGetStringMacro( ParameterFileName );
  itkSetStringMacro( ParameterFileName );
 
  virtual int Initialize( const CommandLineArgumentMapType & _arg );
 
  virtual int Initialize( const CommandLineArgumentMapType & _arg,
    const ParameterFileParserType::ParameterMapType & inputMap );
 
  virtual bool IsInitialized( void ) const; //to elxconfigurationbase
 
  itkSetMacro( ElastixLevel, unsigned int );
  itkGetConstMacro( ElastixLevel, unsigned int );
 
  itkSetMacro( TotalNumberOfElastixLevels, unsigned int );
  itkGetConstMacro( TotalNumberOfElastixLevels, unsigned int );
 
  /***/
  virtual bool GetPrintErrorMessages( void )
  {
    return this->m_ParameterMapInterface->GetPrintErrorMessages();
  }
 
 
  int BeforeAll( void ) override;
 
  virtual int BeforeAllTransformix( void );
 
  std::size_t CountNumberOfParameterEntries(
    const std::string & parameterName ) const
  {
    return this->m_ParameterMapInterface->CountNumberOfParameterEntries(
      parameterName );
  }
 
 
  template< class T >
  bool ReadParameter( T & parameterValue, const std::string & parameterName,
    const unsigned int entry_nr, const bool printThisErrorMessage )
  {
    std::string errorMessage = "";
    bool        found        = this->m_ParameterMapInterface->ReadParameter(
      parameterValue, parameterName, entry_nr,
      printThisErrorMessage, errorMessage );
    if( errorMessage != "" )
    {
      xl::xout[ "error" ] << errorMessage;
    }
 
    return found;
  }
 
 
  template< class T >
  bool ReadParameter( T & parameterValue, const std::string & parameterName,
    const unsigned int entry_nr )
  {
    std::string errorMessage = "";
    bool        found        = this->m_ParameterMapInterface->ReadParameter(
      parameterValue, parameterName, entry_nr, errorMessage );
    if( errorMessage != "" )
    {
      xl::xout[ "error" ] << errorMessage;
    }
 
    return found;
  }
 
 
  template< class T >
  bool ReadParameter( T & parameterValue, const std::string & parameterName,
    const std::string & prefix,
    const unsigned int entry_nr, const int default_entry_nr,
    const bool printThisErrorMessage ) const
  {
    std::string errorMessage = "";
    bool        found        = this->m_ParameterMapInterface->ReadParameter(
      parameterValue, parameterName, prefix, entry_nr, default_entry_nr,
      printThisErrorMessage, errorMessage );
    if( errorMessage != "" )
    {
      xl::xout[ "error" ] << errorMessage;
    }
 
    return found;
  }
 
 
  template< class T >
  bool ReadParameter( T & parameterValue, const std::string & parameterName,
    const std::string & prefix,
    const unsigned int entry_nr, const int default_entry_nr ) const
  {
    std::string errorMessage = "";
    bool        found        = this->m_ParameterMapInterface->ReadParameter(
      parameterValue, parameterName, prefix, entry_nr, default_entry_nr,
      errorMessage );
    if( errorMessage != "" )
    {
      xl::xout[ "error" ] << errorMessage;
    }
 
    return found;
  }
 
 
  template< class T >
  bool ReadParameter( std::vector< T > & parameterValues,
    const std::string & parameterName,
    const unsigned int entry_nr_start,
    const unsigned int entry_nr_end,
    const bool printThisErrorMessage ) const
  {
    std::string errorMessage = "";
    bool        found        = this->m_ParameterMapInterface->ReadParameter(
      parameterValues, parameterName, entry_nr_start, entry_nr_end,
      printThisErrorMessage, errorMessage );
    if( errorMessage != "" )
    {
      xl::xout[ "error" ] << errorMessage;
    }
 
    return found;
  }
 
 
protected:
 
  Configuration();
  ~Configuration() override {}
 
  virtual void PrintParameterFile( void ) const;
 
private:
 
  Configuration( const Self & );    // purposely not implemented
  void operator=( const Self & );   // purposely not implemented
 
  CommandLineArgumentMapType   m_CommandLineArgumentMap;
  std::string                  m_ParameterFileName;
  ParameterFileParserPointer   m_ParameterFileParser;
  ParameterMapInterfacePointer m_ParameterMapInterface;
 
  bool         m_IsInitialized;
  unsigned int m_ElastixLevel;
  unsigned int m_TotalNumberOfElastixLevels;
 
};
 
} // end namespace elastix
 
#endif // end #ifndef __elxConfiguration_H__