TraceInterp.h

/* $Id: TraceInterp.h,v 1.3 2005/03/02 17:34:35 vlad Exp $ */
/*
   Trace interpolation class.
*/

#ifndef __TraceInterp_h

#define __TraceInterp_h


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* class TraceInterp
     data are followed;

   methods:
     int OpenTrInterp(TraceInterp* pTrI, float Tb, float Te, float dt);
     -- opens trace interpolator for float trace (Tb; Te; dt);
     void CloseTraceInterp(TraceInterp TrI);
     -- closes trace interpolator;

     void AssignTrForInterp(TraceInterp TrI, float* data);
     -- reads trace from trace buffer to own buffer and prepares
     -- trace for interpolation;
     float GetAmpl(TraceInterp TrI, float t);
     -- general interpolation function; t {ms};
     float GetExtremalAmplTI (TraceInterp TrI, ExtremalAmplType eat);
     -- returns value of amplitude's maximum among absolute, positive
     -- and negative values;
*/


typedef struct
{
  unsigned int amplCnt; 
  float Tb, Te, dt;     
  float *trData;        
}  TraceInterpStruct;

typedef TraceInterpStruct* TraceInterp;


typedef enum
{
  eatAbsolute,
  eatPositive,
  eatNegative

}  ExtremalAmplType;

/* Returns:
   0 - OK;
  -1 - bad parameters;
  -2 - memory allocation fault;
*/
int OpenTraceInterp (TraceInterp* pTrI, float Tb, float Te, float dt);
void CloseTraceInterp (TraceInterp TrI);

/* Assigns float amplitudes array of fixed size */
void AssignTI (TraceInterp TrI, float* data);

/* Returns interpolated amplitude value on t time of assigned trace */
float GetAmplTI (TraceInterp TrI, float t);

/* Returns value of amplitude's maximum among absolute, positive
   and negative values */
float GetExtremalAmplTI (TraceInterp TrI, ExtremalAmplType eat);


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif  /* TraceInterp.h */