psddl_psana/include/pnccd.ddl.h

Go to the documentation of this file.

#ifndef PSANA_PNCCD_DDL_H
#define PSANA_PNCCD_DDL_H 1

// *** Do not edit this file, it is auto-generated ***

#include <vector>
#include <iosfwd>
#include <cstring>
#include "ndarray/ndarray.h"
#include "pdsdata/xtc/TypeId.hh"
namespace Psana {
namespace PNCCD {

/** @class ConfigV1

  pnCCD configuration class ConfigV1
*/


class ConfigV1 {
public:
  enum { TypeId = Pds::TypeId::Id_pnCCDconfig /**< XTC type ID value (from Pds::TypeId class) */ };
  enum { Version = 1 /**< XTC type version number */ };
  virtual ~ConfigV1();
  /** Number of links in the pnCCD. */
  virtual uint32_t numLinks() const = 0;
  /** Size of the payload in bytes for single link */
  virtual uint32_t payloadSizePerLink() const = 0;
};

/** @class ConfigV2

  pnCCD configuration class ConfigV2
*/


class ConfigV2 {
public:
  enum { TypeId = Pds::TypeId::Id_pnCCDconfig /**< XTC type ID value (from Pds::TypeId class) */ };
  enum { Version = 2 /**< XTC type version number */ };
  virtual ~ConfigV2();
  /** Number of links in the pnCCD. */
  virtual uint32_t numLinks() const = 0;
  /** Size of the payload in bytes for single link */
  virtual uint32_t payloadSizePerLink() const = 0;
  /** Number of channels */
  virtual uint32_t numChannels() const = 0;
  /** Number of rows */
  virtual uint32_t numRows() const = 0;
  /** Number of submodule channels */
  virtual uint32_t numSubmoduleChannels() const = 0;
  /** Number of submodule rows */
  virtual uint32_t numSubmoduleRows() const = 0;
  /** Number of submodules */
  virtual uint32_t numSubmodules() const = 0;
  /** Magic word from CAMEX */
  virtual uint32_t camexMagic() const = 0;
  /** Information data string */
  virtual const char* info() const = 0;
  /** Timing file name string */
  virtual const char* timingFName() const = 0;
  /** Method which returns the shape (dimensions) of the data returned by info() method. */
  virtual std::vector<int> info_shape() const = 0;
  /** Method which returns the shape (dimensions) of the data returned by timingFName() method. */
  virtual std::vector<int> timingFName_shape() const = 0;
};

/** @class FrameV1

  pnCCD class FrameV1, this is a class which is defined by origianl pdsdata package.
*/

class ConfigV1;
class ConfigV2;

class FrameV1 {
public:
  virtual ~FrameV1();
  /** Special values */
  virtual uint32_t specialWord() const = 0;
  /** Frame number */
  virtual uint32_t frameNumber() const = 0;
  /** Most significant part of timestamp */
  virtual uint32_t timeStampHi() const = 0;
  /** Least significant part of timestamp */
  virtual uint32_t timeStampLo() const = 0;
  /** Frame data */
  virtual ndarray<const uint16_t, 1> _data() const = 0;
  virtual ndarray<const uint16_t, 2> data() const = 0;
};

/** @class FullFrameV1

  This is a "synthetic" pnCCD frame which is four original 512x512 frames
            glued together. This class does not exist in original pdsdata, it has been 
            introduced to psana to simplify access to full frame data in the user code.
*/


class FullFrameV1 {
public:
  enum { TypeId = Pds::TypeId::Id_pnCCDframe /**< XTC type ID value (from Pds::TypeId class) */ };
  enum { Version = 1 /**< XTC type version number */ };
  virtual ~FullFrameV1();
  /** Special values */
  virtual uint32_t specialWord() const = 0;
  /** Frame number */
  virtual uint32_t frameNumber() const = 0;
  /** Most significant part of timestamp */
  virtual uint32_t timeStampHi() const = 0;
  /** Least significant part of timestamp */
  virtual uint32_t timeStampLo() const = 0;
  /** Full frame data, image size is 1024x1024. */
  virtual ndarray<const uint16_t, 2> data() const = 0;
};

/** @class FramesV1

  pnCCD class FramesV1 which is a collection of FrameV1 objects, number of 
            frames in collection is determined by numLinks() method (which should return 4 
            in most cases). This class does not exist in original pdsdata, has been 
            introduced to psana to help in organizing 4 small pnCCD frames together.
*/

class ConfigV1;
class ConfigV2;

class FramesV1 {
public:
  enum { TypeId = Pds::TypeId::Id_pnCCDframe /**< XTC type ID value (from Pds::TypeId class) */ };
  enum { Version = 1 /**< XTC type version number */ };
  virtual ~FramesV1();
  /** Number of frames is determined by numLinks() method. */
  virtual const PNCCD::FrameV1& frame(uint32_t i0) const = 0;
  virtual uint32_t numLinks() const = 0;
  /** Method which returns the shape (dimensions) of the data returned by frame() method. */
  virtual std::vector<int> frame_shape() const = 0;
};
} // namespace PNCCD
} // namespace Psana
#endif // PSANA_PNCCD_DDL_H

---