segConfig.h File Reference

Header file for functions used to read configuration files for SEGRec. More...

#include <segDecoder.h>

Go to the source code of this file.

Data Structures
struct	segConfig
	Structure whose members are configuration paramenters for SEGRec. More...
Typedefs
typedef segConfig	SEG_CONFIG
	Structure whose members are configuration paramenters for SEGRec.
Functions
int	segReadConfig (SEG_CONFIG **configData, char *configFile)
	Read a configuration file of the given file name.
void	segFreeConfig (SEG_CONFIG *configData)
	Free memory space for a structure variable with configuration parameters.

---

Detailed Description

Header file for functions used to read configuration files for SEGRec.

Author:

Yoshinori Shiga @ CVSSP, University of Surrey

Date:

01 Feb 2007, 26 Jun 2007 (documented)

Note:

A big change from SEGVit ver.3.x is that every configuration parameter is defined as a member of structure segConfig (SEG_CONFIG). Thereby one can add new parameters, without changing the interface of functions influenced.

Revision

---

Function Documentation

void segFreeConfig

(

SEG_CONFIG *

configData

)

Free memory space for a structure variable with configuration parameters.

Parameters:

[in]

configData

Structure variable containing configuration parameters

Returns:

No return value

Author:

Yoshinori Shiga @ CVSSP, University of Surrey

int segReadConfig	(	SEG_CONFIG **	configData,
		char *	cFile
	)

Read a configuration file of the given file name.

The function reads values of different parameters written in the configuration file.

Parameters:

[in,out]	configData	Structure variable containing configuration parameters
[in]	cFile	Name of the configuration file

Return values:

	ERROR_ALLOC	Memory allocation error
	ERROR_FOPEN	Opening the configuration file failed
	RTN_ERROR	Illegal configuration was found
	otherwise	Number of configuration parameters loaded

Author:

Yoshinori Shiga @ CVSSP, University of Surrey

Note:

This function internally calls setDefaultConfig(), allocString() and logProb().

See also:

setDefaultConfig(), allocString() and logProb()

---