/*
 This is a proprietary part of DataMelt package.
 License: the Creative Commons Attribution-Share Alike License; either version 3.0 of the License, 
 or any later version.
 http://creativecommons.org/licenses/by-sa/3.0/
 

 Permission to use, copy and modify this software and its documentation for 
 NON-COMMERCIAL purposes is granted, 
 without fee, provided that an acknowledgment to the author, Dr Sergei Chekanov
 appears in all copies and associated documentation or publications.
 

 Redistributions of the source code, or parts of the source codes, 
 must retain the copyright notice, this list of conditions and the following disclaimer 
 (all at the top of each source code) and requires the written permission of Sergei Chekanov
 

 Redistribution in binary form of all or parts of a class must reproduce the 
 copyright notice, this list of conditions and the following disclaimer in the documentation and/or other 
 materials provided with the distribution and requires the written permission of Sergei Chekanov
 

 Details about license agreement  or commercial use are:  http://jwork.org/jhepwork/license.php
 */

package jhpro.stat.limit;




/**
 * Build experiment.
 * Here you can specify observed number of events,
 * background level, error on background and efficiency.
 * 
 * @author S.Chekanov
 *
 */
public class ExpData {

	private int nobs;             // number of events observed 
	private double back;          // estimated background
	private double  errback;      // error on estimated background
	private double fraction;             // efficiency for a channel 
	private double errfraction;          // error on that
	
	
	/**
	 * Simple constructor
	 */
	public ExpData(){
		nobs=0;
		back=0;
		errback=0;
		fraction=1;
		errfraction=0;
	}
	
	
	/**
	 * Build an experiment
	 * @param nobs Number of observed events 
	 * @param back Expected background
	 * @param errback Expected uncertainty on background
	 */
    public ExpData(int nobs, double back, double errback){
    	this(nobs,back,errback,1,0);
    	
    }
	
    
    
    /**
     * Build an experimental data
     * 
     * @param nobs Number of observed events 
     * @param back Expected background
     * @param errback  Expected uncertainty on background
     * @param fraction  efficiency for a channel. Set to 1 for ideal case.
     * @param errfraction error on efficiency. Set to 0
     */
    public ExpData(int nobs, double back, double errback, double fraction, double errfraction ){
    	this.nobs=nobs;
    	this.back= back;
    	this.errback=errback;
    	this.fraction=fraction;
		this.errfraction=errfraction;
    }
    /**
     * Set background number
     * @param back
     */
	public void setBack(double back) {
		this.back = back;
	}
	
	
	/**
	 * Set error on background
	 * @param errback
	 */
	public void setErrBack(double errback) {
		this.errback = errback;
	}


	/**
	 * Set number of observations
	 * @param nobs number of observations
	 */
   public void setNobs(int nobs) {
	this.nobs = nobs;
    }

   
   
   /**
    * Get the expected background
    * @return
    */
    public double getBack() {
		return back;
	}
   
   
    /**
     * Get error on background
     * @return
     */
    public double getErrBack() {
		return errback;
	}
   
   
    /**
     * Get the number of observations
     * @return
     */
     public int getNobs() {
		return nobs;
	}
     
     
     
     /**
      * Get efficiency. Set to 1 if do not know.
      * @return
      */
     public double getFraction() {
		return fraction;
	}
     
     
     /**
      * Get error on efficiency. Set to 1 if do not know.
      * 
      * @return
      */
     public double getErrFraction() {
		return errfraction;
	}
     
}