VisualParams.h

/* $Id: VisualParams.h,v 1.11 2004/05/13 11:28:29 vlad Exp $ */

#ifndef __VisualParams_h

#define __VisualParams_h

#include <mix/Types.h>
#include <zm/colors.h>
#include <tv/VisualMode.h>

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


#define LeftOffset   60
#define TopOffset    30
#define RightOffset  5
#define BottomOffset 5

#define LegendHeight 19

#define TextDescent     8
#define TextHalfDescent 2
#define TimeAxisOffset  5
#define DepthAxisOffset 5
#define ActualityOffset 5

#define AtLeftSide   (1<<0)
#define AtRightSide  (1<<1)
#define AtTopSide    (1<<2)
#define AtBottomSide (1<<3)


#define ADJUST_TOP(x,y)     ((x)>(y)?(y):(x))
#define ADJUST_BOTTOM(x,y)  ((x)<(y)?(y):(x))


typedef struct
{
  /**** Trace parameters ****/
  float Tl, Tr;   /* left and right bound times {ms} */
  unsigned long StartIndex, TrCnt;  /* the first trace index and
                                       count of displayed traces */

  /**** Visual parameters ****/
  SineKind sk;       /* sinus visualization type */
  float averaging;   /* persent; 'average' level of amplitude adjusting */
  float overlapping; /* persent; how many area used by neibour traces */
  float gapWidth;    /* automatic Amplitude Level Adjustment gap width {ms} */
  float agcDynamicAmplify;  /* AGC dynamic amplify koefficient (0..1) */
  float zeroAmplLevel;/* zero is drawn if |Acur|<Amax*zeroAmplLevel */
  Logic colorMode;   /* color amplitudes drawing (TRUE) or black&white
                        (FALSE) */
  float fixedAmax;   /* amplitude with is used as unit one for all traces */
}  VisualParams;


typedef struct
{
  char  type;
  char  comp;
  char  colorname[ZCP_COLORNAME_LEN+1];

}   TypeCompColor;


typedef enum
{
  AGCnorm = 0,
  GlobalNorm,
  LocalNorm,
  FixedGain

}   AmplNormKind;

typedef struct
{
  float Amax;   /* |A|max of this trace */
  float Hcab;   /* Cable depth of this trace */
  float HcabAmax;/* |A|max among all traces with the same Hcab */

}   VisTraceData;


/* Dummy.  Just for backward compatibility */
typedef enum
{
  agcNormalized,
  agcReality

}  AGCKind;   /* AGC normalization type */


int GetLeftX ();
int GetRightX ();
int GetTopY ();
int GetBottomY ();
int GetWidth ();
int GetHeight ();

int GetXbyTime(float time);

int CalcInX (int x); /* window -> box */
int CalcInY (int y); /* window -> box */
int CalcOutX (int x); /* box -> window */
int CalcOutY (int y); /* box -> window */
int CalcWidth (int w);
int CalcHeight (int h);

int InBox (int x, int y); /* window -> in box */

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

#endif  /* VisualParams.h */