Types.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2002 - 2016 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Util/genutil/Types.h
 
#ifndef __Types_h
#define __Types_h
 
#include "Conventions.h"
#include <string>

namespace Signal {

  enum Dimension {
    Time,
    Frequency,
    Polarization,
    Phase,
    Space
  };
 

  enum Scale {
    EMF,
    Volts,
    Energy,
    Joules,
    FluxDensity,
    ReferenceFluxDensity,
    Jansky
  };
    
  enum Source {
    Unknown,
    Pulsar,
    PolnCal,
    FluxCalOn,
    FluxCalOff,
    Calibrator
  };

  enum State
  {
    Nyquist,
    Analytic,
    Intensity,
    NthPower,
    PPQQ,
    Coherence,
    Stokes,
    PseudoStokes,
    Invariant,
    Other,
    PP_State,
    QQ_State,
    FourthMoment
  };
  
  unsigned State2npol (State s);
  
  const char* source_string (Source source);
  const char* state_string (State state);
  const char* basis_string (Basis basis);
 
  const std::string Source2string (Source source);
  const std::string State2string  (State state);
  const std::string Basis2string  (Basis basis);
  const std::string Scale2string  (Scale scale);
 
  Basis  string2Basis  (const std::string& ss);
  Source string2Source (const std::string& ss);
  State  string2State  (const std::string& ss);
  Scale  string2Scale  (const std::string& ss);

  bool valid_state (State state, unsigned ndim, unsigned npol,
                    std::string& reason);

  State pscrunch (State state);
 
  std::ostream& operator << (std::ostream& ostr, Source source);
  std::istream& operator >> (std::istream& is, Source& source);
 
  std::ostream& operator << (std::ostream& ostr, State state);
  std::istream& operator >> (std::istream& is, State& state);
 
  std::ostream& operator << (std::ostream& ostr, Scale scale);
  std::istream& operator >> (std::istream& is, Scale& scale);
 
}
 
/* note that Basis extraction and insertion operators are defined in
   Conventions.h */
 
#endif