cell array
.Data format of the TA Toolbox
All datasets get stored and processed in a unique and standardised format inside the TA Toolbox. That means that all routines of the toolbox expect to get data in this particular format. This page is used to document this format specification.
The TAload
routine serves as an interface between all data formats that can be handled by the TA Toolbox and the GUI. Therefore, the TAload
routine outputs the data structure specified here.
<note important>All fields defined here need to be filled with sensible values by each of the actual importer functions. The structures (Matlab™ structs) returned from the TAload
routine are directly appended to the „data“ field of the GUI data.</note>
Background: During the development, it appeared to be sensible not only to store the actual data (strictly speaking, a n×m matrix), but a set of additional informations together with the data as well. Partly, these data can be derived from the raw data, partly they should be documented in the corresponding labbook. Having these informations in a data structure together with the actual data has several advantages, starting with having full access to this information from the GUI.
Given that there are plans for developing a “laboratory information system” storing finally all sorts of information about samples and measurements, collecting those “meta data” may well pay off at some point.
History
- 2012-10-22: Version 0.5
- New field “buffer” in “sample”
- New fields “experiment” and “purpose” in “parameters”
- 2012-04-14: Version 0.4
- New structure “timeProfiles” in “parameters”
- 2012-03-31: Version 0.3
- New structure “shotRepetitionRate” in “parameters”
- 2012-01-26: Version 0.2 (still)
- New field “background” in “parameters.probe”
- 2012-01-24: Version 0.2 (still)
- Changed format of “filter” in “parameters.probe”: previously struct, now string
- 2012-01-21: Version 0.2
- Added structure “aperture” in “parameters.spectrograph”
- Changed “parameters.date” in struct with fields “start” and “end”
- Added structure “spectrometer” with fields “name” and “software” in “parameters”
- Added structure “timeConstant” in “parameters.detection”
- Renamed field “opoDye” in “tunable”
Structure
Draft for the structure:
data
- matrix
Actual data (without magnetic field)dataMFon
- matrix
Data acquired with magnetic field switched on (empty if no MFE setup used)axes
- struct
Additional information about the axesx
- structvalues
- vector
Values of the x axis, same length as corresponding dimension of thedata
fieldmeasure
- string
Measureunit
- string
Unit
y
- structvalues
- vector
Values of the y axis, same length as corresponding dimension of thedata
fieldmeasure
- string
Measureunit
- string
Unit
z
- structmeasure
- string
Measureunit
- string
Unit
parameters
- struct
Additional informations about the measurement that get used oftenlyruns
- scalaroperator
- string
Name of the user who recorded the datasetdate
- struct
Start and end of the measurementstart
- datetimeend
- datetime
- NEW
experiment
- string
Type of experiment performed (TA, MFE, MARY) - NEW
purpose
- cell array
Purpose of the experiment (free text) - NEW
shotRepetitionRate
- struct
Shot repetition rate of the experimentvalue
- scalarunit
- string
spectrometer
- struct
Name and basic information about the setup usedname
- string
Short, comprehensive, unique identifier for the spectrometersoftware
- string
Name and version of the software used for the measurement
transient
- structpoints
- scalartriggerPosition
- scalarlength
- scalarunit
- string
Unit
spectrograph
- structtype
- string
Type of the spectrograph usedmodel
- string
Actual spectrograph model used- NEW
aperture
- structfront
- structvalue
- scalarunit
- string
back
- structvalue
- scalarunit
- string
detection
- structtype
- string
Type of detection (“PMT”,“CCD”,…)model
- string
Actual detector model usedpowersupply
- string
Power supply of the detectorimpedance
- struct
Resistance between PMT and recorder (therefore determining the time resolution)value
- scalarunit
- string
- NEW
timeConstant
- struct
Time constant (time resolution) of the detection (determined by the impedance)value
- scalarunit
- string
recorder
- structsensitivity
- structvalue
- scalarunit
- string
averages
- scalartimeBase
- struct (old: scalar)value
- scalarunit
- string
bandwidth
- structvalue
- scalarunit
- string
coupling
- string
Type of coupling of the transient recorder (AC, DC, GND)model
- string
Actual model of the transient recorder used
pump
- struct
All informations regarding the pump beamtype
- string
Type of light source (“arclamp”,“laser”)model
- string
Actual model of the light source usedwavelength
- structvalue
- scalarunit
- string
power
- structvalue
- scalarunit
- string
repetitionRate
- structvalue
- scalarunit
- string
tunable
- struct
type
- string
Type of the device used (“OPO”,“dye”)model
- string
Actual model of the used devicedye
- string
Name of the dye used (“none” in case oftype
=“OPO”)
probe
- struct
All informations regarding the probe beamtype
- string
Type of the probe beam light source (“arclamp”,“laser”)model
- string
Actual model of the light source usedwavelength
- structstart
- scalarstop
- scalarstep
- scalarsequence
- stringunit
- string
power
- structvalue
- scalarunit
- string
filter
- string
List of filters used (can be more than one per time trace)- NEW
background
- string
temperature
- structvalue
- scalarunit
- stringcontroller
/model
- string
Actual model of the temperature controllercryostat
- string
Actual model of the cryostat used (“none”, if none)cryogen
- string
Cryogen used (“none”,“H2O”,“LN2”,“LHe”)
MFE
- struct
All parameters regarding the MFE setupfield
- structvalue
- scalarunit
- string
Unit
coils
- structtype
- string
Type of coils used (“Helmholtz”)model
- string
Unique identifier for the coils used
powersupply
- string
Power supply for the coilsgaussmeter
- string
- NEW
timeProfiles
- struct (1xn)filename
- stringwavelength
- structvalue
- scalarunit
- string
averages
- scalarruns
- scalarfilter
- string
-
name
- string
(unique), short and comprehensive name of the sampledescription
- cell array
Description of the sample (free text)- NEW
buffer
- cell array
Description of the buffer used (free text) preparation
- cell array
Description of sample preparation (free text)cuvette
- string
cell/cuvette used
header
- cell array
Comment header of the file readcomment
- cell array
Comment to the measurement (free text)info
- struct
Additional information about the dataset, e.g. to the sample. Ideally, key-value pairs; empty if not available.file
- structname
- string
File name, with complete or relative path, where applicable
label
- string
Name that is used for display, e.g. in theTAgui
; empty string if not availableformat
- struct
Informations regarding the data structure/formatname
- string
Name of the data structure/format: “TA toolbox”; used for identificationversion
- string
Version number of the data structure