Ccorrelation_factory.h

Go to the documentation of this file.

/**********************************************************************
 * Copyright (C) 2012, The YaDICs Project Developers. 
 * See the COPYRIGHT file at the top-level directory of this distribution ./COPYRIGHT.
 * See ./COPYING file for copying and redistribution conditions.
 * 
 * This file is part of YaDICs.
 * YaDICs 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.
 * 
 * YaDICs 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 YaDICs.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Information about how to use the software are provided at http://yadic.univ-lille1.fr/
 **********************************************************************/


#ifndef CCORRELATION_FACTORY
#define CCORRELATION_FACTORY



//-----------------------------------------------------------------------
#include "Ccorrelation.h"

  #include "Ccorrelation_opticalFlow.h"
    #include "Ccorrelation_opticalFlow_fem.h"
      #include "Ccorrelation_opticalFlow_fem_newton.h"
      #include "Ccorrelation_opticalFlow_fem_gradient.h"
      #include "Ccorrelation_opticalFlow_integrated.h"
        #include "Ccorrelation_opticalFlow_integrated_block.h"
    
  #include "Ccorrelation_intercor.h"
    #include "Ccorrelation_intercor_direct.h"
    #include "Ccorrelation_intercor_fftw.h"
      #include "Ccorrelation_intercor_fftw_phase.h" 
      #include "Ccorrelation_intercor_fft.h"
        #include "Ccorrelation_intercor_fft_phase.h" 
//-----------------------------------------------------------------------   

template<typename T, typename Timg> 
class Ccorrelation_factory
{
  
  public:
    
  //attributes
  std::vector<std::string> m_infos;
  std::string class_name, m_variable, m_type;
  CParameterNetCDF m_paramFile;
  
  bool m_verbose;
  const char* m_paramPath;
  
  
 
  Ccorrelation_factory(const std::string name)
  {//constructor
 
    class_name = "Correlation : factory";
    
    m_variable = name;
    
    m_infos.push_back("IC_direct");
    m_infos.push_back("IC_fftw");
    m_infos.push_back("IC_fftw_phase");
    m_infos.push_back("IC_fft");
    m_infos.push_back("IC_fft_phase");
    m_infos.push_back("OFI");
    m_infos.push_back("OFIB");
    m_infos.push_back("OFFEM_newton");
    m_infos.push_back("OFFEM_gradient");
    
  }

  Ccorrelation<T,Timg>* create(const int &number)
  {//create from int
    
    Ccorrelation<T,Timg>* pCorrel;
    
    switch(number)
    {
      case 0: pCorrel = new Ccorrelation_intercor_direct<T,Timg>; break;
      case 1: pCorrel = new Ccorrelation_intercor_fftw<T,Timg>; break;
      case 2: pCorrel = new Ccorrelation_intercor_fftw_phase<T,Timg>; break;
      case 3: pCorrel = new Ccorrelation_intercor_fft<T,Timg>; break;
      case 4: pCorrel = new Ccorrelation_intercor_fft_phase<T,Timg>; break;
      case 5: pCorrel = new Ccorrelation_opticalFlow_integrated<T,Timg>; break;
      case 6: pCorrel = new Ccorrelation_opticalFlow_integrated_block<T,Timg>; break;
      case 7: pCorrel = new Ccorrelation_opticalFlow_fem_newton<T,Timg>; break;
      case 8: pCorrel = new Ccorrelation_opticalFlow_fem_gradient<T,Timg>; break;
      default:
      {
        std::cerr<<class_name<<" : "<<number<<" refers to an unknown or incompatible correlation class"<<std::flush;
        return NULL;
      }
    }
    
    if (m_verbose){printf("%s -> %s class loaded\n",class_name.c_str(), m_type.c_str());}
    
    pCorrel->m_verbose = m_verbose;// active or not the verbose mode
    pCorrel->m_correl_type = m_type;// string correl-type as member
    pCorrel->m_correl_name = m_variable;// string correl-name as member
    
    pCorrel->init(m_paramFile);//specific init
    
    return pCorrel;// return pointer to specific correlation method
    
  }
  
  Ccorrelation<T,Timg>* create(const std::string &type)
  {//create from string
    
    if(type==m_infos[0]) return create(0);
    else if(type==m_infos[1]) return create(1);
    else if(type==m_infos[2]) return create(2);
    else if(type==m_infos[3]) return create(3);
    else if(type==m_infos[4]) return create(4); 
    else if(type==m_infos[5]) return create(5); 
    else if(type==m_infos[6]) return create(6);
    else if(type==m_infos[7]) return create(7); 
    else if(type==m_infos[8]) return create(8); 
    else
    {
      std::cerr<<class_name<<" : "<<type<<" refers to an unknown or incompatible correlation class"<<std::flush;
      return NULL;
    }
    
  }
   
  Ccorrelation<T,Timg>* create(CParameterNetCDF &paramFile)
  {//create from CParameterNetCDF
    
    std::string method, m_corType;
    
    paramFile.loadAttribute("type",m_type, &m_variable);
    m_corType = m_type;
    
    if (m_type=="OFFEM")
    {
      paramFile.loadAttribute("method",method, &m_variable);
      m_corType = m_corType + "_" + method;
    }
    
    return create(m_corType);
    
  }
 
  Ccorrelation<T,Timg>* create(int argc, char *argv[])
  {//create from (argv,argc)

    commandLine(argc,argv);//read command line argument

    Ccorrelation<T,Timg> *pCorrel;// pointer toward a correlation class

    int error;

    if(m_paramPath!="true")
    {// parameter.nc location is provided

      NcFile file(m_paramPath,NcFile::ReadOnly);// open the file and keep the object in file variable

      if ( error = m_paramFile.setFile(&file) !=1 )
      {
        std::cerr<< "Error while loading"<<m_paramPath<<" parameter file"<<std::endl;
        return NULL;
      }

      pCorrel = create(m_paramFile);// associate pCorrel pointer to the appropriate type following parameter.nc file

      if (pCorrel == NULL){return NULL;}
   
      return pCorrel;
    
    }
    else
    {// m_paramPath = true
    
      std::cout<<" --correlator option : Command line\n";
      std::cout<<" --building!!\n";
      
      return NULL;
      
    }

    
  }
  
  
  
  //other methods
  void commandLine(int argc, char *argv[])
  {// get the comand line

    //set parameter file path
    m_paramPath = cimg_option("-p","./parameters.nc","parameter, mesh or true");
    //set verbose mode
    m_verbose = cimg_option("-v",false,0);
    
    if(m_verbose)
    {
      printf("Mode Verbose\n");
      printf("%s : %s\n",class_name.c_str(),m_paramPath);
    }

  }

  void stringSplit(std::string manyString, std::vector<std::string> value)
  {
    
    char *cstr,*ptr;
    char *split=(char*)(" ,;");
    
    cstr = new char [manyString.size()+1];
    strcpy(cstr,manyString.c_str());
    ptr=strtok(cstr,split);
    while (ptr!=NULL)
    {
      value.push_back(ptr);
      ptr=strtok(NULL,split);
    }
    delete[] cstr;
    
  }
  
  void info()
  {// print the whole set of available classes within the factory
    
    printf("\nclass %s\n",class_name.c_str());
    for (int i=0; i<m_infos.size(); i++)
    {
      
         printf("\t(%i) mode : %s\n",i,m_infos[i].c_str());
      
    }
    
  }
  
};

#endif