cspad_mod/include/ElementT.h

Go to the documentation of this file.

#ifndef CSPAD_MOD_ELEMENTT_H
#define CSPAD_MOD_ELEMENTT_H

//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: ElementT.h 5253 2013-01-30 17:56:28Z salnikov@SLAC.STANFORD.EDU $
//
// Description:
//      Class ElementT.
//
//------------------------------------------------------------------------

//-----------------
// C/C++ Headers --
//-----------------

//----------------------
// Base Class Headers --
//----------------------
#include "psddl_psana/cspad.ddl.h"

//-------------------------------
// Collaborating Class Headers --
//-------------------------------

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------

//              ---------------------
//              -- Class Interface --
//              ---------------------

namespace cspad_mod {

/// @addtogroup cspad_mod

/**
 *  @ingroup cspad_mod
 *
 *  @brief Implementation of Psana::CsPad::ElementV* interface for
 *  calibrated data.
 *
 *  This software was developed for the LCLS project.  If you use all or 
 *  part of it, please give an appropriate acknowledgment.
 *
 *  @version $Id: ElementT.h 5253 2013-01-30 17:56:28Z salnikov@SLAC.STANFORD.EDU $
 *
 *  @author Andy Salnikov
 */

template <typename ElemType>
class ElementT : public ElemType {
public:

  typedef ElemType IfaceType;

  enum {
    Nsbtemp = ElemType::Nsbtemp /**< Number of the elements in _sbtemp array. */
  };

  /**
   *  Constructor takes old object and calibrated data.
   *  Data array must be allocated with new[] and will be deallocated in destructor.
   *  Common_mode array is copied, caller keeps ownership.
   */
  ElementT (const ElemType& elem,
      int16_t* data,
      const float* common_mode) ;

  // Destructor
  virtual ~ElementT () ;

  /** Virtual channel number. */
  virtual uint32_t virtual_channel() const { return m_virtual_channel; }
  /** Lane number. */
  virtual uint32_t lane() const { return m_lane; }
  virtual uint32_t tid() const { return m_tid; }
  virtual uint32_t acq_count() const { return m_acq_count; }
  virtual uint32_t op_code() const { return m_op_code; }
  /** Quadrant number. */
  virtual uint32_t quad() const { return m_quad; }
  /** Counter incremented on every event. */
  virtual uint32_t seq_count() const { return m_seq_count; }
  virtual uint32_t ticks() const { return m_ticks; }
  virtual uint32_t fiducials() const { return m_fiducials; }
  virtual ndarray<const uint16_t, 1> sb_temp() const { return make_ndarray(m_sb_temp, Nsbtemp); }
  virtual uint32_t frame_type() const { return m_frame_type; }
  virtual ndarray<const int16_t, 3> data() const { return ndarray<const int16_t, 3>(m_data, m_data_shape); }
  /** Returns section mask for this quadrant. Mask can contain up to 8 bits in the lower byte,
                                total bit count gives the number of sections active. */
  virtual uint32_t sectionMask() const { return m_sectionMask; }
  /** Common mode value for a given section, section number can be 0 to config.numAsicsRead()/2.
                Will return 0 for data read from XTC, may be non-zero after calibration. */
  virtual float common_mode(uint32_t section) const { return m_common_mode[section]; }

protected:

private:

  uint32_t m_virtual_channel;
  uint32_t m_lane;
  uint32_t m_tid;
  uint32_t m_acq_count;
  uint32_t m_op_code;
  uint32_t m_quad;
  uint32_t m_seq_count;
  uint32_t m_ticks;
  uint32_t m_fiducials;
  uint16_t m_sb_temp[Nsbtemp];
  uint32_t m_frame_type;
  int16_t* m_data;
  uint32_t m_sectionMask;
  float m_common_mode[8];
  unsigned m_data_shape[3];

  // Copy constructor and assignment are disabled by default
  ElementT ( const ElementT& ) ;
  ElementT& operator = ( const ElementT& ) ;
};

typedef ElementT<Psana::CsPad::ElementV1> ElementV1;
typedef ElementT<Psana::CsPad::ElementV2> ElementV2;

} // namespace cspad_mod

#endif // CSPAD_MOD_ELEMENTT_H

---