NEEShub services are beginning to be phased out. Please begin using DesignSafe ( Please submit a support ticket ( if you need any assistance.


Support Options

Submit a Support Ticket

You are here: Home » WIKI » inDEED Authoring File Format

inDEED Authoring File Format

The inDEED Authoring File Format

The inDEED authoring file format is a simple format of zero of more group specifications. A group is a collection of sensors that may include an image that describes a view of the specimen and the sensor positions.

A group specification is in the form group name body

   group {name} { 
     key value
     key value 

The group name is a string. If the string contains spaces, then name must be enclosed in brackets {}. The body of a group may contain any of the following items:

description string describes the group and/or the image.
map image data mine-encoded string contains the image data to be displayed.
mapdesc string describes the map image.
sensor name body a sensor specification described below

   group {MyGroup} {
     description {Displacement sensors for 1st floor.}
     map {...}
     mapdesc {1st floor location XYZ}
     sensor "Sensor1" { ... }
     sensor "Sensor2" { ... }

Each group may contain zero or more sensor descriptions. A sensor description is in the form

   sensor {name} { 
     key value
     key value 

The sensor name is a string. If the string contains spaces, then name must be enclosed in double quotes (”). The body of a sensor is a series of key-value pairs. The following keys are accepted:

description string describes the sensor.
direction string sensor direction (eg. “nw”). The valid sensor directions are described below. Sensor directions are valid only for displacement sensors.
stype string type of sensor (eg. “String Potentiometer”).
type string measurement type (eg. “velocity”). Note that this is different from the sensor type.
units string measurement unit. This and the type field uniquely identifies the unit of measurement. A list of valid unit strings is found below.
x number floating point number 0..1 representing the relative position of the sensor along the X-axis of the 2D/3D map.
y number floating point number 0..1 representing the relative position of the sensor along the Y-axis of the 2D/3D map.
z number floating point number 0..1 representing the relative position of the sensor along the Z-axis of a 3D map. This value is ignored for 2D maps.


   sensor "MySensor" {
     stype "String Potentiometer"
     type "displacement"
     direction "n"
     units "m"
     x 0.5
     y 0.85123
     z 0.0
     description "An example of a sensor."

x, y, z are floats and relative to the specimen map

xpos, ypos, zpos are floats and are measured values from the actual specimen, in feet.

descriptions are text

Sensor types are Capitalized!

  • “Accelerometer”
  • “Acoustic Doppler Velocimeter”
  • “Clock”
  • “Conductivity”
  • “Cone Penetrometer”
  • “Depth Gage”
  • “Displacement”
  • “Dynamic Measurement System”
  • “Inclinometer”
  • “Linear Position Encoder”
  • “Linear Variable Differential Transformer”
  • “Load Cell”
  • “Pore Pressure Transducer”
  • “Position Transducer”
  • “Pressure Transducer”
  • “Pressure”
  • “Strain Gage”
  • “String Potentiometer”
  • “Temperature”
  • “Time”
  • “Turbidity”
  • “User Defined”
  • “Velocimeter”
  • “Voltage”
  • “Wave Gage”

Sensor Type Measurement Type Derived Unit
“Accelerometer” acceleration length / time2
“Acoustic Doppler Velocimeter” velocity length/time
“Clock” time time
“Conductivity Sensor” conductance no unit
“Cone Penetrometer” pressure (mass × acceleration) / length2
“Displacement” displacement length
“Dynamic Measurement System” no type no unit
“Inclinometer” angle no unit
“Linear Position Encoder” displacement length
“Linear Variable Differential Transformer” displacement length
“Load Cell” force mass × acceleration
“Pore Pressure Transducer” pressure (mass × acceleration) / length2
“Position Transducer” displacement length
“Pressure Transducer” pressure (mass × acceleration) / length2
“Pressure” pressure (mass × acceleration) / length2
“Strain Gage” strain length / length
“String Potentiometer” displacement length
“Temperature” temperature temperature
“Time” time time
“Turbidity” density mass / length3
“Turbidity” turbidity no unit
“User Defined” user anything
“Velocimeter” velocity length / time
“Voltage” voltage (mass × length2) / (charge × time2)
“Wave Gage” displacement length

Measurement types are case insensitive.

  • acceleration
  • angle
  • conductance
  • current
  • density
  • displacement
  • force
  • frequency
  • pressure or stress
  • resistance
  • strain
  • temperature
  • time
  • turbidity
  • velocity
  • voltage
  • user defined

The following measurement types are currently in the authoring tool.

that measurement types are currently used in the ind file

Measurement Type Unit Types Description
acceleration g gravity
acceleration m/s2 meter per second squared
acceleration cm/s2 centimeter per second squared
acceleration ft/s2 feet per second squared
acceleration in/s2 inches per second squared
angle rad radians
angle deg degrees
angle mil angular mil
angle grade grade
conductance S siemens
conductance mS millisiemens
conductance uS microsiemens
current A ampere
current C/s coulomb per second
density mg/L milligrams per liter
density g/L grams per liter
displacement km kilometer
displacement m meter
displacement cm centimeter
displacement mm millimeter
displacement ft foot
displacement in inch
force N newton
force kN kilonewton
force dyn dyne
force kip kilopound
force kipf kilopound-force
force kfp kilopound-force
force kf kilopound-force
force lbf pound (lbf)
frequency Hz hertz
frequency kHz kilohertz
frequency MHz megahertz
frequency GHz gigahertz
frequency THz terahertz
frequency rpm revolutions per minute
frequency ω angular frequency
pressure/stress GPa gigapascal
pressure/stress MPa megapascal
pressure/stress kPa kilopascal
pressure/stress Pa pascal
pressure/stress N/m2 newton per meter squared
pressure/stress dyn/cm2 dyne per centimeter squared
pressure/stress ksi kilopounds per square inch
pressure/stress psi pounds per square inch
pressure/stress psf pounds per square foot
pressure/stress atm atmosphere
pressure/stress bar bar
resistance Ω ohm
sample # sample counting number
strain mm/mm millimeter per millimeter (mm/mm)
strain in/in inch per inch
strain µ micro-strain
temperature C centigrade
temperature K kelvin
temperature F fahrenheit
time s second
time m minute
time h hour
time ms millisecond (ms)
time hh:mm:ss hour(s):min(s):sec(s)
time d-m-y day-month-year
turbidity NTU Nephelometric Turbidity Units
turbidity FTU Formazin Turbidity Units
turbidity JTU Jackson Turbidity Units
turbidity FNU Formazin Nephelometric Units
velocity m/s meter per second
velocity cm/s centimeter per second
velocity ft/s feet per second
velocity in/s inches per second
voltage V volt
voltage mV millivolt
user defined user defined user defined

Sensor directions are case insensitive. They are as follows:

Description Direction
North South ns
East West ew
Up Down updown
Up up
Down down
North n
South s
East e
West w
Northwest nw
Southwest sw
Northeast ne
Southeast se

Created on , Last modified on