commonmode_calculator_base.h

Go to the documentation of this file.

// Copyright (C) 2011 Lutz Foucar

/**
 * @file commonmode_calculator_base.h contains base class for all common mode
 *                                    calculators.
 *
 * @author Lutz Foucar
 */

#ifndef _COMMONMODECALCULATORBASE_H_
#define _COMMONMODECALCULATORBASE_H_

#include <tr1/memory>

#include "pixeldetector.hpp"

namespace cass
{
class CASSSettings;

namespace pixeldetector
{
//forward declaration//
struct Frame;
class CommonData;

namespace commonmode
{
/** base class for all common mode calculators
 *
 * the calculators determine the common mode of the a user defined part of the
 * row and return the value for correcting the frame.
 *
 * @cassttng PixelDetectors/\%name\%/HLLProcessing/CommonModeCorrection/{Width}\n
 *           How many pixels shoudl be included in the common mode correction.
 *           The width of one Camex is 128 pixels. Sometimes it is better to
 *           to calculate the common mode from the entire quadrant in which case
 *           it should be 512. Default is 128.
 * @cassttng PixelDetectors/\%name\%/HLLProcessing/CommonModeCorrection/{Multiplier}\n
 *           When suppressing pixels in the common mode calculation that contain
 *           photons this is the multiplier that should be added to the noise
 *           before checking for photons. Default is 4
 *
 * @author Lutz Foucar
 */
class CalculatorBase
{
public:
  /** typedef the shared pointer of this */
  typedef std::tr1::shared_ptr<CalculatorBase> shared_pointer;

  /** virtual destructor */
  virtual ~CalculatorBase() {}

  /** create an instance of the requested functor
   *
   * @return a shared pointer to the requested type
   * @param type the reqested type
   */
  static shared_pointer instance(const std::string &type);

  /** determine the common mode value
   *
   * calculate the common mode from the given index on.
   *
   * @return the common mode value
   * @param pixel the start pixel within the frame to start the common mode
   *        calculation
   * @param idx index where the pixel iterator is right now within the frame
   */
  virtual Detector::pixel_t operator() (Detector::frame_t::const_iterator pixel, size_t idx)const=0;

  /** load the settings of this calculator
   *
   * @param s the CASSSettings object to read the information from
   */
  virtual void loadSettings(CASSSettings &s)=0;

  /** load all common settings
   *
   * @param s the CASSSettings object to read the information from
   */
  void load(CASSSettings &s);

  /** retrieve the number of pixels (or the width of calculation */
  size_t width()const {return _nbrPixels;}

protected:
  /** the commonly used data container */
  std::tr1::shared_ptr<CommonData> _commondata;

  /** how many pixels should be used for calculating the common mode */
  size_t _nbrPixels;

  /** the multiplier to identify pixels that contain information */
  float _multiplier;
};

} //end namespace commonmode
} //end namespace pixeldetector
} //end namespace cass
#endif