Módulo PdsDic2D.

Funciones que trabajan con Digital Image Correlation in 2D. Más...

Estructuras de datos
struct	PdsDic2D
	La estructura tipo PdsDic2D . Esta estructura contiene dos matrices de Nlin lineas y Ncol columnas. Para usar incluir pds/pdsdic2d.h. Más...

defines
#define	PDS_MIN(a, b)
#define	PDS_DIC2D_NO_MOVED_THRESHOLD   0.99
#define	PDS_DIC2D_MATCH_THRESHOLD   0.75
#define	PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL   1
#define	PDS_OK   1
#define	PDS_WRONG   0

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

pds_dic2d_new_<methods>
Creando nuevas estructuras dic 2d
PdsDic2D *	pds_dic2d_new (PdsRaNatural Nlin, PdsRaNatural Ncol)
	Crea una estructura de tipo PdsDic2D, internamente la estructura contiene dos matrices con Nlin lineas y Ncol columnas, con valores iniciados con ceros. Más...
PdsDic2D *	pds_dic2d_new_from_matrices (const PdsMatrix *Mat0, const PdsMatrix *Mat1)
	Crea una estructura de tipo PdsDic2D, internamente la estructura contiene una copia de las dos matrices de entrada. Los tamanho de las matrices deben ser iguales. Más...

pds_dic2d_<tracking_region>
Obteniendo datos de correlación
int	pds_dic2d_tracking_region (PdsDic2D *DIC, PdsRegionRect Rin, PdsRegionRect *Rout)
	Devuelve la región coincidente en la segunda matriz. Más...
PdsMatrix *	pds_dic2d_pearson_correlations_matrix (const PdsDic2D *DIC, PdsRegionRect Ro)
	Retorna una matriz con las correlaciones de la región Ro en la matriz M0 de DIC, con una vecindad rectangular con brazo de acción search_max_length y un paso de búsqueda de search_step_size, en la matriz M1. Más...
int	pds_dic2d_is_the_region_moved (PdsDic2D *DIC, PdsRegionRect Ro)
	Indica si la región se ha movido. Más...

pds_dic2d_<write_matrices>
Estableciendo datos
int	pds_dic2d_push_matrix (PdsDic2D *DIC, const PdsMatrix *Mat)
	Actualiza los valores de las matrices en la estructura de tipo PdsDic2D, internamente la matriz M1->M0 y mat->M1. Los tamanho de las matrices deben ser iguales. Más...

pds_dic2d_set_<dic_data_configuration>
Estableciendo datos
int	pds_dic2d_set_zero_std_search (PdsDic2D *DIC, int zero_std_search)
	Establece si una región con desvío padrón cero serán buscadas. Por defecto está variable está deshabilitada con PDS_WRONG, se habilita con PDS_OK. Más...
int	pds_dic2d_set_no_moved_threshold (PdsDic2D *DIC, PdsRaReal no_moved_threshold)
	Establece el umbral para aceptar que la región no se ha movido. Por defecto este umbral es PDS_DIC2D_NO_MOVED_THRESHOLD. Más...
int	pds_dic2d_set_match_threshold (PdsDic2D *DIC, PdsRaReal match_threshold)
	Establece el umbral para aceptar una coincidencia en un match. Por defecto este umbral es PDS_DIC2D_MATCH_THRESHOLD. Más...
int	pds_dic2d_set_search_step_size (PdsDic2D *DIC, PdsRaNatural search_step_size)
	Establece el paso en pixels, para la búsqueda de regiones coincidentes. Por defecto es PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL. Más...
int	pds_dic2d_set_search_max_length (PdsDic2D *DIC, PdsRaNatural search_max_length)
	Establece la distancia máxima en pixels, para la busqueda de regiones coincidentes. Más...
int	pds_dic2d_set_debug (PdsDic2D *DIC, unsigned char debug)
	Establece se debug esta habilitado, se habilitado se mostrara mas infrmacion por pantalla. Más...
int	pds_dic2d_set_last_match_corr (PdsDic2D *DIC, PdsRaReal last_match_corr)
	Establece el valor de la correlación en el ultimo match. Más...

pds_dic2d_get_<dic_data_configuration>
Obteniendo datos de matrices
int	pds_dic2d_get_nlines (const PdsDic2D *DIC, PdsRaNatural *Nlines)
	Devuelve el número de lineas en las matrices dentro de la estructura DIC. Más...
int	pds_dic2d_get_ncolumns (const PdsDic2D *DIC, PdsRaNatural *Ncolumns)
	Devuelve el número de columnas en las matrices dentro de la estructura DIC. Más...
int	pds_dic2d_get_no_moved_threshold (const PdsDic2D *DIC, PdsRaReal *no_moved_threshold)
	Devuelve el umbral para aceptar que el objeto no se ha movido. Más...
int	pds_dic2d_get_match_threshold (const PdsDic2D *DIC, PdsRaReal *match_threshold)
	Devuelve el umbral para aceptar una coincidencia en un match. Más...
int	pds_dic2d_get_search_step_size (const PdsDic2D *DIC, PdsRaNatural *search_step_size)
	Devuelve el paso en pixels, para la búsqueda de regiones coincidentes. Por defecto es PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL. Más...
int	pds_dic2d_get_search_max_length (const PdsDic2D *DIC, PdsRaNatural *search_max_length)
	Devuelve la distancia máxima en pixels, para la búsqueda de regiones coincidentes. Más...
int	pds_dic2d_get_zero_std_search (const PdsDic2D *DIC, int *zero_std_search)
	Devuelve si esta habilitado que una región con desvío padrón cero sea buscada. Por defecto está variable está deshabilitada con PDS_WRONG, se habilita con PDS_OK. Más...

pds_dic2d_<free>
Liberando matrices
void	pds_dic2d_free (PdsDic2D *DIC)
	Libera la estructura de tipo puntero PdsDic2D. Más...
void	pds_dic2d_destroy (PdsDic2D **DIC)
	Libera la estructura de tipo puntero PdsDic2D, y limpia el puntero con NULL. Más...

Descripción detallada

Funciones que trabajan con Digital Image Correlation in 2D.

Existen funciones para buscar una región entre dos imágenes representadas como matriz

Digital image correlation

Digital image correlation

Informacion adicional puede ser encontrada en [1]

Documentación de los 'defines'

PDS_MIN

#define PDS_MIN	(		a,
			b
	)

Valor:

({ typeof (a) _a = (a); \
           typeof (b) _b = (b); \
         (_a < _b) ? _a : _b; })

Valor retornado o valor mínimo entre dos números.

Definición en la línea 65 del archivo pdsdic2d.h.

PDS_DIC2D_NO_MOVED_THRESHOLD

#define PDS_DIC2D_NO_MOVED_THRESHOLD   0.99

Valor Umbral de correlación para declarar que el objeto no se ha movido.

Definición en la línea 77 del archivo pdsdic2d.h.

PDS_DIC2D_MATCH_THRESHOLD

#define PDS_DIC2D_MATCH_THRESHOLD   0.75

Valor Umbral de correlación para declarar un match.

Definición en la línea 85 del archivo pdsdic2d.h.

PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL

#define PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL   1

Valor de el paso de la búsqueda.

Definición en la línea 93 del archivo pdsdic2d.h.

PDS_OK

#define PDS_OK   1

Valor retornado en caso de exito, este es un valor diferente que cero.

Definición en la línea 101 del archivo pdsdic2d.h.

PDS_WRONG

#define PDS_WRONG   0

Valor retornado en caso de fracaso, este valor es igual a cero.

Definición en la línea 109 del archivo pdsdic2d.h.

Documentación de las enumeraciones

PdsDic2DOutput

enum PdsDic2DOutput

Valores de enumeraciones
PDS_DIC2D_NOFOUND
PDS_DIC2D_ERROR
PDS_DIC2D_FOUND

Definición en la línea 113 del archivo pdsdic2d.h.

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

Documentación de las funciones

pds_dic2d_new()

PdsDic2D * pds_dic2d_new	(	PdsRaNatural	Nlin,
		PdsRaNatural	Ncol
	)

Crea una estructura de tipo PdsDic2D, internamente la estructura contiene dos matrices con Nlin lineas y Ncol columnas, con valores iniciados con ceros.

Parámetros

[in]	Nlin	Es el número de lineas de las matrices.
[in]	Ncol	Es el número de columnas de las matrices.

Devuelve

Un puntero a la estructura de tipo PdsDic2D o NULL en caso de error.

pds_dic2d_new_from_matrices()

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

Crea una estructura de tipo PdsDic2D, internamente la estructura contiene una copia de las dos matrices de entrada. Los tamanho de las matrices deben ser iguales.

Parámetros

[in]	Mat0	Primera matriz, matriz de fuente.
[in]	Mat1	Segunda matriz, matriz de búsqueda.

Devuelve

Un puntero a la estructura de tipo PdsDic2D o NULL en caso de error.

Ejemplos:

example_dic1.c.

pds_dic2d_tracking_region()

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

Devuelve la región coincidente en la segunda matriz.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	Rin	La región de la primera matriz que se buscara en la segunda.
[out]	Rout	La región encontrada en la segunda matriz. Esta variable no es alterada si el objeto no fue encontrado.

Devuelve

Puede retornar: PDS_DIC2D_ERROR cuando hubo un error lectura de memoria. PDS_DIC2D_FOUND Si el objeto fue encontrado. PDS_DIC2D_NOFOUND Si el objeto no fue encontrado.

Ejemplos:

example_dic1.c.

pds_dic2d_pearson_correlations_matrix()

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

Retorna una matriz con las correlaciones de la región Ro en la matriz M0 de DIC, con una vecindad rectangular con brazo de acción search_max_length y un paso de búsqueda de search_step_size, en la matriz M1.

Así, la función retorna una matriz cuadrada de 1+2(search_max_length/search_step_size) elementos por lado.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	Ro	La región de la matriz M0.

Devuelve

A matriz de correlaciones si todo fue bien o NULL si no (ej: DIC==NULL).

pds_dic2d_is_the_region_moved()

int pds_dic2d_is_the_region_moved	(	PdsDic2D *	DIC,
		PdsRegionRect	Ro
	)

Indica si la región se ha movido.

Es cosiderado que hubo movimiento si la correlación de la regiones en M0 y M1 es menor que no_moved_threshold.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	Ro	La región de la matriz M0.

Devuelve

PDS_OK si se movimiento o PDS_WRONG si no se movimiento o si hubo algun error en la consulta.

pds_dic2d_push_matrix()

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

Actualiza los valores de las matrices en la estructura de tipo PdsDic2D, internamente la matriz M1->M0 y mat->M1. Los tamanho de las matrices deben ser iguales.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	Mat	Matriz a copiar.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ejemplo: DIC==NULL MAT==NULL).

pds_dic2d_set_zero_std_search()

int pds_dic2d_set_zero_std_search	(	PdsDic2D *	DIC,
		int	zero_std_search
	)

Establece si una región con desvío padrón cero serán buscadas. Por defecto está variable está deshabilitada con PDS_WRONG, se habilita con PDS_OK.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	zero_std_search	Habilitador, des-habilitador, si se busca regiones con desvío padrón cero. Este valor no es aceptado si es diferente de PDS_OK o PDS_WRONG.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL o parámetro fuera de rango).

pds_dic2d_set_no_moved_threshold()

int pds_dic2d_set_no_moved_threshold	(	PdsDic2D *	DIC,
		PdsRaReal	no_moved_threshold
	)

Establece el umbral para aceptar que la región no se ha movido. Por defecto este umbral es PDS_DIC2D_NO_MOVED_THRESHOLD.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	no_moved_threshold	Umbral para aceptar que la región no se ha movido. Este valor no es aceptado si es mayor que 1.0 o menor de 0.0.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL o parámetro fuera de rango).

pds_dic2d_set_match_threshold()

int pds_dic2d_set_match_threshold	(	PdsDic2D *	DIC,
		PdsRaReal	match_threshold
	)

Establece el umbral para aceptar una coincidencia en un match. Por defecto este umbral es PDS_DIC2D_MATCH_THRESHOLD.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	match_threshold	Umbral de coincidencia. Este valor no puede ser mayor que 1.0 o menor de -1.0.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_set_search_step_size()

int pds_dic2d_set_search_step_size	(	PdsDic2D *	DIC,
		PdsRaNatural	search_step_size
	)

Establece el paso en pixels, para la búsqueda de regiones coincidentes. Por defecto es PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	search_step_size	Paso en pixels, para la busqueda de regiones coincidentes. El valor cero no es aceptado.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_set_search_max_length()

int pds_dic2d_set_search_max_length	(	PdsDic2D *	DIC,
		PdsRaNatural	search_max_length
	)

Establece la distancia máxima en pixels, para la busqueda de regiones coincidentes.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	search_max_length	La distancia máxima en pixels, para la búsqueda de regiones coincidentes. El valor cero no es aceptado.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_set_debug()

int pds_dic2d_set_debug	(	PdsDic2D *	DIC,
		unsigned char	debug
	)

Establece se debug esta habilitado, se habilitado se mostrara mas infrmacion por pantalla.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	debug	Habilita con valor 1, deshabilita con valor diferente de 1.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_set_last_match_corr()

int pds_dic2d_set_last_match_corr	(	PdsDic2D *	DIC,
		PdsRaReal	last_match_corr
	)

Establece el valor de la correlación en el ultimo match.

Parámetros

[in]	DIC	La estructura en consulta.
[in]	last_match_corr	Valor de la correlación en el ultimo match.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_get_nlines()

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

Devuelve el número de lineas en las matrices dentro de la estructura DIC.

Parámetros

[in]	DIC	La estructura en consulta.
[out]	Nlines	En donde se guardará el número de lineas de las matrices.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_get_ncolumns()

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

Devuelve el número de columnas en las matrices dentro de la estructura DIC.

Parámetros

[in]	DIC	La estructura en consulta.
[out]	Ncolumns	En donde se guardará el número de columnas de las matrices.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_get_no_moved_threshold()

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

Devuelve el umbral para aceptar que el objeto no se ha movido.

Parámetros

[in]	DIC	La estructura en consulta.
[out]	no_moved_threshold	Umbral de coincidencia.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_get_match_threshold()

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

Devuelve el umbral para aceptar una coincidencia en un match.

Parámetros

[in]	DIC	La estructura en consulta.
[out]	match_threshold	Umbral de coincidencia.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_get_search_step_size()

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

Devuelve el paso en pixels, para la búsqueda de regiones coincidentes. Por defecto es PDS_DIC2D_SEARCH_PIXEL_BY_PIXEL.

Parámetros

[in]	DIC	La estructura en consulta.
[out]	search_step_size	Paso en pixels, para la búsqueda de regiones coincidentes.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_get_search_max_length()

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

Devuelve la distancia máxima en pixels, para la búsqueda de regiones coincidentes.

Parámetros

[in]	DIC	La estructura en consulta.
[out]	search_max_length	La distancia máxima en pixels, para la búsqueda de regiones coincidentes.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL).

pds_dic2d_get_zero_std_search()

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

Devuelve si esta habilitado que una región con desvío padrón cero sea buscada. Por defecto está variable está deshabilitada con PDS_WRONG, se habilita con PDS_OK.

Parámetros

[in]	DIC	La estructura en consulta.
[out]	zero_std_search	Si se busca regiones con desvío padrón cero. Este valor es PDS_OK o PDS_WRONG.

Devuelve

PDS_OK si todo fue bien o PDS_WRONG si no (ej: DIC==NULL o zero_std_search==NULL).

pds_dic2d_free()

void pds_dic2d_free

(

PdsDic2D *

DIC

)

Libera la estructura de tipo puntero PdsDic2D.

Parámetros

[in,out]

DIC

La estructura a liberar.

Devuelve

No retorna valor.

Ejemplos:

example_dic1.c.

pds_dic2d_destroy()

void pds_dic2d_destroy

(

PdsDic2D **

DIC

)

Libera la estructura de tipo puntero PdsDic2D, y limpia el puntero con NULL.

Parámetros

[in,out]

DIC

La estructura a liberar y limpiar.

Devuelve

No retorna valor.