cta_util_methods.h File Reference

Utility routines for creating data assimilation methods. More...

Go to the source code of this file.

Functions

CTAEXPORT int CTA_Util_MethodsPrintObservations (CTA_Handle fgModel, CTA_Handle bgModel, CTA_StochObs sObs, CTA_Time time, CTA_File file, int printHeader)
 print the predicted values and the observed values
CTAEXPORT int CTA_Util_MethodsSelectObservations (CTA_Model model, CTA_StochObs sObsAll, CTA_Time spanSim, CTA_StochObs *sObsSel)
 Make an initial selection of the observations.
CTAEXPORT int CTA_Util_MethodsOpenResultFile (char *stationFile, CTA_File *fStationFile)
 Create an output file for filter predictions at station locations.

Detailed Description

Utility routines for creating data assimilation methods.

Note:
This is just a set of utility routines it does not define any COSTA component

Definition in file cta_util_methods.h.


Function Documentation

CTAEXPORT int CTA_Util_MethodsOpenResultFile ( char *  stationFile,
CTA_File fStationFile 
)

Create an output file for filter predictions at station locations.

The routine CTA_Util_MethodsPrintObservations can be used for writing the results.

Note:
the header is written by this call
Parameters:
stationFile (I) Name of result file
fStationFile (O) Handle to result file
Returns:
error status: CTA_OK if successful
CTAEXPORT int CTA_Util_MethodsPrintObservations ( CTA_Handle  fgModel,
CTA_Handle  bgModel,
CTA_StochObs  sObs,
CTA_Time  time,
CTA_File  file,
int  printHeader 
)

print the predicted values and the observed values

Parameters:
fgModel O Model of foreground run (with data assimilation) or Vector with the predicted values of the foreground run. if set to CTA_NULL NaN will be printed as result
bgModel I Model of background run (without data assimilation) or Vector with the predicted values of the background run. if set to CTA_NULL NaN will be printed as result
sObs I Stochastic observer
time I Corresponding time
file I Output file (note CTA_FILE_STDOUT prints to screen)
printHeader I Print header CTA_TRUE/CTA_FALSE
Returns:
error status: CTA_OK if successful
CTAEXPORT int CTA_Util_MethodsSelectObservations ( CTA_Model  model,
CTA_StochObs  sObsAll,
CTA_Time  spanSim,
CTA_StochObs sObsSel 
)

Make an initial selection of the observations.

The selection of observations is based on the given simulation timespan and the criterion provided by the model (CTA_Model_GetObsSelect)

Note:
sObsSel is created and should be freed by the caller of this routine
Parameters:
model I Model (for CTA_Model_GetObsSelect)
sObsAll I All observations
spanSim I Simulation timespan
sObsSel O Selection of observations
Returns:
error status: CTA_OK if successful

Generated on 4 Mar 2014 for OpenDA by  doxygen 1.6.1