shiftModel1D.h

Go to the documentation of this file.

#ifndef BALL_NMR_SHIFTMODEL1D_H
#define BALL_NMR_SHIFTMODEL1D_H

#ifndef BALL_NMR_SHIFTMODULE_H
# include <BALL/NMR/shiftModule.h>
#endif

#ifndef BALL_NMR_SPECTRUM_H
  #include <BALL/NMR/spectrum.h>
#endif


namespace BALL 
{
  class BALL_EXPORT ShiftModel1D 
    : public ShiftModule  
  { 
    
    public:
    BALL_CREATE(ShiftModel1D)
    
    

    enum SPECTRUM_TYPE{
      H = 1, 
      N,
      C,
      H_ON_BACKBONE,
      N_BACKBONE,
      C_BACKBONE
    };


    
    ShiftModel1D() 
      throw() ;

    ShiftModel1D(const String& filename,SPECTRUM_TYPE st, bool compute_shifts=true) 
      throw();
        
    ShiftModel1D(const String& filename,SPECTRUM_TYPE st, double origin, double dimension, double spacing, bool compute_shifts=true) 
      throw();
  
    ShiftModel1D(const ShiftModel1D& model)
      throw();

    virtual ~ShiftModel1D()
      throw();
    
    void clear()
      throw();


    
    void setFilename(const String& filename)
      throw(Exception::FileNotFound);

    const String& getFilename() const
      throw() {return parameters_.getFilename();};
    
    const Parameters& getParameters() const
      throw() {return parameters_;};

    const std::vector<Peak1D>& getPeaks() const
      throw() {return peaks_;};
    
    void setPeaks(std::vector<Peak1D> peaks)  
      throw() {peaks_ = peaks;};
      
    
    const double& getOrigin() const
      throw() {return origin_;};
    
    void setOrigin(const double& origin) 
      throw() {origin_ = origin;};
 
    const double& getDimension() const
      throw(){ return dimension_;};

    void setDimension(  const double& dimension) 
      throw() { dimension_ = dimension; }

    const double getSpacing() const
      throw() {return spacing_;};

    void setSystem( System* system)
      throw() {system_ = system;};
  
    const System* getSystem() const
      throw() {return system_;};
    

    void operator >> (Spectrum1D& spectrum)
      throw();


      
    bool isValid() const
      throw();

    


    bool start()
      throw();

    bool finish()
      throw();

    Processor::Result operator () (Composite& composite)
      throw();

  protected:  

      
    /*_ Initialize the model from the parameter file.
        This method assumes that object has a valid parameter file assigned.
        It sets {\tt valid_} to <b>  true </b> if it could create a shift model 
        from the contents of the parameter file.
    */
    bool init_()
      throw(Exception::FileNotFound);

    /*_ The spectrum peaks
     * */
    std::vector<Peak1D> peaks_; 
    
    /*_ The origin of the data
    */
    double             origin_; 
    
    /*_ Dimension of the data
    */
    double             dimension_;  
    
    /*_ spacing of the data
     */
    double             spacing_;
      
    /*_  spectrum type
     * */
    SPECTRUM_TYPE       type_;
    
    /*_ The parameters object ??  Why do we need them???  evtl durch String filename ersetzten
    */
    Parameters        parameters_;

    /*_ pointer to the system
     */
    System*           system_;
    
    /*_ The validity flag.
        Set to <b>  true </b> if the object was initialized correctly.
    */
    bool valid_;

    bool compute_shifts_;

    bool hasType_(Atom* a, SPECTRUM_TYPE type) throw();

  }; // end of class

} // namespace BALL

#endif // BALL_NMR_SHIFTMODEL1D_H

---