Merge pull request #108 from mpsonntag/aliasRangeDim

Add alias range dimension

LGTM

Author: gicmo

+nix/Block.m

@@ -68,6 +68,15 @@
         end
 
         function da = create_data_array_from_data(obj, name, nixtype, data)
+            shape = size(data);
+            %-- Quick fix to enable alias range dimension with
+            %-- 1D data arrays created with this function.
+            %-- e.g. size([1 2 3]) returns shape [1 3], which would not
+            %-- be accepted when trying to add an alias range dimension.
+            if(shape(1) == 1)
+                shape = size(data, 2);
+            end;
+
             errorStruct.identifier = 'Block:unsupportedDataType';
             if(ischar(data))
                 errorStruct.message = 'Writing Strings to DataArrays is not supported as of yet.';
@@ -81,7 +90,6 @@
                 error(errorStruct);
             end;
 
-            shape = size(data);            
             da = obj.create_data_array(name, nixtype, dtype, shape);
             da.write_all(data);
         end

+nix/DataArray.m

@@ -60,6 +60,11 @@
             dim = nix.RangeDimension(nix_mx(func_name, obj.nix_handle, ticks));
         end
 
+        function dim = append_alias_range_dimension(obj)
+            func_name = strcat(obj.alias, '::append_alias_range_dimension');
+            dim = nix.RangeDimension(nix_mx(func_name, obj.nix_handle));
+        end
+        
         function delCheck = delete_dimension(obj, index)
             func_name = strcat(obj.alias, '::delete_dimension');
             delCheck = nix_mx(func_name, obj.nix_handle, index);

+nix/RangeDimension.m

@@ -12,6 +12,7 @@
 
             % assign dynamic properties
             nix.Dynamic.add_dyn_attr(obj, 'dimensionType', 'r');
+            nix.Dynamic.add_dyn_attr(obj, 'isAlias', 'r');
             nix.Dynamic.add_dyn_attr(obj, 'label', 'rw');
             nix.Dynamic.add_dyn_attr(obj, 'unit', 'rw');
             nix.Dynamic.add_dyn_attr(obj, 'ticks', 'rw');
@@ -35,6 +36,6 @@
             func_name = strcat(obj.alias, '::axis');
             axis = nix_mx(func_name, obj.nix_handle, count, startIndex);
         end
+
     end
 end
-   

nix_mx.cc

@@ -178,9 +178,11 @@ void mexFunction(int            nlhs,
             .reg("dimensions", FILTER(std::vector<nix::Dimension>, nix::DataArray, , dimensions))
             .reg("append_set_dimension", &nix::DataArray::appendSetDimension)
             .reg("append_range_dimension", &nix::DataArray::appendRangeDimension)
+            .reg("append_alias_range_dimension", &nix::DataArray::appendAliasRangeDimension)
             .reg("append_sampled_dimension", &nix::DataArray::appendSampledDimension)
             .reg("create_set_dimension", &nix::DataArray::createSetDimension)
             .reg("create_range_dimension", &nix::DataArray::createRangeDimension)
+            .reg("create_alias_range_dimension", &nix::DataArray::createAliasRangeDimension)
             .reg("create_sampled_dimension", &nix::DataArray::createSampledDimension);
         methods->add("DataArray::delete_dimension", nixdataarray::delete_dimension);
         methods->add("DataArray::readAll", nixdataarray::read_all);

src/nixdimensions.cc

@@ -30,13 +30,14 @@ namespace nixdimensions {
 
     mxArray *describe(const nix::RangeDimension &dim)
     {
-        struct_builder sb({ 1 }, { "dimensionType", "label", "unit", "ticks" });
+        struct_builder sb({ 1 }, { "dimensionType", "isAlias", "label", "unit", "ticks" });
 
         sb.set(dim.dimensionType());
+        sb.set(dim.alias());
         sb.set(dim.label());
         sb.set(dim.unit());
         sb.set(dim.ticks());
 
         return sb.array();
     }
-} // namespace nixtag
+} // namespace nixdimensions

tests/TestDataArray.m

@@ -305,7 +305,8 @@
 
 %% Test: Dimensions
 function [] = test_dimensions( varargin )
-    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    fileName = fullfile(pwd, 'tests', 'testRW.h5');
+    f = nix.File(fileName, nix.FileMode.Overwrite);
     b = f.createBlock('daTestBlock', 'test nixBlock');
     da = b.create_data_array('daTest', 'test nixDataArray', nix.DataType.Double, [1 2]);
 
@@ -329,7 +330,8 @@
     assert(strcmp(da.dimensions{3}.dimensionType, 'range'));
     assert(isequal(da.dimensions{3}.ticks, ticks));
     assert(isequal(f.blocks{1}.dataArrays{1}.dimensions{3}.ticks, ticks));
-    
+    assert(~da.dimensions{3}.isAlias);
+
     da.delete_dimension(2);
     assert(length(da.dimensions) == 2);
     assert(strcmp(da.dimensions{1}.dimensionType, 'set'));
@@ -341,4 +343,40 @@
 
     da.delete_dimension(1);
     assert(isempty(da.dimensions));
+   
+    try
+        da.append_alias_range_dimension;
+    catch ME
+        assert(strcmp(ME.identifier, 'nix:arg:inval'));
+    end;
+    
+    da.append_set_dimension();
+    try
+        da.append_alias_range_dimension();
+    catch ME
+        assert(strcmp(ME.identifier, 'nix:arg:inval'));
+    end;
+    
+    daAlias = b.create_data_array('aliasDimTest', 'nix.DataArray', ...
+        nix.DataType.Double, 25);
+    daAlias.append_alias_range_dimension();
+    assert(f.blocks{1}.dataArrays{2}.dimensions{1}.isAlias);
+    
+    clear daAlias da b f;
+    f = nix.File(fileName, nix.FileMode.ReadWrite);
+    assert(f.blocks{1}.dataArrays{2}.dimensions{1}.isAlias);
+    
+    %-- Test for the alias dimension shape work around
+    daAliasWa = f.blocks{1}.create_data_array_from_data('aliasDimWTest1', ...
+        'nix.DataArray', [1 2 3]);
+    daAliasWa.append_alias_range_dimension();
+    assert(daAliasWa.dimensions{1}.isAlias);
+    
+    daAliasWa = f.blocks{1}.create_data_array_from_data('aliasDimWATest2', ...
+        'nix.DataArray', [1; 2; 3]);
+    assert(isequal(daAliasWa.shape, [3 1]));
+    
+    daAliasWa = f.blocks{1}.create_data_array_from_data('aliasDimWATest3', ...
+        'nix.DataArray', [1 2 3; 2 4 5; 3 6 7]);
+    assert(isequal(daAliasWa.shape, [3 3]));
 end