ruby_tdms 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8c2010fd87e23f9d15a5dd3a2698eaa8fd6a9e1
+  data.tar.gz: a215da2e96b0594c1de8e49c68cd10ef65c8489d
+SHA512:
+  metadata.gz: 5d3e0a5d0cc9036cacfbd7300134dc134b4ae4fa04b3f89192bb0dd42b6e47aeea3cf698edf451bf9b7e6e87dc4ea0cee501d136225e4d972a340d28e903e361
+  data.tar.gz: 00fd1b34967d4ef65ce032ce3c5c03d97ad05f5cfe498bb0d01d792d6494bb9f44bdcbf76f4fccac423dd6ffbeca889b8aab4c8a60e4bf74b51a27cab88c1219

data/.gitignore

@@ -0,0 +1 @@
+/.idea/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tdms.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    ruby_tdms (2.0.0)
+      coalesce
+      require_all
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coalesce (0.0.1)
+    docile (1.1.5)
+    minitest (5.5.1)
+    multi_json (1.11.0)
+    rake (10.3.2)
+    require_all (1.4.0)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.7)
+  minitest
+  rake (~> 10.0)
+  ruby_tdms!
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2012, Mike Naberezny.
+Copyright (c) 2015-2017, Aaron Ten Clay <aarontc@aarontc.com>.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Maintainable Software, LLC. nor the names of its
+      contributors may be used to endorse or promote products derived from
+      this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,28 @@
+# RubyTDMS
+
+(Note: The RubyTDMS gem was formerly known as simply "TDMS". The API did not change from TDMS 1.0.0
+to RubyTDMS 2.0.0, but the version was bumped due to the breaking name change.)
+
+TDMS is a binary file format for measurement data.  It was created
+by National Instruments.
+
+ - [NI TDMS File Format](http://zone.ni.com/devzone/cda/tut/p/id/3727)
+ - [TDMS File Format Internal Structure](http://zone.ni.com/devzone/cda/tut/p/id/5696)
+
+National Instruments software such as LabVIEW, DIAdem, and Measurement
+Studio support reading and writing TDMS files. NI also provides a DLL
+written in C for using TDMS files on Windows.
+
+RubyTDMS provides a convenient way to work with
+TDMS files on Unix-like platforms.
+
+## Current State
+
+This gem is nearly feature-complete for for reading the TDMS files according to the
+2015 specification from National Instruments.
+
+ - Writing TDMS files is not yet supported.
+
+## Contributors
+
+This gem is heavily based on the [TDMS library](http://github.com/mnaberez/tdms) created by Mike Naberezny.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+	t.libs << 'test'
+	t.libs << 'lib'
+	t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/demo.rb

@@ -0,0 +1,14 @@
+require_relative 'lib/ruby_tdms'
+
+filename = File.dirname(__FILE__) + '/test/fixtures/example.tdms'
+doc = RubyTDMS::File.parse(filename)
+
+ch1 = doc.channels.find { |c| c.name == 'StatisticsText' }
+ch2 = doc.channels.find { |c| c.name == 'Res_Noise_1' }
+
+last = [ch1.values.size, ch2.values.size].min - 1
+
+puts "#{ch1.name},#{ch2.name}"
+0.upto(last) do |i|
+	puts "#{ch1.values[i]},#{ch2.values[i]}"
+end

data/doc/data_types.txt

@@ -0,0 +1,23 @@
+Data Types
+
+Identifier    Name                            Length (bytes)    Ruby
+
+0x00000000    tdsTypeVoid                     1                 Nil
+0x00000001    tdsTypeI8                       1                 Integer
+0x00000002    tdsTypeI16                      2                 Integer
+0x00000003    tdsTypeI32                      4                 Integer
+0x00000004    tdsTypeI64                      8                 Integer
+0x00000005    tdsTypeU8                       1                 Integer
+0x00000006    tdsTypeU16                      2                 Integer
+0x00000007    tdsTypeU32                      4                 Integer
+0x00000008    tdsTypeU64                      8                 Integer
+0x00000009    tdsTypeSingleFloat              4                 Float
+0x0000000A    tdsTypeDoubleFloat              8                 Float
+0x0000000B    tdsTypeExtendedFloat            10                ?
+0x00000019    tdsTypeSingleFloatWithUnit      4                 Float
+0x0000001A    tdsTypeDoubleFloatWithUnit      8                 Float
+0x0000001B    tdsTypeExtendedFloatWithUnit    10                ?
+0x00000020    tdsTypeString                   4 len + n chars   String
+0x00000021    tdsTypeBoolean                  1                 True, False
+0x00000044    tdsTypeTimeStamp                16                DateTime
+0xFFFFFFFF    tdsTypeDAQmxRawData             ?                 ?

data/doc/example_disasm.txt

@@ -0,0 +1,47 @@
+EXAMPLE.tdms
+  Contains 4 segments
+
+
+000000  54 44 53 6d  "TDSm" id tag
+000004  0E 00 00 00  0e is ToC flag, other 3 bytes unused
+000008  68 12 00 00  6812 is little endian for 0x1268 or 4713 (TDMS standard version).  Other two bytes unused.
+00000C  E3 88 20 00
+000010  00 00 00 00  => 64-bit unsigned little endian 0x00000000002088E3 is the next segment offset
+000014  E3 08 00 00
+000018  00 00 00 00  => 64-bit unsigned little endian 0x00000000000008E3 is the raw data offset
+ ( End of Lead-In )
+ (   00001C is the offset of the next byte after the lead-in )
+ (   Next segment offset = 00001C + 2088E3 = 2088FF )
+ (   Raw data offset     = 00001C + 0008E3 = 0008FF )
+
+ ( Start of Metadata )
+00001C  08 00 00 00  => 32-bit unsigned little endian 0x00000008 is the number of
+                        new/changed objects in this segment (8 objects)
+000020  11 00 00 00  => 32-bit unsigned little endian 0x00000011 is the length of
+                        the object's path string (11 bytes)
+ (Begin Path String)
+000024  2F 27 45 58  /'EX
+000028  41 4D 50 4C  AMPL
+00002C  45 27 2F 27  E'/'
+000030  54 69 6D 65  Time
+000034  27           '
+ (Begin Length of Index)
+000034     14 00 00
+000038  0A 00 00    => 32-bit unsigned little endian 0x00000014 is the
+                       raw data index
+ (Begin Data Type)
+000038           0A
+00003C  00 00 00    => 32-bit unsigned little endian 0x0000000A is the
+                       data type (tdsTypeDoubleFloat)
+
+ (Begin Array Dimension)
+00003C           01
+000040  00 00 00     => 32-bit unsigned little endian 0x00000001 is the
+                        array dimension (always 1)
+ (Begin Number of Values)
+000040           00
+000044  04 00 00 00
+000048  04 00 00     => 64-bit unsigned little endian 0x0000000000000400 is the
+                        number of values (1024 values)
+ (Begin Total Size in Bytes)
+

data/doc/tdms_format.txt

@@ -0,0 +1,101 @@
+http://zone.ni.com/devzone/cda/tut/p/id/5696
+
+Object Hierarchy
+
+  Hierarchy                                 Path
+
+  example_events.tdms (File)                /
+   |
+   +-- Measured Data (Group)                /Measured Data
+   |     |
+   |     +-- Amplitude Sweep (Channel)      /Measured Data/Amplitude Sweep
+   |     +-- Phase Sweep (Channel)          /Measured Data/Phase Sweep
+   |
+   +-- Dr. T's Events (Group)               /Dr. T's Events
+         |
+         +-- Time (Channel)                 /Dr. T's Events/Time
+         +-- Description (Channel)          /Dr. T's Events/Description
+
+  There are exactly 3 levels of objects in TDMS:
+   - File (every TDMS file must have one)
+   - Group (has many Channels, may have none)
+   - Channel (belongs to a Group)
+
+  Every object is identified by a string path.  The only thing that
+  identifies an object as being a File, Group, or Channel is the
+  number of Segments in the string path:
+
+    Object Type      Example Path         Number of Path Segments
+    File             /                    0
+    Group            /Group               1
+    Channel          /Group/Channel       2
+
+
+File Structure
+
+  File is divided into Segments.
+  Each segment contains one or more Objects
+  Every Object has a string Path
+
+
+Segment
+
+  +-----------+------------+------------+----------------------------
+  |  Lead-in  |  Metadata  |  Raw Data  |  Lead-in (Next Segment) ...
+  +-----------+------------+------------+----------------------------
+
+  Lead-in
+    +---------+--------+---------+--------------------+--------------------+---
+    | 4: TDSm | 4: ToC | 4: Vers | 8: Next Seg Offset | 8: Raw Data Offset | Metadata ...
+    +---------+--------+---------+--------------------+--------------------+---
+    00        04       08        0C                   14                   1C
+
+
+    00-03  4 bytes: TDMS identifier (always "TDSm")
+    04-07  4 bytes: Table of contents (only first byte used)
+                    Flags to indicate what is in the segment
+    08-0B  4 bytes: TDMS version number (always 4713)
+    0C-13  8 bytes: Offset of the next segment (little endian).  Take the
+                    absolute offset of the next byte after the lead-in and
+                    add it to this number to find the next segment.
+    14-1B  8 bytes: Offset of the raw data in this segment (little endian).
+                    Also calculate it from next byte after the lead-in.
+
+
+  Metadata
+    +----------+-------------+---------+-------------------+--------------+-
+    | 4: Count | 4: Path Len | n: Path | 4: Raw data index | 4: Num Props |
+    +----------+-------------+---------+-------------------+--------------+-
+    00         04            08
+
+    4 bytes: Number of new/changed objects in this segment
+
+    For each object in the segment:
+      4 bytes: Length of object's string path
+      n bytes: Object's string path
+
+      Index block or markers:
+        If no raw data in the segment:
+          4 bytes: FF FF FF FF
+        Else if raw data index block exactly matches last segment:
+          4 bytes: 00 00 00 00
+        Else:
+          4 bytes: Length of raw data index block + 4
+          4 bytes: Data type of the raw data in this object
+          4 bytes: Dimension of raw data array (only first byte used, always 1)
+          8 bytes: Number of values
+          8 bytes: Total size in bytes (?) -- may not be here
+
+      Properties Block:
+
+        4 bytes: Number of properties of this object
+
+        For each property:
+          4 bytes: Length of property name
+          n bytes: Property name
+          4 bytes: Data type of property value (only first byte used)
+          n bytes: Property value
+                     String is 4 bytes for length, then bytes of string
+                     Others are fixed number of bytes for value based on type
+
+  Raw Data

data/doc/usage.txt

@@ -0,0 +1,48 @@
+READING
+=======
+
+# display properties of a channel
+
+  group = segment.groups.find {|grp| grp.path == "/EXAMPLE" }
+  speed = group.channels.find {|ch| ch.path == "/EXAMPLE/Time" }
+  speed.properties.each_pair do |k,v|
+    puts k,v
+  end
+
+# loop through a channel
+
+  group = segment.groups.find {|grp| grp.path == "/EXAMPLE" }
+  speed = group.channels.find {|ch| ch.path == "/EXAMPLE/Time" }
+  speed.values.each do |v|
+    puts v  #=> float
+  end
+
+# spreadsheet of two channels
+
+  group = segment.groups.find {|grp| grp.path == "/EXAMPLE" }
+
+  time  = group.channels.find { |ch| ch.path == "/EXAMPLE/Time" }
+  speed = group.channels.find { |ch| ch.path == "/EXAMPLE/Speed" }
+
+  max = [time.values.size, speed.values.size].max - 1
+  0.upto(max) do |i|
+    puts "%f,%f" % (time.values[i], speed.values[i])
+  end
+
+
+WRITING
+=======
+
+(Note: writing is not yet supported)
+
+tdms = RubyTDMS::File.new("some filename")
+seg = tdms.segment.build
+
+group = seg.groups.build("foo")
+
+chan = group.channels.build("bar")
+chan.properties["Flux Capacitor"] = "On"
+channel.values << 1.02
+channel.values << 1.02
+
+seg.save

data/lib/ruby_tdms.rb

@@ -0,0 +1,2 @@
+require 'require_all'
+require_rel 'ruby_tdms'

data/lib/ruby_tdms/aggregate_channel.rb

@@ -0,0 +1,53 @@
+require_relative 'aggregate_channel_enumerator'
+
+module RubyTDMS
+	class AggregateChannel
+		def initialize(channels = [])
+			@channels = channels
+		end
+
+
+		def inspect
+			"#<#{self.class.name}:#{self.object_id} path=#{path.inspect}, #{@channels.length} channel(s)>"
+		end
+
+
+		def path
+			@channels[0].path
+		end
+
+
+		def name
+			@channels[0].name
+		end
+
+
+		def data_type
+			@channels[0].data_type
+		end
+
+
+		def data_type_id
+			@channels[0].data_type_id
+		end
+
+
+		def values
+			@values ||= AggregateChannelEnumerator.new @channels
+		end
+
+
+		def as_json
+			result = @channels[0].as_json
+			# Iterate over all channel objects and update properties
+			result[:properties] = @channels.reduce({}) do |properties, channel|
+				channel.properties.each do |property|
+					properties[property.name.to_sym] = property.value
+				end
+				properties
+			end
+			result[:values] = values.to_a
+			result
+		end
+	end
+end

data/lib/ruby_tdms/aggregate_channel_enumerator.rb

@@ -0,0 +1,50 @@
+module RubyTDMS
+	class AggregateChannelEnumerator
+		include Enumerable
+
+
+		def initialize(channels)
+			@channels = channels
+			@offsets = []
+
+			size = 0
+			@channels.inject(0) do |size, channel|
+				@offsets << size
+				size += channel.values.size
+			end
+		end
+
+
+		def size
+			@size ||= @channels.inject(0) { |sum, chan| sum += chan.values.size }
+		end
+
+
+		def each
+			@channels.each do |channel|
+				channel.values.each { |value| yield value }
+			end
+		end
+
+
+		def [](i)
+			if (i < 0) || (i >= size)
+				raise RangeError, 'Channel %s has a range of 0 to %d, got invalid index: %d' % [@channels[0].path, size - 1, i]
+			end
+
+			channel, offset = nil, nil
+			j = @offsets.size - 1
+			@offsets.reverse_each do |o|
+				if i >= o
+					channel = @channels[j]
+					offset = @offsets[j]
+					break
+				else
+					j -= 1
+				end
+			end
+
+			channel.values[i - offset]
+		end
+	end
+end