pdsdic2d.h

/*
 * pdsdic2d.h
 * 
 * Copyright 2018 Fernando Pujaico Rivera <fernando.pujaico.rivera@gmail.com>
 * 
 * This program 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 2 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 * 
 */

#ifndef __PDSDIC2D_H__
#define __PDSDIC2D_H__

#ifdef __cplusplus
extern "C" {
#endif 

#include <stdio.h>
#include <stdlib.h>
#include <pds/pdsra.h>

#ifndef PDS_MIN

    #define PDS_MIN(a,b) \
       ({ typeof (a) _a = (a); \
           typeof (b) _b = (b); \
         (_a < _b) ? _a : _b; })

#endif

#ifndef PDS_DIC2D_NO_MOVED_THRESHOLD

        #define PDS_DIC2D_NO_MOVED_THRESHOLD 0.99
#endif

#ifndef PDS_DIC2D_MATCH_THRESHOLD

        #define PDS_DIC2D_MATCH_THRESHOLD 0.75
#endif

#ifndef PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL

        #define PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL 1
#endif

#ifndef PDS_OK

        #define PDS_OK 1
#endif

#ifndef PDS_WRONG

        #define PDS_WRONG 0
#endif


typedef enum
{
    PDS_DIC2D_NOFOUND=-1,
    PDS_DIC2D_ERROR=0,
    PDS_DIC2D_FOUND=1
}PdsDic2DOutput;

typedef struct 
{
        PdsMatrix *M0;
        PdsMatrix *M1;

        int zero_std_search;
        PdsRaReal match_threshold;
        PdsRaReal no_moved_threshold;

        PdsRaNatural search_step_size;
        PdsRaNatural search_max_length;
        unsigned char debug;
        PdsRaReal last_match_corr;
}PdsDic2D;


PdsDic2D *pds_dic2d_new(PdsRaNatural Nlin,PdsRaNatural Ncol);

PdsDic2D *pds_dic2d_new_from_matrices(const PdsMatrix *Mat0,const PdsMatrix *Mat1);


int pds_dic2d_tracking_region( PdsDic2D *DIC, PdsRegionRect Rin, PdsRegionRect *Rout);

PdsMatrix *pds_dic2d_pearson_correlations_matrix(const PdsDic2D *DIC, PdsRegionRect Ro);

int pds_dic2d_is_the_region_moved(PdsDic2D *DIC, PdsRegionRect Ro);


int pds_dic2d_push_matrix(PdsDic2D *DIC,const PdsMatrix *Mat);


int pds_dic2d_set_zero_std_search(PdsDic2D *DIC, int zero_std_search);

int pds_dic2d_set_no_moved_threshold(PdsDic2D *DIC, PdsRaReal no_moved_threshold);

int pds_dic2d_set_match_threshold(PdsDic2D *DIC, PdsRaReal match_threshold);

int pds_dic2d_set_search_step_size(PdsDic2D *DIC, PdsRaNatural search_step_size);

int pds_dic2d_set_search_max_length(PdsDic2D *DIC, PdsRaNatural search_max_length);

int pds_dic2d_set_debug(PdsDic2D *DIC, unsigned char debug);

int pds_dic2d_set_last_match_corr(PdsDic2D *DIC, PdsRaReal last_match_corr);


int pds_dic2d_get_nlines(const PdsDic2D *DIC, PdsRaNatural *Nlines);

int pds_dic2d_get_ncolumns(const PdsDic2D *DIC, PdsRaNatural *Ncolumns);

int pds_dic2d_get_no_moved_threshold(const PdsDic2D *DIC, PdsRaReal *no_moved_threshold);

int pds_dic2d_get_match_threshold(const PdsDic2D *DIC, PdsRaReal *match_threshold);

int pds_dic2d_get_search_step_size(const PdsDic2D *DIC, PdsRaNatural *search_step_size);

int pds_dic2d_get_search_max_length(const PdsDic2D *DIC, PdsRaNatural *search_max_length);

int pds_dic2d_get_zero_std_search(const PdsDic2D *DIC, int *zero_std_search);


void pds_dic2d_free(PdsDic2D *DIC);

void pds_dic2d_destroy(PdsDic2D **DIC);


#ifdef __cplusplus
}
#endif 

#endif