AnitaConventions.h

#ifndef ANITACONVENTIONS_H
#define ANITACONVENTIONS_H

#ifndef ROOT_Rtypes
#if !defined(__CINT__) || defined(__MAKECINT__)
#include "Rtypes.h"
#endif
#endif

#define ANITA_FLIGHT_H

#include "AnitaVersion.h"


namespace WaveCalType {
  typedef enum EWaveCalType {

    kNoCalib = 0x00, 
    kJustUnwrap = 0x01, 
    kNominal = 0x02, 
    kVoltageTime = 0x02, 
    kJustTimeNoUnwrap  = 0x03, 
    kNoTriggerJitterNoZeroMean = 0x05, 
    kNoChannelToChannelDelays  = 0x06, 
    kNoTriggerJitterNoZeroMeanFlipRco = 0x07, 
    kNoTriggerJitterNoZeroMeanFirmwareRco = 0x08, 
    kNoTriggerJitterNoZeroMeanFirmwareRcoFlipped = 0x09,
    kFull = 0x0a, 
    kDefault = 0x0a, 
    kVTFast = 0x1b, 
    kAddPeds = 0x1c, 
    kOnlyTiming = 0x1d, 
    kJustRemoveClockSpike = 0x1e, 
    kOnlyDTs = 0x1f, 
    kNotACalib 
  } WaveCalType_t; 

  const char *calTypeAsString(WaveCalType::WaveCalType_t calType); 
  void listAllCalTypes(); 
}

#define NUM_SEAVEYS_ANITA1 32 
#define NUM_SEAVEYS_ANITA2 40 
#define NUM_SEAVEYS_ANITA3 48 
#define NUM_SEAVEYS_ANITA4 48 
#define NUM_POLS 2 
#ifdef ANITA_2_DATA
#define ACTIVE_SURFS 10 
#define NUM_SEAVEYS NUM_SEAVEYS_ANITA2 
#else
#define ACTIVE_SURFS 12 
#define NUM_SEAVEYS NUM_SEAVEYS_ANITA3 
#endif

#define SCALERS_PER_SURF 12 
#define SCALERS_PER_SURF_V30 16 
#define L1S_PER_SURF 6
#define L1S_PER_SURF_V30 4
#define L2S_PER_SURF 2
#define L3S_PER_SURF 2
#define RFCHAN_PER_SURF 8 
#define CHANNELS_PER_SURF 9 
#define LABRADORS_PER_SURF 4 
#define RCO_PER_LAB 2 
#define NUM_DIGITZED_CHANNELS ACTIVE_SURFS*CHANNELS_PER_SURF 
#define MAX_NUMBER_SAMPLES 260 
#define EFFECTIVE_SAMPLES 256 
#define NUM_PHI 16 
#define NUM_ANTENNA_RINGS 3


#define NUM_NADIRS 8 
#define NUM_BICONES 4 
#define NUM_DISCONES 4 


#define BASE_PACKET_MASK 0xffff 


#define NUM_SURF ACTIVE_SURFS 
#define NUM_CHAN CHANNELS_PER_SURF 
#define NUM_CHIP LABRADORS_PER_SURF 
#define NUM_RCO RCO_PER_LAB 
#define NUM_SAMP MAX_NUMBER_SAMPLES 
#define NUM_EFF_SAMP EFFECTIVE_SAMPLES 

//Trigger Stuff
#define ANTS_PER_SURF 4 
#define TRIGGERS_PER_SURF 12  
#define TRIGGER_SURFS 8 
#define PHI_SECTORS 16 
#define BANDS_PER_ANT 4 
#define TURF_BANK_SIZE 4 
#define TURF_EVENT_DATA_SIZE 256
#define NADIR_ANTS 8 


#define WRAPPED_HITBUS 0x8 


//Acromag stuff
#define CHANS_PER_IP320 40 
#define NUM_IP320_BOARDS 3 


//Process Stuff
#define NUM_PROCESSES 20 
#define NUM_PROCESSES_V40 20 

//GPS stuff
#define MAX_SATS 12 

#define MAX_CMD_LENGTH 20 


#define NUM_PRIORITIES 10 
#define NUM_SATABLADES 8 
#define NUM_SATAMINIS 8 
#define NUM_USBS 31 

#define WAKEUP_LOS_BUFFER_SIZE 4000 
#define WAKEUP_TDRSS_BUFFER_SIZE 500 
#define WAKEUP_LOW_RATE_BUFFER_SIZE 100 

#define ACQD_ID_MASK 0x001 
#define ARCHIVED_ID_MASK 0x002 
#define CALIBD_ID_MASK 0x004 
#define CMDD_ID_MASK 0x008 
#define EVENTD_ID_MASK 0x010 
#define GPSD_ID_MASK 0x020 
#define HKD_ID_MASK 0x040 
#define LOSD_ID_MASK 0x080 
#define PRIORITIZERD_ID_MASK 0x100 
#define SIPD_ID_MASK 0x200 
#define MONITORD_ID_MASK 0x400 
#define PLAYBACKD_ID_MASK 0x800 
#define LOGWATCHD_ID_MASK 0x1000 
#define NEOBRICKD_ID_MASK 0x2000 
#define ALL_ID_MASK 0xffff 


//RTLd stuff
#define NUM_RTLSDR 6  
#define RTLSDR_MAX_SPECTRUM_BINS 4096  // The maximum number of bins we can save in a packet.


// TUFF stuff
#define NUM_TUFF_NOTCHES 3
#define NUM_RFCM 4



//Now some geometry and polarisation considerations


namespace AnitaRing {
   typedef enum EAnitaRing {
     kTopRing  = 0, 
     kUpperRing = kTopRing,
     kMiddleRing  = 1, 
     kLowerRing = kMiddleRing,
     kBottomRing = 2, 
     kNadirRing=kBottomRing,
     kNotARing 
   } AnitaRing_t; 

   const char *ringAsString(AnitaRing::AnitaRing_t ring); 
   char ringAsChar(AnitaRing::AnitaRing_t ring); 
}


namespace AnitaPol {
   typedef enum EAnitaPol {
     kHorizontal = 0, 
     kVertical   = 1, 
     kNotAPol 
   } AnitaPol_t; 
   char polAsChar(AnitaPol::AnitaPol_t pol); 
}


namespace AnitaTrigPol {
   typedef enum EAnitaTrigPol {
     kLCP = 0, 
     kRCP = 1, 
     kHorizontal = 2, 
     kVertical = 3, 
     kNotATrigPol 
   } AnitaTrigPol_t; 
   char polAsChar(AnitaTrigPol::AnitaTrigPol_t pol); 

   AnitaTrigPol::AnitaTrigPol_t fromAnitaPol(AnitaPol::AnitaPol_t pol);

}





namespace AnitaBand {
   typedef enum EAnitaBand {
     kLow =0, 
     kMid =1, 
     kHigh =2, 
     kFull =3 
   } AnitaBand_t; 
   const char *bandAsString(AnitaBand::AnitaBand_t band); 
}

//
// TODO this needs to be updated properly to support multiple ANITA's
//
namespace AnitaLocations {

  const double LONGITUDE_SURF_SEAVEY=167.0564667; 
  const double LATITUDE_SURF_SEAVEY=-77.86185; 
  const double ALTITUDE_SURF_SEAVEY=15.0; 

  const double LONGITUDE_BH=167.06679444; 
  const double LATITUDE_BH=-77.861936111; 
  const double ALTITUDE_BH=-33.67; 

  //   const double LONGITUDE_TD=158.4564333333; ///< Longitude of Taylor Dome antenna.
  //   const double LATITUDE_TD=77.88116666666; ///< Latitude of Taylor Dome antenna.
  //   const double ALTITUDE_TD=2712.72; ///< Altitude of Taylor Dome antenna.
  const double LONGITUDE_TD=158.45925;
  const double LATITUDE_TD=-77.8803;
  const double ALTITUDE_TD=2260-97.;

  //Anita3 WAIS pulser location
  // WAIS divide position taken from Steph's e-log
  // https://www.phys.hawaii.edu/elog/anita_notes/595
  const Double_t LATITUDE_WAIS_A3 = - (79 + (27.93728/60)); 
  const Double_t LONGITUDE_WAIS_A3 = -(112 + (6.74974/60)); 
  const Double_t ALTITUDE_WAIS_A3 = 1775.68;

  //keeping this around until we can inform people they should use getWais() type calls instead.
  const Double_t LATITUDE_WAIS __attribute__((deprecated)) = - (79 + (27.93728/60));
  const Double_t LONGITUDE_WAIS __attribute__((deprecated)) = -(112 + (6.74974/60));
  const Double_t ALTITUDE_WAIS __attribute__((deprecated)) = 1813.42;


  //Anita 4 location (from Ben Strutt on Slack)
  // And now with an elog note https://www.phys.hawaii.edu/elog/anita_notes/699
  const Double_t LATITUDE_WAIS_A4 = - (-79.468116); 
  const Double_t LONGITUDE_WAIS_A4 = -(112.059258); 
  const Double_t ALTITUDE_WAIS_A4 = 1779.80;

  //Flight independent calls
  Double_t getWaisLatitude();
  Double_t getWaisLongitude();
  Double_t getWaisAltitude();

  // Siple Dome position taken from Steph's e-log
  // https://www.phys.hawaii.edu/elog/anita_notes/595
  const Double_t LATITUDE_SIPLE = - (81 + (39.139/60)); 
  const Double_t LONGITUDE_SIPLE = -(149 + (0.01/60)); 
  // bvv: The next constant is the best I could find at the moment. elog
  // 595 doens't have any information on altitude:
  const Double_t ALTITUDE_SIPLE = 601;

  // LDB position taken from Steph's e-log
  // https://www.phys.hawaii.edu/elog/anita_notes/617
  const Double_t LATITUDE_LDB  = - (77 + (51.23017/60)); 
  const Double_t LONGITUDE_LDB = + (167 + (12.16908/60)); 
  const Double_t ALTITUDE_LDB  = 0.; 

};


// Please note that in order to avoid unnecessarily dependencies during compiling
// I have moved the static adu5 into UsefulAdu5Pat.h. Go look for them there.

// // ANITA-2 values in degrees
// #define STATIC_ADU5_PITCH -0.29
// #define STATIC_ADU5_ROLL 0.89
// #define OFFSET_ADU5_HEADING -0.32


// Number of ANITA payloads.
#define NUM_ANITAS 4


#endif //ANITACONVENTIONS_H