FluxCalManager.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2012 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Polarimetry/Pulsar/FluxCalManager.h
 
#ifndef __Calibration_FluxCalManager_H
#define __Calibration_FluxCalManager_H
 
#include "Pulsar/SourceDeltaEstimate.h"
#include "Pulsar/BackendEstimate.h"
#include "Pulsar/SignalPath.h"
 
namespace Calibration
{

  class FluxCalObservation : public Reference::Able
  {
  public:
 
    void update ();

    Signal::Source source_type; 


    Reference::To<BackendEstimate> backend;

    Reference::To<SourceEstimate> source;
  };
 
  typedef std::vector< Reference::To<FluxCalObservation> > FluxCalObsVector;
    

 
  class FluxCalManager : public Reference::Able
  {
  public:

    FluxCalManager (SignalPath* composite);

    void set_backend (const MEAL::Complex2*);

    void add_observation (Signal::Source type);

    void integrate (Signal::Source type, const MEAL::Complex2*);

    void integrate (const Jones< Estimate<double> >& correct, const SourceObservation& data);
 
    void submit (CoherencyMeasurementSet&, const SourceObservation&);

    unsigned get_nstate_on () const;

    const SourceEstimate* get_source_on (unsigned istate) const;
    
    unsigned get_nstate_off () const;
    
    const SourceEstimate* get_source_off (unsigned istate) const;
    
    void update ();

    bool is_constrained () const;

    const std::string& why_not_constrained () const { return not_constrained_reason; }
 
    void allow_StokesV_to_vary (bool flag = true);
    void model_multiple_source_states (bool flag = true);
    void model_on_minus_off (bool flag = true);
    
  protected:

    void add_backend (FluxCalObservation*);

    void add_source (FluxCalObservation*);

    Reference::To< MEAL::Complex2 > backend;

    Reference::To< MEAL::ProductRule<MEAL::Complex2> > frontend;
    
    Reference::To< SignalPath > composite;

    FluxCalObsVector on_observations;

    FluxCalObsVector off_observations;


    Reference::To<SourceDeltaEstimate> standard_candle;
    
    FluxCalObsVector& get_observations (Signal::Source source_type);

    void set_StokesV_infit (FluxCalObsVector&);

    SourceEstimate* create_SourceEstimate (Signal::Source);
 
  private:
 
    bool multiple_source_states = false;
    bool subtract_off_from_on = false;
    bool StokesV_may_vary = false;
 
    mutable std::string not_constrained_reason;
  };
 
}
 
#endif