ProfileWeightFunction.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2005 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/General/Pulsar/ProfileWeightFunction.h
 
#ifndef __Pulsar_ProfileWeightFunction_h
#define __Pulsar_ProfileWeightFunction_h
 
#include "Pulsar/PhaseWeightFunction.h"
 
namespace Pulsar {
 
  class Profile;

  class ProfileWeightFunction : public PhaseWeightFunction 
  {
 
  public:

    ProfileWeightFunction ();

    ProfileWeightFunction (const ProfileWeightFunction&);

    virtual ProfileWeightFunction* clone () const = 0;

    virtual void set_Profile (const Profile*);

    void set_include (PhaseWeight* include);

    void set_exclude (PhaseWeight* include);

    bool consider (unsigned ibin) const;
    
    virtual void get_weight (PhaseWeight* weight);

    virtual PhaseWeight* operate (const Profile*);

    static ProfileWeightFunction* factory (const std::string& name_and_parse);
 
  protected:

    Reference::To<const Profile, false> profile;

    virtual void calculate (PhaseWeight* weight) = 0;

    Reference::To<PhaseWeight> include;

    Reference::To<PhaseWeight> exclude;
 
  };
 
  std::ostream& operator<< (std::ostream&, ProfileWeightFunction*);
 
  std::istream& operator>> (std::istream&, ProfileWeightFunction*&);
 
}
 
 
#endif // !defined __Pulsar_BaselineWeightFunction_h