tdcbase.h

Go to the documentation of this file.

/******************************************************************************
 *
 *  Project:        quTAG Control Library
 *
 *  Filename:       tdcbase.h
 *
 *  Purpose:        Control and data acquisition functions for TDC
 *
 *  Author:         NHands GmbH & Co KG
 */
/*****************************************************************************/
/*****************************************************************************/
/* $Id: tdcbase.h,v 1.15 2019/11/29 13:25:13 trurl Exp $ */

#ifndef __TDCBASE_H
#define __TDCBASE_H

#include "tdcdecl.h"

#define TDC_QUTAG_CHANNELS   5   
#define TDC_COINC_CHANNELS  31   
#define TDC_MAX_CHANNEL_NO  20   
typedef enum {
  DEVTYPE_QUTAG,                 
  DEVTYPE_NONE                   
} TDC_DevType;


typedef enum {
  FEATURE_HBT       = 0x0001,    /*< HBT software functions */
  FEATURE_LIFETIME  = 0x0002,    /*< Lifetime software functions */
  FEATURE_3_CHAN    = 0x0004,    /*< Input channel 3 enabled */
  FEATURE_4_CHAN    = 0x0008,    /*< Input channels 3 & 4 enabled */
  FEATURE_5_CHAN    = 0x0010,    /*< Start channel may be used as channel 5 */
  FEATURE_MARKERS   = 0x0020,    /*< Marker input */
  FEATURE_FILTERS   = 0x0040,    /*< Event filters for timestamp stream */
  FEATURE_EXTCLK    = 0x0080,    /*< External clock enabled */
  FEATURE_DEVSYNC   = 0x0100,    /*< Synchronisation of multiple devices */
  FEATURE_HIRES     = 0x0200     /*< Jitter upgrade / high resolution */
} TDC_FeatureFlag;

typedef Int32 TDC_FeatureFlags;


typedef enum {
  FORMAT_ASCII,                  
  FORMAT_BINARY,                 
  FORMAT_COMPRESSED,             
  FORMAT_RAW,                    
  FORMAT_NONE                    
} TDC_FileFormat;


typedef enum {
  SCOND_LVTTL = 1,               
  SCOND_NIM   = 2,               
  SCOND_MISC  = 3,               
  SCOND_NONE  = 4                
} TDC_SignalCond;


typedef enum {
  FILTER_NONE,                   
  FILTER_MUTE,                   
  FILTER_COINC,                  
  FILTER_SYNC,                   
  FILTER_INVALID                 
} TDC_FilterType;


typedef enum {
  SIM_FLAT,                      
  SIM_NORMAL,                    
  SIM_NONE                       
} TDC_SimType;



TDC_API double TDC_CC TDC_getVersion();


TDC_API const char * TDC_CC TDC_perror( int rc );


TDC_API int TDC_CC TDC_getTimebase( double * timebase );


TDC_API int TDC_CC TDC_init( int deviceId );


TDC_API int TDC_CC TDC_deInit();


TDC_API TDC_DevType TDC_CC TDC_getDevType();


TDC_API Bln32 TDC_CC TDC_checkFeatureHbt();


TDC_API Bln32 TDC_CC TDC_checkFeatureLifeTime();


TDC_API TDC_FeatureFlags TDC_CC TDC_checkFeatures();


TDC_API int TDC_CC TDC_getClockState( Bln32 * locked,
                                      Bln32 * uplink );


TDC_API int TDC_CC TDC_getChainPosition( Int32 * position,
                                         Int32 * length );


TDC_API int TDC_CC TDC_setChannelLink( Bln32 on );


TDC_API int TDC_CC TDC_getChannelLink( Bln32 * on );


TDC_API int TDC_CC TDC_setFiveChannelMode( Bln32 on );


TDC_API int TDC_CC TDC_getFiveChannelMode( Bln32 * on );


TDC_API int TDC_CC TDC_preselectSingleStop( Bln32 single );


TDC_API int TDC_CC TDC_getSingleStopPreselection( Bln32 * single );


TDC_API int TDC_CC TDC_startCalibration();


TDC_API int TDC_CC TDC_getCalibrationState( Bln32 * active );


TDC_API int TDC_CC TDC_enableChannels( Int32 channelMask );


TDC_API int TDC_CC TDC_getChannelsEnabled( Int32 * channelMask );


TDC_API int TDC_CC TDC_enableMarkers( Int32 markerMask );


TDC_API int TDC_CC TDC_getMarkersEnabled( Int32 * markerMask );


TDC_API int TDC_CC TDC_configureSignalConditioning( Int32          channel,
                                                    TDC_SignalCond conditioning,
                                                    Bln32          edge,
                                                    double         threshold );


TDC_API int TDC_CC TDC_getSignalConditioning( Int32    channel,
                                              Bln32  * edge,
                                              double * threshold );


TDC_API int TDC_CC TDC_configureSyncDivider( Int32 divider,
                                             Bln32 reconstruct );


TDC_API int TDC_CC TDC_getSyncDivider( Int32 * divider,
                                       Bln32 * reconstruct );


TDC_API int TDC_CC TDC_setCoincidenceWindow( Int32 coincWin );


TDC_API int TDC_CC TDC_configureFilter( Int32          channel,
                                        TDC_FilterType type,
                                        Int32          chMask );


TDC_API int TDC_CC TDC_getFilter( Int32            channel,
                                  TDC_FilterType * type,
                                  Int32          * chMask );


TDC_API int TDC_CC TDC_setExposureTime( Int32 expTime );


TDC_API int TDC_CC TDC_getDeviceParams( Int32 * coincWin,
                                        Int32 * expTime   );


TDC_API int TDC_CC TDC_setChannelDelays( const Int32 * delays );


TDC_API int TDC_CC TDC_getChannelDelays( Int32 * delays );


TDC_API int TDC_CC TDC_setDeadTime( Int32 channel,
                                    Int32 dTime );


TDC_API int TDC_CC TDC_getDeadTime( Int32 channel,
                                    Int32 * dTime );


TDC_API int TDC_CC TDC_configureSelftest( Int32 channelMask,
                                          Int32 period,
                                          Int32 burstSize,
                                          Int32 burstDist );

TDC_API int TDC_CC TDC_getDataLost( Bln32 * lost );


TDC_API int TDC_CC TDC_setTimestampBufferSize( Int32 size );


TDC_API int TDC_CC TDC_getTimestampBufferSize( Int32 * size );


TDC_API int TDC_CC TDC_enableTdcInput( Bln32 enable );


TDC_API int TDC_CC TDC_freezeBuffers( Bln32 freeze );


TDC_API int TDC_CC TDC_getCoincCounters( Int32 * data, Int32 * updates );


TDC_API int TDC_CC TDC_getLastTimestamps( Bln32   reset,
                                          Int64 * timestamps,
                                          Uint8 * channels,
                                          Int32 * valid );


TDC_API int TDC_CC TDC_writeTimestamps( const char *   filename,
                                        TDC_FileFormat format );


TDC_API int TDC_CC TDC_inputTimestamps( const Int64 * timestamps,
                                        const Uint8 * channels,
                                        Int32         count );


TDC_API int TDC_CC TDC_readTimestamps( const char *   filename,
                                       TDC_FileFormat format );


TDC_API int TDC_CC TDC_generateTimestamps( TDC_SimType type,
                                           double *    par,
                                           Int32       count );

#endif