[c++/m] Add Tag referencesFilter

Author: mpsonntag

+nix/Tag.m

@@ -77,6 +77,11 @@
             c = nix_mx('Tag::referenceCount', obj.nix_handle);
         end
 
+        function filtered = filter_references(obj, filter, val)
+            filtered = nix.Utils.filter(obj, filter, val, ...
+                'Tag::referencesFiltered', @nix.DataArray);
+        end
+
         % ------------------
         % Features methods
         % ------------------

nix_mx.cc

@@ -324,6 +324,7 @@ void mexFunction(int            nlhs,
         methods->add("Tag::openSourceIdx", nixtag::openSourceIdx);
         methods->add("Tag::compare", nixtag::compare);
         methods->add("Tag::sourcesFiltered", nixtag::sourcesFiltered);
+        methods->add("Tag::referencesFiltered", nixtag::referencesFiltered);
 
         classdef<nix::MultiTag>("MultiTag", methods)
             .desc(&nixmultitag::describe)

src/nixtag.cc

@@ -112,4 +112,13 @@ namespace nixtag {
         output.set(0, res);
     }
 
+    void referencesFiltered(const extractor &input, infusor &output) {
+        nix::Tag currObj = input.entity<nix::Tag>(1);
+        std::vector<nix::DataArray> res = filterEntity<nix::DataArray>(input,
+                                            [currObj](const nix::util::Filter<nix::DataArray>::type &filter) {
+            return currObj.references(filter);
+        });
+        output.set(0, res);
+    }
+
 } // namespace nixtag

src/nixtag.h

@@ -39,6 +39,8 @@ namespace nixtag {
 
     void sourcesFiltered(const extractor &input, infusor &output);
 
+    void referencesFiltered(const extractor &input, infusor &output);
+
 } // namespace nixtag
 
 #endif

tests/TestTag.m

@@ -41,6 +41,7 @@
     funcs{end+1} = @test_has_reference;
     funcs{end+1} = @test_compare;
     funcs{end+1} = @test_filter_source;
+    funcs{end+1} = @test_filter_reference;
 end
 
 %% Test: Add sources by entity and id
@@ -728,3 +729,77 @@
     assert(size(filtered, 1) == 1);
     assert(strcmp(filtered{1}.name, mainName));
 end
+
+%% Test: filter references
+function [] = test_filter_reference( varargin )
+    filterName = 'filterMe';
+    filterType = 'filterType';
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    t = b.create_tag('testTag', 'nixTag', [1 2 3]);
+    d = b.create_data_array(filterName, 'nixDataArray', nix.DataType.Double, [1 2]);
+    t.add_reference(d);
+    filterID = d.id;
+	d = b.create_data_array('testDataArray1', filterType, nix.DataType.Double, [1 2]);
+    t.add_reference(d);
+    filterIDs = {filterID, d.id};
+    d = b.create_data_array('testDataArray2', filterType, nix.DataType.Double, [1 2]);
+    t.add_reference(d);
+
+    % test empty id filter
+    assert(isempty(f.blocks{1}.tags{1}.filter_references(nix.Filter.id, 'IdoNotExist')));
+
+    % test nix.Filter.accept_all
+    filtered = f.blocks{1}.tags{1}.filter_references(nix.Filter.accept_all, '');
+    assert(size(filtered, 1) == 3);
+
+    % test nix.Filter.id
+    filtered = f.blocks{1}.tags{1}.filter_references(nix.Filter.id, filterID);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.id, filterID));
+
+    % test nix.Filter.ids
+    filtered = f.blocks{1}.tags{1}.filter_references(nix.Filter.ids, filterIDs);
+    assert(size(filtered, 1) == 2);
+    assert(strcmp(filtered{1}.id, filterIDs{1}) || strcmp(filtered{1}.id, filterIDs{2}));
+    
+    % test nix.Filter.name
+    filtered  = f.blocks{1}.tags{1}.filter_references(nix.Filter.name, filterName);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.name, filterName));
+    
+    % test nix.Filter.type
+    filtered = f.blocks{1}.tags{1}.filter_references(nix.Filter.type, filterType);
+    assert(size(filtered, 1) == 2);
+
+    % test nix.Filter.metadata
+    mainName = 'testSubSection';
+    main = b.create_data_array(mainName, 'nixDataArray', nix.DataType.Bool, [2 2]);
+    t.add_reference(main);
+    subName = 'testSubSection1';
+    s = f.create_section(subName, 'nixSection');
+    main.set_metadata(s);
+    subID = s.id;
+
+    assert(isempty(f.blocks{1}.tags{1}.filter_references(nix.Filter.metadata, 'Do not exist')));
+    filtered = f.blocks{1}.tags{1}.filter_references(nix.Filter.metadata, subID);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.name, mainName));
+
+    % test nix.Filter.source
+    mainName = 'testSubSource';
+    main = b.create_data_array(mainName, 'nixDataArray', nix.DataType.Bool, [2 2]);
+    t.add_reference(main);
+    mainID = main.id;
+    subName = 'testSubSource1';
+    s = b.create_source(subName, 'nixSource');
+    main.add_source(s);
+    subID = s.id;
+
+    assert(isempty(f.blocks{1}.tags{1}.filter_references(nix.Filter.source, 'Do not exist')));
+
+    % filter works only for ID, not for name
+    filtered = f.blocks{1}.tags{1}.filter_references(nix.Filter.source, subID);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.name, mainName));
+end