[c++/m] Add nix.MultiTag retrieveFeatureData func

Author: mpsonntag

+nix/MultiTag.m

@@ -118,6 +118,14 @@
                 'MultiTag::openFeatureIdx', idx, @nix.Feature);
         end;
 
+        function data = retrieve_feature_data(obj, pos_idx, id_or_name)
+            tmp = nix_mx('MultiTag::featureRetrieveData', ...
+                            obj.nix_handle, pos_idx, id_or_name);
+
+            % data must agree with file & dimensions; see mkarray.cc(42)
+            data = permute(tmp, length(size(tmp)):-1:1);
+        end;
+
         function data = retrieve_feature_data_idx(obj, pos_idx, feat_idx)
             tmp = nix_mx('MultiTag::featureRetrieveDataIdx', ...
                             obj.nix_handle, pos_idx, feat_idx);

nix_mx.cc

@@ -379,6 +379,7 @@ void mexFunction(int            nlhs,
         methods->add("MultiTag::featuresFiltered", nixmultitag::featuresFiltered);
         methods->add("MultiTag::retrieveData", nixmultitag::retrieveData);
         methods->add("MultiTag::retrieveDataIdx", nixmultitag::retrieveDataIdx);
+        methods->add("MultiTag::featureRetrieveData", nixmultitag::retrieveFeatureData);
         methods->add("MultiTag::featureRetrieveDataIdx", nixmultitag::retrieveFeatureDataIdx);
 
         classdef<nix::Section>("Section", methods)

src/nixmultitag.cc

@@ -135,6 +135,15 @@ namespace nixmultitag {
         output.set(0, data);
     }
 
+    void retrieveFeatureData(const extractor &input, infusor &output) {
+        nix::MultiTag currObj = input.entity<nix::MultiTag>(1);
+        size_t pos_idx = (size_t)input.num<double>(2);
+        std::string name_id = input.str(3);
+
+        mxArray *data = make_mx_array_from_ds(currObj.retrieveFeatureData(pos_idx, name_id));
+        output.set(0, data);
+    }
+
     void retrieveFeatureDataIdx(const extractor &input, infusor &output) {
         nix::MultiTag currObj = input.entity<nix::MultiTag>(1);
         size_t pos_idx = (size_t)input.num<double>(2);

src/nixmultitag.h

@@ -45,6 +45,8 @@ namespace nixmultitag {
 
     void retrieveDataIdx(const extractor &input, infusor &output);
 
+    void retrieveFeatureData(const extractor &input, infusor &output);
+
     void retrieveFeatureDataIdx(const extractor &input, infusor &output);
 
 } // namespace nixmultitag

tests/TestMultiTag.m

@@ -42,6 +42,7 @@
     funcs{end+1} = @test_open_metadata;
     funcs{end+1} = @test_retrieve_data;
     funcs{end+1} = @test_retrieve_data_idx;
+    funcs{end+1} = @test_retrieve_feature_data;
     funcs{end+1} = @test_retrieve_feature_data_idx;
     funcs{end+1} = @test_set_units;
     funcs{end+1} = @test_attrs;
@@ -767,6 +768,95 @@
     assert(isequal(t.retrieve_data_idx(2, 1), raw2(1:2, 3:6)), 'Retrieve pos 3, ref 2 fail');
 end
 
+%% Test: Retrieve feature data by id or name
+function [] = test_retrieve_feature_data( varargin )
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+
+    % create feature data arrays
+    raw_feat1 = [11 12 13 14 15 16 17 18];
+    da_feat1 = b.create_data_array_from_data('feature1', 'nixDataArray', raw_feat1);
+    da_feat1.append_sampled_dimension(1);
+
+    raw_feat2 = [21 22 23 24 25 26 27 28];
+    da_feat2 = b.create_data_array_from_data('feature2', 'nixDataArray', raw_feat2);
+    da_feat2.append_sampled_dimension(1);
+
+    % create referenced data array
+    raw_feat3 = [31 32 33 34 35 36 37 38];
+    da_feat3 = b.create_data_array_from_data('reference', 'nixDataArray', raw_feat3);
+    da_feat3.append_sampled_dimension(1);
+
+    % create position, extents DA and multi tag
+    pos = [0; 3; 5];
+    ext = [1; 1; 3];
+
+    da_pos = b.create_data_array_from_data('positions', 'nixDataArray', pos);
+    da_ext = b.create_data_array_from_data('extents', 'nixDataArray', ext);
+
+    da_pos.append_sampled_dimension(0);
+    da_ext.append_sampled_dimension(0);
+
+    t = b.create_multi_tag('testMultiTag', 'nixMultiTag', da_pos);
+    t.set_extents(da_ext);
+
+    % add feature data_arrays
+    t.add_feature(da_feat1, nix.LinkType.Untagged);
+    t.add_feature(da_feat2, nix.LinkType.Tagged);
+    t.add_feature(da_feat3, nix.LinkType.Indexed);
+
+    % test invalid position idx
+    try
+        t.retrieve_feature_data(100, '');
+    catch ME
+        assert(isempty(strfind(ME.message, 'ounds of positions or extents')), ...
+            'Invalid position index failed');
+    end
+    assert(exist('ME') == 1, 'Invalid position index fail, error not raised');
+    clear ME;
+
+    % test invalid name or id
+    try
+        t.retrieve_feature_data(0, 'I do not exist');
+    catch ME
+        assert(~isempty(strfind(ME.message, 'no Feature with the specified name or id')), ...
+            'Invalid reference name failed');
+    end
+    assert(exist('ME') == 1, 'Invalid reference name fail, error not raised');
+    clear ME;
+
+    % test untagged ignores position and returns full data
+    retData = t.retrieve_feature_data(100, da_feat1.name);
+    assert(isequal(raw_feat1, retData), 'Untagged fail');
+
+    % test tagged properly applies position and extents
+    retData = t.retrieve_feature_data(0, da_feat2.id);
+    assert(isequal(retData, [21]), 'Tagged pos 1 fail');
+
+    retData = t.retrieve_feature_data(1, da_feat2.name);
+    assert(isequal(retData, [24]), 'Tagged pos 2 fail');
+
+    retData = t.retrieve_feature_data(2, da_feat2.id);
+    assert(isequal(retData, [26, 27, 28]), 'Tagged pos 3 fail');
+
+    % test indexed returns first and last index value
+    retData = t.retrieve_feature_data(0, da_feat3.id);
+    assert(isequal(retData, raw_feat3(1)), 'Indexed first pos fail');
+    
+    retData = t.retrieve_feature_data(7, da_feat3.name);
+    assert(isequal(retData, raw_feat3(end)), 'Indexed last pos fail');
+    
+    % test indexed fail when accessing position > length of referenced array
+    try
+        t.retrieve_feature_data(size(raw_feat3, 2) + 1, da_feat3.id);
+    catch ME
+        assert(~isempty(strfind(ME.message, 'than the data stored in the feature')), ...
+            'Indexed out of length fail');
+    end
+    assert(exist('ME') == 1, 'Indexed out of length fail, error not raised');
+    clear ME;
+end
+
 %% Test: Retrieve feature data
 function [] = test_retrieve_feature_data_idx( varargin )
     f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);