Cimage_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 CIMAGE_FACTORY
#define CIMAGE_FACTORY



//-----------------------------------------------------------------------
#define cimg_plugin  "plugins/add_fileformat.h"
#define cimg_use_netcdf
#ifdef cimg_use_netcdf
  #include      "../NetCDF.Tool/struct_parameter_NetCDF.h"
  #define       cimg_plugin2 "plugins/netcdf_file_format4CImg2.h"
  #define       cimglist_plugin2 "plugins/netcdf_file_format4CImgList2.h"
  #include      "../CImg.Tool/CImg_NetCDF.h"
#endif

#define NO_USB

#include "Cimage.h"
  #include "Cimage_file.h"
  #ifndef NO_USB
  #include "Cimage_grab.h" 
  #endif
//-----------------------------------------------------------------------   


template<typename Timg> 
class Cimage_factory
{
  
  public:
    
  //attributes
  std::vector<std::string> m_infos;
  std::string class_name, m_variable, m_type;
  std::vector<std::string> m_element;
  CParameterNetCDF m_paramFile;
  
  const char* m_paramPath;
  bool m_verbose;
  
  
  Cimage_factory(const std::string name)
  {//constructor
 
    class_name = "Image : factory";
    
    m_variable = name;
    
    m_infos.push_back("File");
    #ifndef NO_USB
    m_infos.push_back("Grab");
    #endif
    
  }
  
  Cimage<Timg>* create(const int &number)
  {//create from int
    
    Cimage<Timg>* pImage;
    
    switch(number)
    {
      case 0: pImage = new Cimage_file<Timg>; break;
      #ifndef NO_USB
      case 1: pImage = new Cimage_grab<Timg>; break;
      #endif
      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());}
    
    pImage->m_verbose = m_verbose;// active or not the verbose mode
    pImage->m_paramPath = m_paramPath;// string correl-name as member
    pImage->m_type = m_type;// string correl-type as member
    pImage->m_name = m_variable;// string correl-name as member
    pImage->init(m_paramFile);//specific init
    
    return pImage;// return pointer to specific correlation method
    
  }
  
  Cimage<Timg>* create(const std::string &type)
  {//create from string
    
    if(type==m_infos[0]) return create(0);
    #ifndef NO_USB
    else if(type==m_infos[1]) return create(1);
    #endif
    else
    {
      std::cerr<<class_name<<" : "<<type<<" refers to an unknown or incompatible correlation class"<<std::flush;
      return NULL;
    }
    
  }
   
  Cimage<Timg>* create(CParameterNetCDF &paramFile)
  {//create from CParameterNetCDF
    
    //variable and attribute name
    std::string attribute_name("type");
    int error = paramFile.loadAttribute(attribute_name,m_type, &m_variable);
    
    return create(m_type);
    
  }
 
  Cimage<Timg>* create(int argc, char *argv[])
  {//create from (argv,argc)

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

    Cimage<Timg> *pImage;// pointer toward a image 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;
      }

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

      if (pImage == NULL){return NULL;}
   
      return pImage;
    
    }
    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