tc_pairs_conf_info.h

// *=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
// ** Copyright UCAR (c) 1992 - 2022
// ** University Corporation for Atmospheric Research (UCAR)
// ** National Center for Atmospheric Research (NCAR)
// ** Research Applications Lab (RAL)
// ** P.O.Box 3000, Boulder, Colorado, 80307-3000, USA
// *=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*

////////////////////////////////////////////////////////////////////////

#ifndef  __TC_PAIRS_CONF_INFO_H__
#define  __TC_PAIRS_CONF_INFO_H__

////////////////////////////////////////////////////////////////////////

#include <iostream>
#include <map>

#include "mask_poly.h"

#include "vx_config.h"
#include "vx_util.h"
#include "vx_grid.h"

////////////////////////////////////////////////////////////////////////

struct ConsensusInfo {
   ConcatString Name;
   StringArray  Members;
   NumArray     Required;
   int          MinReq;
   bool         WriteMembers;
};

////////////////////////////////////////////////////////////////////////

struct DiagInfo {
   ConcatString TrackSource;
   ConcatString FieldSource;
   StringArray  MatchToTrack;
   StringArray  DiagName;
   void clear();
};

////////////////////////////////////////////////////////////////////////

class TCPairsConfInfo {

   private:

      void init_from_scratch();

   public:

      // TCPairs configuration object
      MetConfig Conf;

      // User-defined description
      ConcatString Desc;

      // Track filtering criteria
      StringArray Model;     // List of model names
      StringArray StormId;   // List of storm ids
      StringArray Basin;     // List of basin names
      StringArray Cyclone;   // List of cyclone numbers
      StringArray StormName; // List of storm names
      StringArray SkipConsensusMembers; // List of consensus members to skip output for
      
      // Timing information
      unixtime  InitBeg, InitEnd;
      TimeArray InitInc;
      TimeArray InitExc;
      NumArray  InitHour;
      NumArray  LeadReq;
      unixtime  ValidBeg, ValidEnd;
      TimeArray ValidInc;
      TimeArray ValidExc;
      TimeArray WriteValid;

      // Polyline masking regions
      ConcatString InitMaskName;
      MaskPoly     InitPolyMask;
      Grid         InitGridMask;
      MaskPlane    InitAreaMask;

      ConcatString ValidMaskName;
      MaskPoly     ValidPolyMask;
      Grid         ValidGridMask;
      MaskPlane    ValidAreaMask;

      // Check for duplicate ATCFTrackLines
      bool CheckDup;

      // 12-hour track interpolation logic
      Interp12Type Interp12;

      // Consensus model definition
      int NConsensus;           // Number of consensus models
      ConsensusInfo *Consensus; // Consensus model definition

      // Time-lagged track definition
      NumArray LagTime;

      // CLIPER/SHIFOR baseline model definition along with BEST
      // and operational technique names
      StringArray BestTechnique;
      StringArray BestBaseline;
      StringArray OperTechnique;
      StringArray OperBaseline;

      // Analysis track datasets
      TrackType AnlyTrack;

      // Only retain TrackPoints in both the ADECK and BDECK tracks
      bool MatchPoints;

      // Gridded data file containing distances to land
      ConcatString DLandFile;

      // ASCII watch/warnings file
      ConcatString WatchWarnFile;

      // Watch/warnings time offset
      int WatchWarnOffset;

      // Diagnostics metadata
      std::map<ConcatString,DiagInfo> DiagInfoMap;

      // Diagnostic conversions
      std::map< ConcatString,std::map<ConcatString,UserFunc_1Arg> > DiagConvertMap;

      // Basin Map
      std::map<ConcatString,ConcatString> BasinMap;

      // Config file version
      ConcatString Version;

      TCPairsConfInfo();
     ~TCPairsConfInfo();

      void clear();

      void read_config(const char *, const char *);
      void process_config();
};

////////////////////////////////////////////////////////////////////////

#endif   /*  __TC_PAIRS_CONF_INFO_H__  */

////////////////////////////////////////////////////////////////////////