[c++/m] Add nix.Tag retrieveFeature Data function

Author: mpsonntag

+nix/Tag.m

@@ -121,6 +121,14 @@
                 'Tag::openFeatureIdx', idx, @nix.Feature);
         end;
 
+        function data = retrieve_feature_data(obj, id_or_name)
+            tmp = nix_mx('Tag::featureRetrieveData', obj.nix_handle, 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, idx)
             tmp = nix_mx('Tag::featureRetrieveDataIdx', obj.nix_handle, idx);
 

nix_mx.cc

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

src/nixtag.cc

@@ -130,6 +130,14 @@ namespace nixtag {
         output.set(0, data);
     }
 
+    void retrieveFeatureData(const extractor &input, infusor &output) {
+        nix::Tag currObj = input.entity<nix::Tag>(1);
+        std::string name_id = input.str(2);
+
+        mxArray *data = make_mx_array_from_ds(currObj.retrieveFeatureData(name_id));
+        output.set(0, data);
+    }
+
     void retrieveFeatureDataIdx(const extractor &input, infusor &output) {
         nix::Tag currObj = input.entity<nix::Tag>(1);
         nix::ndsize_t idx = (nix::ndsize_t)input.num<double>(2);

src/nixtag.h

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

tests/TestTag.m

@@ -36,6 +36,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_attrs;
     funcs{end+1} = @test_has_feature;
@@ -586,6 +587,51 @@
     assert(retData(1) == raw(t.position + 1), 'Position check failed');
 end
 
+%% Test: Retrieve feature data by name and id
+function [] = test_retrieve_feature_data( varargin )
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    raw = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+    d = b.create_data_array_from_data('testDataArray', 'nixDataArray', raw);
+    d.append_sampled_dimension(1);
+    tagStartPos = [3];
+    t = b.create_tag('testTag', 'nixTag', tagStartPos);
+    t.extent = [3];
+    t.add_reference(d);
+
+    rawFeature = [10, 11, 12, 13, 14, 15, 16, 17, 18, 19];
+
+    % test get non existent
+    try
+        t.retrieve_data('I do not exist, dont hate me!');
+    catch ME
+        assert(~isempty(strfind(ME.message, 'no DataArray with the specified name')), ...
+            'Non existent check fail');
+    end
+
+    % test retrieve untagged feature data by name
+    df = b.create_data_array_from_data('testUntagged', 'nixDataArray', rawFeature);
+    df.append_sampled_dimension(1);
+    t.add_feature(df, nix.LinkType.Untagged);
+    retData = t.retrieve_feature_data('testUntagged');
+    assert(size(retData, 2) == size(rawFeature, 2), 'Untagged size check fail');
+
+    % test retrieve tagged feature data by id
+    df = b.create_data_array_from_data('testTagged', 'nixDataArray', rawFeature);
+    df.append_sampled_dimension(1);
+    t.add_feature(df, nix.LinkType.Tagged);
+    retData = t.retrieve_feature_data(df.id);
+    assert(size(retData, 2) == t.extent, 'Tagged Extent check fail');
+    assert(retData(1) == rawFeature(t.position + 1), 'Tagged Position check fail');
+
+    % test retrieve indexed feature data by id
+    df = b.create_data_array_from_data('testIndexed', 'nixDataArray', rawFeature);
+    df.append_sampled_dimension(1);
+    t.add_feature(df, nix.LinkType.Indexed);
+    retData = t.retrieve_feature_data(df.id);
+    assert(size(retData, 2) == size(rawFeature, 2), 'Indexed size check fail');
+end
+
 %% Test: Retrieve feature data by index
 function [] = test_retrieve_feature_data_idx( varargin )
     f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);