Appendix  

Tag Dictionary

  [Related Topics]   

Field Identifier Indexed Field Type Length MeasTyp / File Typ Loading mand. Remarks Default
<File Preamble 1 (no tag)> no Preamble =08 all std. mand. File Magic e.g. "PQTTTR", "PQRESLT" or "PQCOMNT"
filled up with char(0)

<File Preamble 2 (no tag)> no Preamble =08 all std. mand. Format Version
<File Header>







File_GUID no ASCII-String =40 all fast mand. "{%8.8X-%4.4X-%4.4X-%4.4X-%12.12X}"
File_AssuredContent no ASCII-String
PTU/PHU fast opt. TCSPC type, followed by optional token for the assured presence of SW-settings, HW-settings and binary data
File_Comment no Wide-String
ASCII-String

all fast opt.

File_CreatingTime no TDateTime
ASCII-String

all fast opt.

File_EditedBy no ASCII-String
PFS/PUS/PCO std. opt. mainly for defaults settings and/or comments
File_RawData_GUID may be ASCII-String =40 PQRES fast opt. "{%8.8X-%4.4X-%4.4X-%4.4X-%12.12X}"
File_ParentResult_GUID may be ASCII-String =40 PQRES fast opt. "{%8.8X-%4.4X-%4.4X-%4.4X-%12.12X}"
Measurement_Mode no Int8
PTU/PHU std. mand. HIST, Resrv1, T2, T3, Resrv4-7, CONT
Measurement_SubMode no Int8
PTU/PHU fast mand. OSC, INT, TRES, IMG
Fast_Load_End no Empty8
all fast opt. All "fast" tags are stored before this tags. For fast viewing of files only the Tags until this Tag are loaded. Useful for Workspace loading. If missing, all tags are loaded.
Header_End no Empty8
all std. mand. End of Header
<Creator Software>







CreatorSW_Name no ASCII-String
all std. opt.

CreatorSW_Version no ASCII-String
all std. opt.

CreatorSW_SVNBuild no Int8
all std. opt.

CreatorSW_ContentVersion no ASCII-String
all std. opt. for converted files: FormatVersion of the source file
CreatorSW_Modules no Int8
all std. opt. Modules Count (for DLLs, etc.)
CreatorSW_ModuleName 0…CreatorSW_Modules−1 ASCII-String
all std. opt.

CreatorSW_ModuleVers 0…CreatorSW_Modules−1 ASCII-String
all std. opt.

<Remote Request Data>


PTU

all parameters received via TCP/IP with a meas.request
$StartedByRemoteInterface no Bool8
PTU fast on req. identifies if request received via TCP/IP
$ReqHdr_RecordVersion no Int8
PTU std. on req. identifies record format transferred via TCP/IP
$ReqHdr_MeasurementType no Int8
PTU std. on req. identifies measurement type
$ReqHdr_PixelNumber_X no Int8
PTU(IMG) std. on req. number of pixels in X
$ReqHdr_PixelNumber_Y no Int8
PTU(IMG) std. on req. number of pixels in Y
$ReqHdr_ScanningPattern no Int8
PTU(IMG) std. on req. 0: mono-dir.; 1: bi-dir.
$ReqHdr_SpatialResolution no Float8
PTU(IMG) std. on req. [µm/px]
$Groupname no ASCII-String
PTU std. opt. optional parameter received via TCP/IP
$Filename no ASCII-String
PTU std. opt. optional parameter received via TCP/IP
$Comment no ASCII-String
PTU std. opt. optional parameter received via TCP/IP
$<Ident> may be <all_types>
PTU std. opt. all other optional parameters received via TCP/IP
<Hardware Header>







HW_Type no ASCII-String
PTU/PHU std. opt. "PicoHarp", "HydraHarp", "TH260P", "TH260N"
HW_PartNo no ASCII-String
PTU/PHU std. opt.

HW_SerialNo no ASCII-String
PTU/PHU std. opt.

HW_Version no ASCII-String
PTU/PHU std. opt.

HW_BaseResolution no Float8
PTU/PHU std. opt. [ps]
HW_Modules no Int8
PTU/PHU std. opt. for PicoHarp = 1
HWModule_TypeCode 0…HW_Modules−1 Int8
PTU/PHU std. opt. for PicoHarp: Digital=1000, Analog=1040
HWModule_VersCode 0…HW_Modules−1 Int8
PTU/PHU std. opt. for PicoHarp = BCD (HW_Version)
HWSync_Divider no Int8
PTU/PHU std. opt. binary power
HWSync_CFDLevel no Int8
PTU/PHU std. opt. [mV]
HWSync_CFDZeroCross no Int8
PTU/PHU std. opt. [mV]
HWSync_Offset no Int8
PTU/PHU std. opt. [ps]
HW_InputChannels no Int8
PTU/PHU std. opt.

HWInputChan_Enabled 0…HW_InputChannels−1 Bool8
PTU/PHU std. opt.
true
HWInputChan_ModuleIdx 0…HW_InputChannels−1 Int8
PTU/PHU std. opt. 1…HW_Modules
HWInputChan_CFDLevel 0…HW_InputChannels−1 Int8
PTU/PHU std. opt. [mV]
HWInputChan_CFDZeroCross 0…HW_InputChannels−1 Int8
PTU/PHU std. opt. [mV]
HWInputChan_Offset 0…HW_InputChannels−1 Int8
PTU/PHU std. opt. [ps] 0
HW_ExternalRefClock no Bool8
PTU/PHU std. opt.

HW_ExternalDevices no Int8
PTU/PHU std. opt. ???
HW_Markers no Int8
PTU/PHU std. opt.

HWMarkers_Enabled 0…HW_Markers−1 Bool8
PTU/PHU std. opt.
true
HWMarkers_RisingEdge 0…HW_Markers−1 Bool8
PTU/PHU std. opt.

HWRouter_ModelCode no Int8
PTU/PHU std. opt. None, PHR_402 , PHR_403, PHR_800
HWRouter_Version no ASCII-String
PTU/PHU std. opt.

HWRouter_Enabled no Bool8
PTU/PHU std. opt.
false
HWRouter_Channels no Int8
PTU/PHU std. opt.

HWRouterChan_InputType 0…HWRouter_Channels−1 Int8
PTU/PHU std. opt. Custom, NIM, TTL
HWRouterChan_InputLevel 0…HWRouter_Channels−1 Int8
PTU/PHU std. opt. [mV]
HWRouterChan_RisingEdge 0…HWRouter_Channels−1 Bool8
PTU/PHU std. opt.

HWRouterChan_CFDPresent 0…HWRouter_Channels−1 Bool8
PTU/PHU std. opt.

HWRouterChan_CFDLevel 0…HWRouter_Channels−1 Int8
PTU/PHU std. opt. only if present [mV]
HWRouterChan_CFDZeroCross 0…HWRouter_Channels−1 Int8
PTU/PHU std. opt. only if present [mV]
HWRouterChan_Offset 0…HWRouter_Channels−1 Int8
PTU/PHU std. opt. [ps]
<Measurement Description>







MeasDesc_BinningFactor no Int8
PTU/PHU std. opt. expanded, to support non-binary factors 1
MeasDesc_GlobalResolution no Float8
PTU std. mand. resolution of time tag(s) Should be used to calculate the global arrival time for records [s]
MeasDesc_Resolution no Float8
PTU/PHU std. mand. resolution of TCSPC [s]
MeasDesc_InvalidSync no Bool8
PTU(T3+IMG) std. opt. true, if (SYNC = 0) on measurement start
MeasDesc_Offset no Int8
PTU/PHU std. opt. [ns]
MeasDesc_AcquisitionTime no Int8
PTU/PHU std. opt. [ms]
MeasDesc_StopAt no Int8
PHU std. opt. [cnt]
MeasDesc_StopOnOvfl no Bool8
PHU std. opt.

MeasDesc_Restart no Bool8
PHU std. opt.

MeasDesc_Params no Int8
PHU std. opt.

MeasDesc_Param_Name 0…MeasDesc_Params−1 ASCII-String
PHU std. opt. name as shown in dialogs or plots
MeasDesc_Param_TagName 0…MeasDesc_Params−1 ASCII-String
PHU std. opt. must start with "Par";
has to comply to all tag name conventions

MeasDesc_Param_Unit 0…MeasDesc_Params−1 ASCII-String
PHU std. opt. including prefix if used, e.g. "nm" for wavelengths
MeasDesc_Param_Start 0…MeasDesc_Params−1 Float8
PHU std. opt.

MeasDesc_Param_Step 0…MeasDesc_Params−1 Float8
PHU std. opt.

MeasDesc_Param_Stop 0…MeasDesc_Params−1 Float8
PHU std. opt.

ImgHdr_Dimensions no Int8
PTU(IMG) std. opt. Resrv0-1, LINE, AREA
ImgHdr_Ident no Int8
PTU(IMG) std. opt. Resrv0, PI_E710, Resrv2, LSM, KDT180–100–lm
ImgHdr_BiDirect no Bool8
PTU(IMG) std. opt. TRUE = Bidirectional scanning pattern (Odd lines forward, even lines backward scan direction)
FALSE = Monodirectional scanning pattern (all lines forward scan direction)

ImgHdr_TimePerPixel no Int8
PTU(IMG) std. opt. Dwell time for single pixel [ms]. Needed to calculate the pixel position inside the line from the global arrival time.
ImgHdr_Acceleration no Int8
PTU(IMG) std. opt. Only in converted TTTR image files recorded with PI E710 Scanner. NOT needed for analysing the Image because the Marker are repositioned when the files are converted.
ImgHdr_X0 no Float8
PTU std. opt. Point Measurements: X Position of the Point measured (if a scanner available)
Image Measurements: X Start Position of Image (upper left corner)
[μm]

ImgHdr_Y0 no Float8
PTU std. opt. Point Measurements: Y Position of the Point measured (if a scanner available)
Image Measurements: Y Start Position of Image (upper left corner)
[μm]

ImgHdr_Z0 no Float8
PTU std. opt. Point Measurements: Z Position of the Point measured (if a scanner available)
Image Measurements: Z Start Position of Image (upper left corner)
[μm]

ImgHdr_PixX no Int8
PTU(IMG) std. opt. Numbers of Pixels in the X picture direction of the Image. Attention this means the picture not the scanner direction Check ImgHdr_ScanDirection to get the assignment picture to scanner direction.
ImgHdr_PixY no Int8
PTU(IMG) std. opt. Numbers of Pixels in the Y picture direction of the Image. Attention this means the picture not the scanner direction Check ImgHdr_ScanDirection to get the assignment picture to scanner direction.
ImgHdr_PixResol no Float8
PTU(IMG) std. opt. Spatial size of one pixel [μm/px]
ImgHdr_TStartTo no Float8
PTU(IMG) std. opt. Only in converted TTTR image files recorded with PI E710 Scanner. NOT needed for analysing the Image because the Marker are repositioned when the files are converted.
ImgHdr_TStopTo no Float8
PTU(IMG) std. opt. Only in converted TTTR image files recorded with PI E710 Scanner. NOT needed for analysing the Image because the Marker are repositioned when the files are converted.
ImgHdr_TStartFro no Float8
PTU(IMG) std. opt. Only in converted TTTR image files recorded with PI E710 Scanner. NOT needed for analysing the Image because the Marker are repositioned when the files are converted.
ImgHdr_TStopFro no Float8
PTU(IMG) std. opt. Only in converted TTTR image files recorded with PI E710 Scanner. NOT needed for analysing the Image because the Marker are repositioned when the files are converted.
ImgHdr_Velocity no Int8
PTU(IMG) std. opt. Only in converted TTTR image files recorded with PI E710 Scanner.
ImgHdr_Frame no Int8
PTU(IMG) std. opt. Marker index for frame separation.
ImgHdr_LineStart no Int8
PTU(IMG) std. opt. Marker index for start of a line.
ImgHdr_LineStop no Int8
PTU(IMG) std. opt. Marker index for end of a line.
ImgHdr_ScanDirection no Int8
PTU(IMG) std. opt. Scan pattern of image scan
"X direction in Picture(fast scan) - Y direction in picture (slow scan)"
"X-Y"=0, "X-Z"=1, "Y-Z"=2

ImgHdr_LearningTime no Int8
PTU(IMG) std. opt. time used for learning cycles when using PI E710 scan controller [sec]
ImgHdr_SinCorrection no Int8
PTU(IMG) std. opt. Sinusoidal correction for images, given as percentage of the sine ordinate used for an image line. [%]
<TT Measurement Results>







TTResult_SyncRate no Int8
PTU std. mand. Sync rate at start of measurement, to get the resolution for T3 tags use MeasDesc_GlobalResolution
TTResult_InputRate 0…HW_InpChannels−2 Int8
PTU std. opt.

TTResult_StopAfter no Int8
PTU std. opt. [ms]
TTResult_StopReason no Int8
PTU std. opt. TimeOver, Manual, Overflow, Error
TTResult_NumberOfRecords no Int8
PTU std. mand. Number of TTTR Records in the <Binary Data> Block directly after the Header section.
<Histo Measurement Results>







HistoResult_BitsPerBin no Int8
PHU std. mand.
32
HistoResult_NumberOfCurves no Int8
PHU std. mand.

<TT Results Format>







TTResultFormat_TTTRRecType no Int8
PTU std. mand. TTTR record type, containing coded information on the TCSPC used, the type of measurement and the HWLib version. Refer to TTTR records for more information.
TTResultFormat_BitsPerRecord no Int8
PTU std. mand. Numbers of Bits in one TTTR Record. All current record formats consist of 32 bit records (= 4 Bytes per TTTR record). 32
<Histo Result Descriptor>







HistResDscr_CurveIndex 0…NumberOfCurves−1 Int8
PHU std. opt.

HistResDscr_TimeOfRecording 0…NumberOfCurves−1 TDateTime
PHU std. opt.

HistResDscr_HWType 0…NumberOfCurves−1 ASCII-String
PHU std. opt. "PicoHarp", "HydraHarp", "TH260P", "TH260N"
HistResDscr_HWPartNo 0…NumberOfCurves−1 ASCII-String
PHU std. opt.

HistResDscr_HWSerialNo 0…NumberOfCurves−1 ASCII-String
PHU std. opt.

HistResDscr_HWVersion 0…NumberOfCurves−1 ASCII-String
PHU std. opt.

HistResDscr_HWBaseResolution 0…NumberOfCurves−1 Float8
PHU std. opt. [ps]
HistResDscr_HWModules 0…NumberOfCurves−1 Int8
PHU std. opt. for PicoHarp = 1
HistResDscr_HWModuleTypeCode<mm> 0…NumberOfCurves−1 Int8
PHU std. opt. <mm> = 00…HW_Modules−1;
for PicoHarp = 0

HistResDscr_HWModuleVersCode<mm> 0…NumberOfCurves−1 Int8
PHU std. opt. <mm> = 00…HW_Modules−1;
for PicoHarp = HW_Version

HistResDscr_HWSyncDivider 0…NumberOfCurves−1 Int8
PHU std. opt. binary power
HistResDscr_HWSyncCFDLevel 0…NumberOfCurves−1 Int8
PHU std. opt. [mV]
HistResDscr_HWSyncCFDZeroCross 0…NumberOfCurves−1 Int8
PHU std. opt. [mV]
HistResDscr_HWSyncOffset 0…NumberOfCurves−1 Int8
PHU std. opt. [ps]
HistResDscr_HWInpChanIdx 0…NumberOfCurves−1 Int8
PHU std. opt.

HistResDscr_HWInpChanModuleIdx 0…NumberOfCurves−1 Int8
PHU std. opt. 1…HW_Modules
HistResDscr_HWInpChanCFDLevel 0…NumberOfCurves−1 Int8
PHU std. opt. [mV]
HistResDscr_HWInpChanCFDZCross 0…NumberOfCurves−1 Int8
PHU std. opt. [mV]
HistResDscr_HWInpChanOffset 0…NumberOfCurves−1 Int8
PHU std. opt. [ps]
HistResDscr_HWExternalRefClock 0…NumberOfCurves−1 Bool8
PHU std. opt.

HistResDscr_HWExternalDevices 0…NumberOfCurves−1 BitSet64
PHU std. opt. ???
HistResDscr_HWMarkers 0…NumberOfCurves−1 Int8
PHU std. opt.

HistResDscr_HWMarkersEnabled 0…NumberOfCurves−1 BitSet64
PHU std. opt. LSB = Marker0
HistResDscr_HWMarkersRising 0…NumberOfCurves−1 BitSet64
PHU std. opt. LSB = Marker0
HistResDscr_HWRouterModelCode 0…NumberOfCurves−1 Int8
PHU std. opt. None, PHR_402 , PHR_403, PHR_800
HistResDscr_HWRouterEnabled 0…NumberOfCurves−1 Bool8
PHU std. opt.

HistResDscr_HWRouterChannelIdx 0…NumberOfCurves−1 Int8
PHU std. opt.

HistResDscr_HWRtChanInputType 0…NumberOfCurves−1 Int8
PHU std. opt. Custom, NIM, TTL
HistResDscr_HWRtChanInputLevel 0…NumberOfCurves−1 Int8
PHU std. opt. [mV]
HistResDscr_HWRtChanRisingEdge 0…NumberOfCurves−1 Bool8
PHU std. opt.

HistResDscr_HWRtChanCFDPresent 0…NumberOfCurves−1 Bool8
PHU std. opt.

HistResDscr_HWRtChanCFDLevel 0…NumberOfCurves−1 Int8
PHU std. opt. only if present [mV]
HistResDscr_HWRtChanCFDZCross 0…NumberOfCurves−1 Int8
PHU std. opt. only if present [mV]
HistResDscr_MDescBinningFactor 0…NumberOfCurves−1 Int8
PHU std. opt. expanded, to support non-binary factors 1
HistResDscr_MDescResolution 0…NumberOfCurves−1 Float8
PHU std. mand. [ps]
HistResDscr_MDescOffset 0…NumberOfCurves−1 Int8
PHU std. opt. [ns]
HistResDscr_MDescAcquisTime 0…NumberOfCurves−1 Int8
PHU std. opt. [ms]
HistResDscr_MDescStopAt 0…NumberOfCurves−1 Int8
PHU std. opt. [cnt]
HistResDscr_MDescStopOnOvfl 0…NumberOfCurves−1 Bool8
PHU std. opt.

HistResDscr_MDescRestart 0…NumberOfCurves−1 Bool8
PHU std. opt.

HistResDscr_SyncRate 0…NumberOfCurves−1 Int8
PHU std. opt.

HistResDscr_InputRate 0…NumberOfCurves−1 Int8
PHU std. opt.

HistResDscr_HistCountRate 0…NumberOfCurves−1 Int8
PHU std. opt.

HistResDscr_IntegralCount 0…NumberOfCurves−1 Int8
PHU std. opt.

HistResDscr_HistogramBins 0…NumberOfCurves−1 Int8
PHU std. mand.

HistResDscr_DataOffset 0…NumberOfCurves−1 Int8
PHU std. mand.

<Parameter Data>


all

values of parametrized measurements
Par<Ident> 0…NumberOfCurves−1 Float8
PHU std. opt.

<Sepia2 Data>







Sep2_SerialNo no ASCII-String
PTU std. opt.

Sep2_FirmwareVersion no ASCII-String
PTU std. opt.

Sep2_SCM_<Slot>_SerialNo no ASCII-String
PTU std. opt.

Sep2_SOM_<Slot>_SerialNo no ASCII-String
PTU std. opt.

Sep2_SOM_<Slot>_BaseOscFreq no Float8
PTU std. opt. Only present if internal triggered [Hz]
Sep2_SOM_<Slot>_TrigEdge no Bool8
PTU std. opt. Only present if external triggered
Sep2_SOM_<Slot>_TrigLevel no Int8
PTU std. opt. Only present if external triggered [mV]
Sep2_SOM_<Slot>_Divider no Int8
PTU std. opt.

Sep2_SOM_<Slot>_PreSync no Int8
PTU std. opt.

Sep2_SOM_<Slot>_SyncMask no Int8
PTU std. opt.

Sep2_SOM_<Slot>_InvSyncMask no Bool8
PTU std. opt.

Sep2_SOM_<Slot>_Seq_BurstLen 0…7 Int8
PTU std. opt. 0 … 16777215
Sep2_SOM_<Slot>_Seq_EnaOutput 0…7 Bool8
PTU std. opt.

Sep2_SOM_<Slot>_Seq_EnaSync 0…7 Bool8
PTU std. opt.

Sep2_SLM_<Slot>_SerialNo no ASCII-String
PTU std. opt.

Sep2_SLM_<Slot>_TriggerIndex no Int8
PTU std. opt.

Sep2_SLM_<Slot>_Intensity no Int8
PTU std. opt. indirect: as ratio of the controlling voltage [%]
Sep2_SLM_<Slot>_CW_PulseDisable no Bool8
PTU std. opt. dependg. on laser head true is CW or disable
Sep2_SLM_<Slot>_HeadType no ASCII-String
PTU std. opt. as recognised by the SLM module
<Defaults/Settings>







Defaults_Begin no Empty8
PFS/PUS std. mand. starts settings section, ended by header end
<settings_name> no <all_types>
PFS/PUS std. mand. name unique; used to generate 8 HexChars <HashId>
PQHT_<HashId>_LowerLimit no <all_types>
PFS/PUS std. opt.

PQHT_<HashId>_UpperLimit no <all_types>
PFS/PUS std. opt.

PQHT_<HashId>_ValidSince no TDateTime
PFS/PUS std. mand.

PQHT_<HashId>_Group no ASCII-String
PFS/PUS std. opt.

<Variables Data>


PQRES

scripted variables stored in result files
Var<Ident> may be <all_types>
PQRES std. opt.

VarScriptIdent no ASCII-String
PQRES fast opt. type ident of the script to load the results
VarResultType no Int8
PQRES fast opt. missing or 0:TimeTrace,<0:Img, 2: FCS, …
<Context Data>


PQRES

scripted context stored in result files
Ctx<Ident> may be <all_types>
PQRES std. opt.

<User Data>


all

scripted variables stored by user scripts
Usr<Ident> may be <all_types>
all std. opt.

UsrOverviewGUID no ASCII-String
PTU std. opt. GUID of PTU Image which was used as overview image when measurement was started.
<Binary Data>


PTU/PHU

Contains the TTTR Records, must be positioned at the end of file
Length of this Block in Bytes = TTResultFormat_BitsPerRecord / 8 * TTResult_NumberOfRecords


Related Topics:   
   [Tag File Format]    [File Magics]    [Tag Type Definitions]    [TTTR Record Formats]
   [Support]