libuproc  1.2.0
Data Structures | Functions

Database. More...

Data Structures

struct  uproc_database
 Database. More...
 

Functions

uproc_databaseuproc_database_load (const char *path, int prot_thresh_level, enum uproc_ecurve_format format)
 Loads all required data of a UProC database from files in the given directory and returns a database object. More...
 
uproc_ecurveuproc_database_ecurve_forward (uproc_database *db)
 Returns the forward matching ecurve of the database. More...
 
uproc_ecurveuproc_database_ecurve_reverse (uproc_database *db)
 Returns the reverse matching ecurve of the database. More...
 
uproc_idmapuproc_database_idmap (uproc_database *db)
 Returns the mapping from numerical to string IDs of the database. More...
 
uproc_matrixuproc_database_protein_threshold (uproc_database *db)
 Returns the protein threshold matrix of the database. More...
 
void uproc_database_destroy (uproc_database *db)
 Destroy the database and all associated object within the database. More...
 

Detailed Description

Database.

Function Documentation

uproc_database* uproc_database_load ( const char *  path,
int  prot_thresh_level,
enum uproc_ecurve_format  format 
)

Loads all required data of a UProC database from files in the given directory and returns a database object.

Parameters
pathan existing directory containing a UProC database.
prot_thres_levelthe protein threshold to be used. Note that the corresponding file "prot_thresh_e%d" has to exist in the directory.
formatthe format of the ecurves
Returns
the object on success or NULL on error
uproc_ecurve* uproc_database_ecurve_forward ( uproc_database db)

Returns the forward matching ecurve of the database.

Note that the returned object will become invalid when the database is destroyed.

See also
uproc_database_destroy
Parameters
dbthe database.
Returns
a pointer to the ecurve.
uproc_ecurve* uproc_database_ecurve_reverse ( uproc_database db)

Returns the reverse matching ecurve of the database.

Note that the returned object will become invalid when the database is destroyed.

See also
uproc_database_destroy
Parameters
dbthe database.
Returns
a pointer to the ecurve.
uproc_idmap* uproc_database_idmap ( uproc_database db)

Returns the mapping from numerical to string IDs of the database.

Note that the returned object will become invalid when the database is destroyed.

See also
uproc_database_destroy
Parameters
dbthe database.
Returns
a pointer to the idmap.
uproc_matrix* uproc_database_protein_threshold ( uproc_database db)

Returns the protein threshold matrix of the database.

Note that the returned object will become invalid when the database is destroyed. The returned pointer may be NULL if the protein threshold was set to 0 while loading the database.

See also
uproc_database_load
uproc_database_destroy
Parameters
dbthe database.
Returns
a pointer to the matrix or NULL
void uproc_database_destroy ( uproc_database db)

Destroy the database and all associated object within the database.

Parameters
dbthe database to destroy and free memory for.