REvent/StationConstants.h

Go to the documentation of this file.

#ifndef _revt_StationConstants_h_
#define _revt_StationConstants_h_


namespace revt {

  enum ReconstructionStatus {
    eHasSignal,
    eHasNoSignal,
    eRejected,
    eExcluded
  };


  enum ExcludedReason {
    eNotExcluded                     =  0,
    eManuallyExcluded                =  1,  // RdStationRejector
    // Including missmatch in number of (active) channels.
    // Used in RdChannelADCToVoltageConverter, RdChannelSelector,
    // RdChannelNoiseImporter_AERA, RdAntennaChannelToStationConverter
    eHardwareMismatch                =  2,
    // Not to be confiused with the RejectionStatus eNoNoiseInformationAvailable.
    // Use in RdChannelNoiseImporter_AERA
    eNoNoiseDataAvailable            =  3,
    // For example for a broken LNA in the RdChannelBrokenLNARejector
    eBrokenHardware                  =  4,
    eInBadPeriod                     =  5,  // RdStationRejector, RdChannelNoiseImporter_AERA
    // Typically we do not even initialize RD stations which were not triggered by the WCD.
    // However we can also explictly exclude them. For example in the RdStationSignalInterpolator
    eStationWithoutTrigger           =  6,
    // Simulations with thinned particle cascades can cause artificial
    // noise in pulses with large axis distance. Excluded in RdStationAssociator
    eThinningArtefacts               =  7,
    // Indicates a invalid parity count for recorded traces.
    // This happend due to a firmware bug in the EA-phase of the RD. Set in the EventIO
    eParityError                     =  8,
  };


  // use unsigned long long (like in RdStationRejector.cc) to fit 64 bit number
  enum RejectionStatus {
    eNoRejection                 = 0ULL,
    eManuallyRejected            = (1ULL << 0),

    // Set by Offline Modules
    eBeaconCorrectionFailed      = (1ULL << 1),
    eBadSNR                      = (1ULL << 2),
    eLargeTimeResidual           = (1ULL << 3),
    /* This status is only used internally by the TopDownSelector module,
       the stations that get permanently rejected by the TopDownSelector
      module are flagged as eLargeTimeResidual */
    eTopDownDeselected           = (1ULL << 4),
    ePolarizationDeselected      = (1ULL << 5),
    eLonelyStation               = (1ULL << 6),
    eSignalSearchWindowInvalid   = (1ULL << 7),
    eNoTemperatureCorrection     = (1ULL << 8),
    eCheckFootprintDeselected    = (1ULL << 9),
    eCheckAntennaBackgroundLevel = (1ULL << 10),
    ePulseShapeDeselected        = (1ULL << 11),  // is set by the PulseShapeRejector module
    // is set by the noise importer module if no noise trace for this station could be found
    eNoNoiseInformationAvailable = (1ULL << 12),
    eSaturated                   = (1ULL << 13),  // rejected station because a channel is saturated

    // from BadPeriod DB index starts at 15
    // 15 bit offset for Bad Period database reasons set in RDetector.cc
    eNoCommunication             = (1ULL << 19 ), // 15 +  4 = 19
    eAntennaBroken               = (1ULL << 20 ), // 15 +  5 = 20
    eLNABroken                   = (1ULL << 21 ), // 15 +  6 = 21
    eLNANotCalibrated            = (1ULL << 22 ), // 15 +  7 = 22
    eDigitizerBroken             = (1ULL << 23 ), // 15 +  8 = 23
    eDigitizerNotCalibrated      = (1ULL << 24 ), // 15 +  9 = 24
    eWrongTiming                 = (1ULL << 25 ), // 15 + 10 = 25
    eNoWeatherStationData        = (1ULL << 26 ), // 15 + 11 = 26
    eSelfTriggeredDataCorrupt    = (1ULL << 27 ), // 15 + 12 = 27
    eExtTriggeredDataCorrupt     = (1ULL << 28 ), // 15 + 13 = 28
    eNoisy                       = (1ULL << 29 ), // 15 + 14 = 29

    // from BadPeriod DB for RdMonitoring
    etraceMean_lower             = (1ULL << 30 ), // 15 + 15 = 30
    etraceMean_upper             = (1ULL << 31 ), // 15 + 16 = 31
    etraceRMS_lower              = (1ULL << 32 ), // 15 + 17 = 32
    etraceRMS_upper              = (1ULL << 33 ), // 15 + 18 = 33
    etraceMin_lower              = (1ULL << 34 ), // 15 + 19 = 34
    etraceMin_upper              = (1ULL << 35 ), // 15 + 20 = 35
    etraceMax_lower              = (1ULL << 36 ), // 15 + 21 = 36
    etraceMax_upper              = (1ULL << 37 ), // 15 + 22 = 37
    ePowerInBand_lower           = (1ULL << 38 ), // 15 + 23 = 38
    ePowerInBand_upper           = (1ULL << 39 ), // 15 + 24 = 39
    ePowerOutsideBand_lower      = (1ULL << 40 ), // 15 + 25 = 40
    ePowerOutsideBand_upper      = (1ULL << 41 ), // 15 + 26 = 41
    ePowerAt28MHz_lower          = (1ULL << 42 ), // 15 + 27 = 42
    ePowerAt28MHz_upper          = (1ULL << 43 ), // 15 + 28 = 43
    ePowerAt33MHz_lower          = (1ULL << 44 ), // 15 + 29 = 44
    ePowerAt33MHz_upper          = (1ULL << 45 ), // 15 + 30 = 45
    ePowerAt38MHz_lower          = (1ULL << 46 ), // 15 + 31 = 46
    ePowerAt38MHz_upper          = (1ULL << 47 ), // 15 + 32 = 47
    ePowerAt43MHz_lower          = (1ULL << 48 ), // 15 + 33 = 48
    ePowerAt43MHz_upper          = (1ULL << 49 ), // 15 + 34 = 49
    ePowerAt51MHz_lower          = (1ULL << 50 ), // 15 + 35 = 50
    ePowerAt51MHz_upper          = (1ULL << 51 ), // 15 + 36 = 51
    ePowerAt58MHz_lower          = (1ULL << 52 ), // 15 + 37 = 52
    ePowerAt58MHz_upper          = (1ULL << 53 ), // 15 + 38 = 53
    ePowerAt69MHz_lower          = (1ULL << 54 ), // 15 + 39 = 54
    ePowerAt69MHz_upper          = (1ULL << 55 ), // 15 + 40 = 55
    ePowerAt80MHz_lower          = (1ULL << 56 ), // 15 + 41 = 56
    ePowerAt80MHz_upper          = (1ULL << 57 ), // 15 + 42 = 57
    eTraceOutliers_lower         = (1ULL << 58 ), // 15 + 43 = 58
    eTraceOutliers_upper         = (1ULL << 59 ), // 15 + 44 = 59
    eNarrowBandPeaks_lower       = (1ULL << 60 ), // 15 + 45 = 60
    eNarrowBandPeaks_upper       = (1ULL << 61 ), // 15 + 46 = 61
    eNBeacons_lower              = (1ULL << 62 ), // 15 + 47 = 62
    eNBeacons_upper              = (1ULL << 63 ), // 15 + 48 = 63
    // ( 1<<63 = 9.223.372.036.854.775.808 last available bit in 0 to 2^64-1 space )
    // Further bits from Offline Modules can be added by shifting
    // the offset to lower values here and in RDetector.cc:RDetector::GetBadStationReason().

    eNumRejectionStatusBits      = 64
  };


  static std::map<std::string, RejectionStatus> gMapRejectionStatus{
    { "eNoRejection", eNoRejection },
    { "eManuallyRejected", eManuallyRejected },

    { "eBeaconCorrectionFailed", eBeaconCorrectionFailed },
    { "eBadSNR", eBadSNR },
    { "eLargeTimeResidual", eLargeTimeResidual },
    { "eTopDownDeselected", eTopDownDeselected },
    { "ePolarizationDeselected", ePolarizationDeselected },
    { "eLonleyStation", eLonelyStation },
    { "eSignalSearchWindowInvalid", eSignalSearchWindowInvalid },
    { "eNoTemperatureCorrection", eNoTemperatureCorrection },
    { "eCheckFootprintDeselected", eCheckFootprintDeselected },
    { "eCheckAntennaBackgroundLevel", eCheckAntennaBackgroundLevel },
    { "ePulseShapeDeselected", ePulseShapeDeselected },
    { "eNoNoiseInformationAvailable", eNoNoiseInformationAvailable },
    { "eSaturated", eSaturated },

    { "eNoCommunication", eNoCommunication },
    { "eAntennaBroken", eAntennaBroken },
    { "eLNABroken", eLNABroken },
    { "eLNANotCalibrated", eLNANotCalibrated },
    { "eDigitizerBroken", eDigitizerBroken },
    { "eDigitizerNotCalibrated", eDigitizerNotCalibrated },
    { "eWrongTiming", eWrongTiming },
    { "eNoWeatherStationData", eNoWeatherStationData },
    { "eSelfTriggeredDataCorrupt", eSelfTriggeredDataCorrupt },
    { "eExtTriggeredDataCorrupt", eExtTriggeredDataCorrupt },
    { "eNoisy", eNoisy },

    { "etraceMean_lower", etraceMean_lower },
    { "etraceMean_upper", etraceMean_upper },
    { "etraceRMS_lower", etraceRMS_lower },
    { "etraceRMS_upper", etraceRMS_upper },
    { "etraceMin_lower", etraceMin_lower },
    { "etraceMin_upper", etraceMin_upper },
    { "etraceMax_lower", etraceMax_lower },
    { "etraceMax_upper", etraceMax_upper },
    { "ePowerInBand_lower", ePowerInBand_lower },
    { "ePowerInBand_upper", ePowerInBand_upper },
    { "ePowerOutsideBand_lower", ePowerOutsideBand_lower },
    { "ePowerOutsideBand_upper", ePowerOutsideBand_upper },
    { "ePowerAt28MHz_lower", ePowerAt28MHz_lower },
    { "ePowerAt28MHz_upper", ePowerAt28MHz_upper },
    { "ePowerAt33MHz_lower", ePowerAt33MHz_lower },
    { "ePowerAt33MHz_upper", ePowerAt33MHz_upper },
    { "ePowerAt38MHz_lower", ePowerAt38MHz_lower },
    { "ePowerAt38MHz_upper", ePowerAt38MHz_upper },
    { "ePowerAt43MHz_lower", ePowerAt43MHz_lower },
    { "ePowerAt43MHz_upper", ePowerAt43MHz_upper },
    { "ePowerAt51MHz_lower", ePowerAt51MHz_lower },
    { "ePowerAt51MHz_upper", ePowerAt51MHz_upper },
    { "ePowerAt58MHz_lower", ePowerAt58MHz_lower },
    { "ePowerAt58MHz_upper", ePowerAt58MHz_upper },
    { "ePowerAt69MHz_lower", ePowerAt69MHz_lower },
    { "ePowerAt69MHz_upper", ePowerAt69MHz_upper },
    { "ePowerAt80MHz_lower", ePowerAt80MHz_lower },
    { "ePowerAt80MHz_upper", ePowerAt80MHz_upper },
    { "eTraceOutliers_lower", eTraceOutliers_lower },
    { "eTraceOutliers_upper", eTraceOutliers_upper },
    { "eNarrowBandPeaks_lower", eNarrowBandPeaks_lower },
    { "eNarrowBandPeaks_upper", eNarrowBandPeaks_upper },
    { "eNBeacons_lower", eNBeacons_lower },
    { "eNBeacons_upper", eNBeacons_upper }
  };

}


#endif