cta_sobs_sqlite3.h File Reference

SQLite3 user implementation of the stochastic observer interface. More...

#include "cta_f77blas.h"
#include "cta_datatypes.h"
#include "cta_handles.h"
#include "cta_functions.h"
#include "cta_util_sqlite3.h"
#include "cta_sobs.h"
#include "cta_obsdescr.h"
#include <sqlite3.h>

Go to the source code of this file.

Data Structures

struct  CTAI_SObs_sqlite3

Functions

void CTA_SObs_sqlite3_initialise ()
 Initialization function for defining the SObs_sqlite3 class.
void CTAI_SObs_sqlite3_Create_Size (int *memsize, int *retval)
 Implementation function that is part of object create process.
void CTAI_SObs_sqlite3_Create_Init (CTAI_SObs_sqlite3 *x, CTA_Handle userdata, int *retval)
 Implementation function that is part of object create process.
void CTAI_SObs_sqlite3_CreateSel (CTAI_SObs_sqlite3 *obsin, CTA_Handle *userdata, CTAI_SObs_sqlite3 *obsout, int *retval)
 Create a new stochastic observer that is subset of existing stochastic observer.
void CTAI_SObs_sqlite3_Count (CTAI_SObs_sqlite3 *x, int *nmeasr, int *retval)
 Count the number of measurements.
void CTAI_SObs_sqlite3_GetVals (CTAI_SObs_sqlite3 *x, CTA_Vector *hvec, int *retval)
 Get a vector with the measurements.
void CTAI_SObs_sqlite3_GetTimes (CTAI_SObs_sqlite3 *x, CTA_Vector *hvec, int *retval)
 Get times associated with the measurements.
void CTAI_SObs_sqlite3_GetVariances (CTAI_SObs_sqlite3 *x, CTA_Vector *hvec, int *returnvar, int *retval)
 Get variance of probability density function of the mesurements.
void CTAI_SObs_sqlite3_GetRealisation (CTAI_SObs_sqlite3 *x, CTA_Vector *hvec, int *retval)
 Draw random values (measurements) according to the probability density function of the mesurements.
void CTAI_SObs_sqlite3_GetCovMat (CTAI_SObs_sqlite3 *x, CTA_Matrix *hmat, int *retval)
 Get covariance matrix of probability density function of the measurements.
void CTAI_SObs_sqlite3_export (CTAI_SObs_sqlite3 *x, CTA_Handle *userdata, int *retval)
 Export a CTAI_SObs object to file or standard output.
void CTAI_SObs_sqlite3_Free (CTAI_SObs_sqlite3 *x, int *retval)
 Free the object data and associated resources.

Detailed Description

SQLite3 user implementation of the stochastic observer interface.

Definition in file cta_sobs_sqlite3.h.

Function Documentation

void CTA_SObs_sqlite3_initialise (  ) 

Initialization function for defining the SObs_sqlite3 class.

Returns:
no return value
void CTAI_SObs_sqlite3_Count ( CTAI_SObs_sqlite3 *  x,
int *  nmeasr,
int *  retval 
)

Count the number of measurements.

Parameters:
x I pointer to object data of stochastic observer
nmeasr O receives number of measurements
retval O receives the return value
Returns:
no return value
void CTAI_SObs_sqlite3_Create_Init ( CTAI_SObs_sqlite3 *  x,
CTA_Handle  userdata,
int *  retval 
)

Implementation function that is part of object create process.

Note:
userdata must contain handle of COSTA string giving the SQLITE3 database name.
Parameters:
x IO pointer to object data of stochastic observer
userdata I pointer to user data
retval O receives return value
Returns:
no return value
void CTAI_SObs_sqlite3_Create_Size ( int *  memsize,
int *  retval 
)

Implementation function that is part of object create process.

Parameters:
memsize O receives size of new CTAI_SObs_sqlite3 object
retval O receives return value
Returns:
no return value
void CTAI_SObs_sqlite3_CreateSel ( CTAI_SObs_sqlite3 *  obsin,
CTA_Handle *  userdata,
CTAI_SObs_sqlite3 *  obsout,
int *  retval 
)

Create a new stochastic observer that is subset of existing stochastic observer.

Note:
userdata must contain handle of COSTA string giving the selection condition.
This function fills in the object data of the new stochastic observer. The handle is created by CTA_SObs_CreateSel().
Parameters:
obsin I pointer to object data of the existing stochastic observer
userdata I pointer to userdata
obsout O pointer to object data of the new COSTA-stochastic observer, must exist before calling
retval I receives return value
Returns:
no return value
void CTAI_SObs_sqlite3_export ( CTAI_SObs_sqlite3 *  x,
CTA_Handle *  userdata,
int *  retval 
)

Export a CTAI_SObs object to file or standard output.

Note:
Supported:
output to file (userdata must contain handle of COSTA file)
Parameters:
x I pointer to object data of stochastic observer
userdata I user data
retval O receives return value
Returns:
no return value
void CTAI_SObs_sqlite3_Free ( CTAI_SObs_sqlite3 *  x,
int *  retval 
)

Free the object data and associated resources.

Parameters:
x I pointer to object data of stochastic observer
retval O receives return value
Returns:
no return value
void CTAI_SObs_sqlite3_GetCovMat ( CTAI_SObs_sqlite3 *  x,
CTA_Matrix *  hmat,
int *  retval 
)

Get covariance matrix of probability density function of the measurements.

Parameters:
x I pointer to object data of stochastic observer
hmat O handle of matrix that receives the covariance matrix; must exist before calling
retval O receives return value
Returns:
no return value
void CTAI_SObs_sqlite3_GetRealisation ( CTAI_SObs_sqlite3 *  x,
CTA_Vector *  hvec,
int *  retval 
)

Draw random values (measurements) according to the probability density function of the mesurements.

Parameters:
x I pointer to object data of stochastic observer
hvec O handle of vector that receives the draw (measurements); must exist before calling
retval O receives return value
Returns:
no return value
void CTAI_SObs_sqlite3_GetTimes ( CTAI_SObs_sqlite3 *  x,
CTA_Vector *  hvec,
int *  retval 
)

Get times associated with the measurements.

Parameters:
x I pointer to object data of stochastic observer
hvec O handle of vector that receives the associated times, must exist before calling
retval O receives the return value
Returns:
no return value
void CTAI_SObs_sqlite3_GetVals ( CTAI_SObs_sqlite3 *  x,
CTA_Vector *  hvec,
int *  retval 
)

Get a vector with the measurements.

Parameters:
x I pointer to object data of stochastic observer
hvec O handle of vector that receives the measurements, must exist before calling
retval O receives the return value
Returns:
no return value
void CTAI_SObs_sqlite3_GetVariances ( CTAI_SObs_sqlite3 *  x,
CTA_Vector *  hvec,
int *  returnvar,
int *  retval 
)

Get variance of probability density function of the mesurements.

Parameters:
x I pointer to object data of stochastic observer
hvec I handle of the vector that receives the variances, must exist before calling
returnvar O flag: TRUE for getting variance, FALSE for getting standard deviation
retval O receives return value
Returns:
no return value
Generated on 4 Mar 2014 for OpenDA by  doxygen 1.6.1