Cpeak.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 CPEAK
#define CPEAK

#include "CImg_math.h"
#include "Cpeak_factory.h"

template<typename T> 
class Cpeak 
{
  
  public:
    
    std::string class_name;
    T m_flag, m_mag; //peak flag, and peak magnitude
    std::vector<T> m_pos;//peak positions
    int _3D;//if 3D
    
    bool m_verbose;
    
     
    Cpeak(): m_flag(0), m_mag(0)
    {// constructor
    
      class_name = "Cpeak";
      m_pos.clear();
      
    }

    virtual void exec(CImg<T> &img)
    {// exec
  
      set_peakDim(img);// check for active spatial dimensions

      peak_detection(img);// detect peak position function of the method used
  
      peak_accuracy(img);// peak form accuracy compared to sub_pix peak modeling (flag)

      peak_delete(img);// only for multi peak detection

      set_origin(img);// only when peak image come from fft since the origin is shifted
 
    }// method exec
    
    virtual void peak_detection(CImg<T> &img) = 0;
    
    void set_peakDim(CImg<T> &img)
    {// set_peakDim
      
      int dim(2);
      m_pos.clear();
      
      //check for active dimensions
      if (!img.is_sameZ(1)){dim++;_3D = 1;}
      
      for (int i=0; i<dim; i++)
      {
        m_pos.push_back(0);
      }
      
      
    }
    
    virtual void peak_accuracy(CImg<T> &img)
    {
      m_flag = 0;
      
    } 
  
    virtual void peak_delete(CImg<T> &img)
    {
      float sig(15);// patch diameter
      T depth_0, depth_1;

      if (_3D){depth_0 = m_pos[2]-sig; depth_1 = m_pos[2]+sig;}else{depth_0 = 0; depth_1 = 0;}
      img.draw_rectangle(m_pos[0]-sig,m_pos[1]-sig,depth_0,0,m_pos[0]+sig,m_pos[1]+sig,depth_1,0,0,1);
      //(x0,y0,z0,c0, x1,y1,z1,c1, value, opacity)
      
    } 
       
    void set_origin(CImg<T> &img)
    {// set_origin

      //warning peak location detection is done with the zero origin centered within the image, thus the effective location must found throw:
      
      m_pos[0] = img.width()/2-m_pos[0];
      m_pos[1] = img.height()/2-m_pos[1];
      if (_3D){m_pos[2] = img.depth()/2-m_pos[2];}
      
      #ifdef cimg_use_fftw3 //FFtw flip image origin
        for (int i=0; i<m_pos.size(); i++){m_pos[i] = -m_pos[i];} 
      #endif
      
    }
      
    std::vector<T> content()
    {// content
      
      std::vector<T> stats;
      stats.clear();

      stats.push_back(m_flag);// flag
      stats.push_back(m_mag);// magnitude of peak for snr calcul
      
      for (int i=0; i<m_pos.size(); i++){stats.push_back(m_pos[i]);}//peak location
      
      return stats;
      
    }
    
};

#endif