ZSVOptions.H

/* ZSVOptions.H */
/* $Id: ZSVOptions.H,v 3.8 2003/11/27 12:01:23 vlad Exp $ */
#ifndef __ZSVOptions_H
#define __ZSVOptions_H

#include <mix/Types.h>

#include <zm/ZScaledPalette.H>
#include <zm/ZTracePar.H>


/***********************************************************************
 *
 * Seismic visualization options
 *
 ***********************************************************************/

typedef enum
{
  ZsvMapCoding, 
  ZsvDivCoding  
}   ZsvDrawingMode;

typedef enum
{
  ZsvDontDrawZero,  
  ZsvSpecColor,     
  ZsvUsualColor     
}   ZsvZeroDrawMode;

typedef enum
{
  ZsvDontDraw,  
  ZsvThinLine,  
  ZsvFillLedge  
}   ZsvAmplDrawMode;

typedef enum
{
  ZsvNoGainControl, 
  ZsvAGC        
}   ZsvGainCtrlMode;

typedef enum
{
  ZsvTraceBased,    
  ZsvEnsBased,      
  ZsvProfileBased   
}   ZsvNormMode;

typedef enum
{
  ZsvViewVSP,   
  ZsvViewS2D    
}   ZsvTraceView;

typedef enum
{
  ZsvCommonColor,       
  ZsvCommonPalette,     
  ZsvPosColorNegColor,      
  ZsvPosPaletteNegColor,    
  ZsvPosColorNegPalette,    
  ZsvPosPaletteNegPalette   
}   ZsvDivColorMode;

typedef enum
{
  ZsvFirstOnly,     
  ZsvMultiUniform,  
  ZsvMultiColors,   
  ZsvMultiColorsThin    
  /* ZsvMultiColors and ZsvMultiColorsThin changes color palette
     application to the traces: palette is used just as color pixel
     vector, [0] is used for drawing the first trace from ensemble,
     [1] - for 2nd etc, extra traces got black color */
}   ZsvEnsDrawMode; 
/* Mask of parameters */
#define svDrawingMode   (1<<0)
#define svZeroDrawMode  (1<<1)
#define svSpecZeroColor (1<<2)
#define svAlmostZeroThd (1<<3)
#define svPosDrawMode   (1<<4)
#define svNegDrawMode   (1<<5)
#define svGainCtrlMode  (1<<6)
#define svAgcGap    (1<<7)
#define svNormMode  (1<<8)
#define svTraceView (1<<9)
#define svCutLevel  (1<<10)
//#define svProfileAmax (1<<11)
#define svDivColorMode  (1<<12)
#define svCommonColpal  (1<<13)
#define svPosAmplColpal (1<<14)
#define svNegAmplColpal (1<<15)
#define svInvertComPal  (1<<16)
#define svInvertPosPal  (1<<17)
#define svInvertNegPal  (1<<18)
#define svUseAmplRange  (1<<19)
#define svAmplRange (1<<20)
#define svEnsDrawMode   (1<<21)
#define svEnsSplitDelta (1<<22)
#define svDivAmplGain   (1<<23)


/*
 *  Useful subsets of seismic view options:
 */

#define svGainNormModes     (svGainCtrlMode|svNormMode|svAgcGap|\
                 svDivAmplGain|svCutLevel)

#define svWiggleControl     (svPosDrawMode|svNegDrawMode)

#define svColorSeismic      (svDivColorMode|\
                 svCommonColpal|svInvertComPal|\
                 svPosAmplColpal|svInvertPosPal|\
                 svNegAmplColpal|svInvertNegPal)


class ZSVOptions
{
private:

  struct {
    char*   spec_zero_color;
    char*   common_colpal;
    char*   pos_ampl_colpal;
    char*   neg_ampl_colpal;
  } allocated;

  ZTracePar *trpar;

public:

  ZsvDrawingMode    drawing_mode;   
  ZsvZeroDrawMode   zero_draw_mode; 
  char*         spec_zero_color;
  float         almost_zero_thd;
  ZsvAmplDrawMode   pos_draw_mode;  
  ZsvAmplDrawMode   neg_draw_mode;  
  ZsvGainCtrlMode   gain_ctrl_mode; 
  float         agc_gap;    
  ZsvNormMode       norm_mode;  
  ZsvTraceView      trace_view; 
  float         cut_level;  
  ZsvDivColorMode   div_color_mode; 
  char*         common_colpal;  
  char*         pos_ampl_colpal;
  char*         neg_ampl_colpal;
  Logic         invert_com_pal; 
  Logic         invert_pos_pal; 
  Logic         invert_neg_pal; 
  Logic         use_ampl_range; 
  float         ampl_range[2];  
  ZsvEnsDrawMode    ens_draw_mode;  
  float         ens_split_delta;
  float         div_ampl_gain;  
  ZSVOptions ();
  ZSVOptions (const ZSVOptions& svo);
  ~ZSVOptions ();

  ZSVOptions&   operator= (const ZSVOptions& svo);

  ZSVOptions&   assign (const ZSVOptions& svo, int mask = ~0);


  void  by_default ();

  /* TODO: Save and Load methods for seismic view options for specific
     tasks (processing, interpretation) and seismic data objects
     (Sxxx) */

  void  build_palette (ZScaledPalette& spal, float mm[2]) const;

  void  setup_trace_par (const ZTracePar& trpar);

  void  gain_control_prepare (float* w, const float* src,
                  float* wmax = NULL,
                  const ZTracePar* ptrpar = NULL) const;

  void  gain_control_apply (float* dst, const float* src,
                const float* w, float mm[2] = NULL,
                const ZTracePar* ptrpar = NULL) const;

  void  new_colpal (int mWhichColpal, const char* szColPal);

  void  reset_colpal (int mWhichColpal);

};


#endif /* ZSVOptions.H */