Cfield_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 CFIELD_FACTORY
#define CFIELD_FACTORY



//-----------------------------------------------------------------------
#include "Cfield.h"
  #include "Cfield_intercor.h"
  #include "Cfield_opticalFlow.h"
    #include "Cfield_opticalFlow_fem.h"
    #include "Cfield_opticalFlow_integrated.h"
      #include "Cfield_opticalFlow_integrated_block.h"
//-----------------------------------------------------------------------   

template<typename T,typename Timg> 
class Cfield_factory
{
  
  public:
    
  //attributes
  std::vector<std::string> m_infos;
  std::string class_name, m_type, m_variable;
  CParameterNetCDF m_paramFile;
  
  const char* m_paramPath;
  bool m_verbose;
  
  
  Cfield_factory(const std::string name)
  {//constructor
 
    class_name = "Field : factory";
    
    m_variable = name;
    
    m_infos.clear();
    m_infos.push_back("field_IC");
    m_infos.push_back("field_OFI");
    m_infos.push_back("field_OFIB");
    m_infos.push_back("field_OFFEM");
    
  }

  Cfield<T,Timg>* create(const int &number)
  {//create from int
    
    Cfield<T,Timg>* pField;
    
    switch(number)
    {
      case 0: pField = new Cfield_intercor<T,Timg>; break;
      case 1: pField = new Cfield_opticalFlow_integrated<T,Timg>; break;
      case 2: pField = new Cfield_opticalFlow_integrated_block<T,Timg>; break;
      case 3: pField = new Cfield_opticalFlow_fem<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());}
    
    pField->m_paramPath = m_paramPath;
    pField->m_verbose = m_verbose;
    pField->m_type = m_type;
    pField->m_name = m_variable;
    
    pField->init(m_paramFile);
    
    return pField;
    
  }
  
  Cfield<T,Timg>* create(const std::string &type)
  {//create from string
  
    m_type = type;
    
    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{std::cerr<<class_name<<" : "<<type<<" refers to an unknown or incompatible correlation class"<<std::flush;return NULL;}
    
  }
   
  Cfield<T,Timg>* create(CParameterNetCDF &paramFile)
  {//create from CParameterNetCDF
  
    m_paramFile = paramFile;

    std::string type_name;
    int var(0);
    
    paramFile.loadVar(var,&m_variable);
    paramFile.loadAttribute("type", type_name);
    
    if(m_verbose){printf("correlation type : %s\n", type_name.c_str());}
    
    if (type_name.compare(0,2,"IC") == 0)
    {m_type = "field_IC";}
    else if(type_name.compare(0,4,"OFIB") == 0)
    {m_type = "field_OFIB";}
    else if(type_name.compare(0,3,"OFI") == 0)
    {m_type = "field_OFI";}
    else if(type_name.compare(0,5,"OFFEM") == 0)
    {m_type = "field_OFFEM";}
    else
    {std::cerr<<class_name<<" : "<<type_name<<" is unknown"<<std::flush;return NULL;}
    
    if(m_verbose){printf("field type : %s\n", m_type.c_str());}
    
    return create(m_type);
    
  }
 
  Cfield<T,Timg>* create(int argc, char *argv[])
  {//create from (argv,argc)

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

    Cfield<T,Timg> *pField;// 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

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

      pField = create(m_paramFile);// associate pCorrel pointer to the appropriate type following parameter.nc file
      if (pField == NULL){std::cerr<< "Error while loading"<<pField<<" pointer"<<std::endl;return NULL;}

      return pField;
    
    }
    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 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