mapcreator_base.h

Go to the documentation of this file.

// Copyright (C) 2011, 2013 Lutz Foucar

/**
 * @file mapcreator_base.h contains base class for all correction map creators.
 *
 * @author Lutz Foucar
 */

#ifndef _MAPCREATORBASE_H_
#define _MAPCREATORBASE_H_

#include <tr1/memory>
#include <vector>

#include "pixeldetector.hpp"

namespace cass
{
class CASSSettings;

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

/** base class for all correction map creators
 *
 * @MapCreateList "none": does nothing to the maps.
 * @GainMapCreateList "none": does nothing to the maps.
 *
 * a map creator will take the frame data that it gets to create correction maps.
 *
 * @author Lutz Foucar
 */
class MapCreatorBase
{
public:
  /** typedef the shared pointer of this */
  typedef std::tr1::shared_ptr<MapCreatorBase> shared_pointer;

  /** the type of storage used */
  typedef std::vector<Detector::frame_t> storage_t;

  /** virtual destructor */
  virtual ~MapCreatorBase();

  /** 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);

  /** build map from frame
   *
   * take the input frame and use its data to build up the correction maps.
   *
   * @param frame the frame containing the data to build the maps from
   */
  virtual void operator() (const Frame &frame);

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

  /** control the calibration process
   *
   * used by the gui to tell the map creators to start the calibration
   */
  virtual void controlCalibration(const std::string& command);
};

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