From 10a3b1b7fd40b3955101256653b27bfbc4e1832b Mon Sep 17 00:00:00 2001 From: Sebastien Besson Date: Sat, 27 Apr 2013 14:40:00 +0100 Subject: [PATCH 1/4] Fix getImages() when retrieving the images contained in all P/Ds --- components/tools/OmeroM/src/io/getImages.m | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/components/tools/OmeroM/src/io/getImages.m b/components/tools/OmeroM/src/io/getImages.m index eead4334c20..9059763c5fa 100644 --- a/components/tools/OmeroM/src/io/getImages.m +++ b/components/tools/OmeroM/src/io/getImages.m @@ -51,11 +51,12 @@ % 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. % Input check +isValidIds = @(x) isempty(x) || (isvector(x) && isnumeric(x)); ip = inputParser; ip.addRequired('session'); -ip.addOptional('ids', [], @(x) isempty(x) || (isvector(x) && isnumeric(x))); -ip.addParamValue('project', [], @(x) isvector(x) && isnumeric(x)); -ip.addParamValue('dataset', [], @(x) isscalar(x) && isnumeric(x)); +ip.addOptional('ids', [], isValidIds); +ip.addParamValue('project', [], isValidIds); +ip.addParamValue('dataset', [], isValidIds); ip.KeepUnmatched = true; ip.parse(session, varargin{:}); From 54bc47d0e803fc1c6a65149e044a26cad9d45802 Mon Sep 17 00:00:00 2001 From: Sebastien Besson Date: Sun, 28 Apr 2013 16:22:19 +0100 Subject: [PATCH 2/4] Add support for input objects when loading annotations --- components/tools/OmeroM/src/annotations/getObjectAnnotations.m | 3 +++ 1 file changed, 3 insertions(+) diff --git a/components/tools/OmeroM/src/annotations/getObjectAnnotations.m b/components/tools/OmeroM/src/annotations/getObjectAnnotations.m index 7c18c549500..9d208d83c1b 100644 --- a/components/tools/OmeroM/src/annotations/getObjectAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getObjectAnnotations.m @@ -54,6 +54,9 @@ metadataService = session.getMetadataService(); % Convert input into java.util.ArrayList; +if ~isnumeric(ids), + ids = arrayfun(@(x) x.getId().getValue(), ids); +end ids = toJavaList(ids, 'java.lang.Long'); include = toJavaList(ip.Results.include, 'java.lang.String'); exclude = toJavaList(ip.Results.exclude, 'java.lang.String'); From edbe8a85f8e39a1866c77553f290f3678e8a5bec Mon Sep 17 00:00:00 2001 From: Sebastien Besson Date: Sun, 28 Apr 2013 21:02:36 +0100 Subject: [PATCH 3/4] Add new signature using loaded objects to function headers --- .../annotations/getDatasetCommentAnnotations.m | 5 +++++ .../src/annotations/getDatasetFileAnnotations.m | 5 +++++ .../src/annotations/getDatasetTagAnnotations.m | 9 +++++++-- .../src/annotations/getDatasetXmlAnnotations.m | 17 +++++++++++------ .../annotations/getImageCommentAnnotations.m | 4 ++++ .../src/annotations/getImageFileAnnotations.m | 4 ++++ .../src/annotations/getImageTagAnnotations.m | 8 ++++++-- .../src/annotations/getImageXmlAnnotations.m | 16 ++++++++++------ .../annotations/getPlateCommentAnnotations.m | 5 +++++ .../src/annotations/getPlateFileAnnotations.m | 4 ++++ .../src/annotations/getPlateTagAnnotations.m | 8 ++++++-- .../src/annotations/getPlateXmlAnnotations.m | 16 ++++++++++------ .../annotations/getProjectCommentAnnotations.m | 5 +++++ .../src/annotations/getProjectFileAnnotations.m | 5 +++++ .../src/annotations/getProjectTagAnnotations.m | 9 +++++++-- .../src/annotations/getProjectXmlAnnotations.m | 17 +++++++++++------ .../annotations/getScreenCommentAnnotations.m | 4 ++++ .../src/annotations/getScreenFileAnnotations.m | 4 ++++ .../src/annotations/getScreenTagAnnotations.m | 8 ++++++-- .../src/annotations/getScreenXmlAnnotations.m | 16 ++++++++++------ 20 files changed, 129 insertions(+), 40 deletions(-) diff --git a/components/tools/OmeroM/src/annotations/getDatasetCommentAnnotations.m b/components/tools/OmeroM/src/annotations/getDatasetCommentAnnotations.m index 67b5b30291a..22011d6142b 100644 --- a/components/tools/OmeroM/src/annotations/getDatasetCommentAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getDatasetCommentAnnotations.m @@ -5,6 +5,10 @@ % annotations linked to the datasets specified by the input identifiers % and owned by the session user. % +% cas = getDatasetCommentAnnotations(session, datasets) returns all +% comment annotations linked to the input datasets and owned by the +% session user. +% % cas = getDatasetCommentAnnotations(session, ids, 'include', include) % only returns comment annotations with the input namespace. % @@ -14,6 +18,7 @@ % Examples: % % cas = getDatasetCommentAnnotations(session, ids) +% cas = getDatasetCommentAnnotations(session, datasets) % cas = getDatasetCommentAnnotations(session, ids, 'include', include) % cas = getDatasetCommentAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getDatasetFileAnnotations.m b/components/tools/OmeroM/src/annotations/getDatasetFileAnnotations.m index c337a39e863..cf157dcb14e 100644 --- a/components/tools/OmeroM/src/annotations/getDatasetFileAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getDatasetFileAnnotations.m @@ -5,6 +5,10 @@ % annotations linked to the datasets specified by the input identifiers % and owned by the session user. % +% fas = getDatasetFileAnnotations(session, datasets) returns all file +% annotations linked to the input datasets and owned by the session +% user. +% % fas = getDatasetFileAnnotations(session, ids, 'include', include) only % returns file annotations with the input namespace. % @@ -14,6 +18,7 @@ % Examples: % % fas = getDatasetFileAnnotations(session, ids) +% fas = getDatasetFileAnnotations(session, datasets) % fas = getDatasetFileAnnotations(session, ids, 'include', include) % fas = getDatasetFileAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getDatasetTagAnnotations.m b/components/tools/OmeroM/src/annotations/getDatasetTagAnnotations.m index a68bdc880c8..fa7b3cc7c6d 100644 --- a/components/tools/OmeroM/src/annotations/getDatasetTagAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getDatasetTagAnnotations.m @@ -5,6 +5,10 @@ % annotations linked to the datasets specified by the input identifiers % ids and owned by the session user. % +% tas = getDatasetTagAnnotations(session, datasets) returns all tag +% annotations linked to the input datasets and owned by the session +% user. +% % tas = getDatasetTagAnnotations(session, ids, 'include', include) only % returns tag annotations with the input namespace. % @@ -14,8 +18,9 @@ % Examples: % % tas = getDatasetTagAnnotations(session, ids) -% fas = getDatasetTagAnnotations(session, ids, 'include', include) -% fas = getDatasetTagAnnotations(session, ids, 'exclude', exclude) +% tas = getDatasetTagAnnotations(session, datasets) +% tas = getDatasetTagAnnotations(session, ids, 'include', include) +% tas = getDatasetTagAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETDATASETCOMMENTANNOTATIONS, % GETDATASETFILEANNOTATIONS, GETDATASETXMLANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getDatasetXmlAnnotations.m b/components/tools/OmeroM/src/annotations/getDatasetXmlAnnotations.m index 5416320ef18..a6bb618d860 100644 --- a/components/tools/OmeroM/src/annotations/getDatasetXmlAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getDatasetXmlAnnotations.m @@ -1,21 +1,26 @@ function xas = getDatasetXmlAnnotations(session, ids, varargin) % GETDATASETXMLANNOTATIONS Retrieve xml annotations linked to datasets % -% fas = getDatasetXmlAnnotations(session, ids) returns all xml +% xas = getDatasetXmlAnnotations(session, ids) returns all xml % annotations linked to the datasets specified by the input identifiers % and owned by the session user. % -% fas = getDatasetXmlAnnotations(session, ids, 'include', include) only +% xas = getDatasetXmlAnnotations(session, datasets) returns all xml +% annotations linked to the input datasets and owned by the session +% user. +% +% xas = getDatasetXmlAnnotations(session, ids, 'include', include) only % returns xml annotations with the input namespace. % -% fas = getDatasetXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getDatasetXmlAnnotations(session, ids, 'exclude', exclude) % excludes xml annotations with the input namespace. % % Examples: % -% fas = getDatasetXmlAnnotations(session, ids) -% fas = getDatasetXmlAnnotations(session, ids, 'include', include) -% fas = getDatasetXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getDatasetXmlAnnotations(session, ids) +% xas = getDatasetXmlAnnotations(session, datasets) +% xas = getDatasetXmlAnnotations(session, ids, 'include', include) +% xas = getDatasetXmlAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETDATASETCOMMENTANNOTATIONS, % GETDATASETTAGANNOTATIONS, GETDATASETFILEANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getImageCommentAnnotations.m b/components/tools/OmeroM/src/annotations/getImageCommentAnnotations.m index 77e2dac3e71..4b024d4f9e2 100644 --- a/components/tools/OmeroM/src/annotations/getImageCommentAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getImageCommentAnnotations.m @@ -5,6 +5,9 @@ % annotations linked to the image specified by the input identifiers ids % and owned by the session user. % +% cas = getImageCommentAnnotations(session, images) returns all comment +% annotations linked to the input images and owned by the session user. +% % cas = getImageCommentAnnotations(session, ids, 'include', include) % only returns comment annotations with the input namespace. % @@ -14,6 +17,7 @@ % Examples: % % cas = getImageCommentAnnotations(session, ids) +% cas = getImageCommentAnnotations(session, images) % cas = getImageCommentAnnotations(session, ids, 'include', include) % cas = getImageCommentAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getImageFileAnnotations.m b/components/tools/OmeroM/src/annotations/getImageFileAnnotations.m index 05fde0f58c8..a836f095058 100644 --- a/components/tools/OmeroM/src/annotations/getImageFileAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getImageFileAnnotations.m @@ -5,6 +5,9 @@ % annotations linked to the image specified by the input identifiers ids % and owned by the session user. % +% fas = getImageFileAnnotations(session, images) returns all file +% annotations linked to the input images and owned by the session user. +% % fas = getImageFileAnnotations(session, ids, 'include', include) only % returns file annotations with the input namespace. % @@ -14,6 +17,7 @@ % Examples: % % fas = getImageFileAnnotations(session, ids) +% fas = getImageFileAnnotations(session, images) % fas = getImageFileAnnotations(session, ids, 'include', include) % fas = getImageFileAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getImageTagAnnotations.m b/components/tools/OmeroM/src/annotations/getImageTagAnnotations.m index 2878cf47e2e..deb2294ba79 100644 --- a/components/tools/OmeroM/src/annotations/getImageTagAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getImageTagAnnotations.m @@ -5,6 +5,9 @@ % linked to the image specified by the input identifiers ids and owned % by the session user. % +% tas = getImageTagAnnotations(session, images) returns all tag +% annotations linked to the input images and owned by the session user. +% % tas = getImageTagAnnotations(session, ids, 'include', include) only % returns tag annotations with the input namespace. % @@ -14,8 +17,9 @@ % Examples: % % tas = getImageTagAnnotations(session, ids) -% fas = getImageTagAnnotations(session, ids, 'include', include) -% fas = getImageTagAnnotations(session, ids, 'exclude', exclude) +% tas = getImageTagAnnotations(session, images) +% tas = getImageTagAnnotations(session, ids, 'include', include) +% tas = getImageTagAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETIMAGECOMMENTANNOTATIONS, % GETIMAGEFILEANNOTATIONS, GETIMAGEXMLANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getImageXmlAnnotations.m b/components/tools/OmeroM/src/annotations/getImageXmlAnnotations.m index f410bc04c37..d4ce1cbd838 100644 --- a/components/tools/OmeroM/src/annotations/getImageXmlAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getImageXmlAnnotations.m @@ -1,21 +1,25 @@ function xas = getImageXmlAnnotations(session, ids, varargin) % GETIMAGEXMLANNOTATIONS Retrieve xml annotations linked to images % -% fas = getImageXmlAnnotations(session, ids) returns all xml +% xas = getImageXmlAnnotations(session, ids) returns all xml % annotations linked to the image specified by the input identifiers ids % and owned by the session user. % -% fas = getImageXmlAnnotations(session, ids, 'include', include) only +% xas = getImageXmlAnnotations(session, images) returns all xml +% annotations linked to the input images and owned by the session user. +% +% xas = getImageXmlAnnotations(session, ids, 'include', include) only % returns xml annotations with the input namespace. % -% fas = getImageXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getImageXmlAnnotations(session, ids, 'exclude', exclude) % excludes xml annotations with the input namespace. % % Examples: % -% fas = getImageXmlAnnotations(session, ids) -% fas = getImageXmlAnnotations(session, ids, 'include', include) -% fas = getImageXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getImageXmlAnnotations(session, ids) +% xas = getImageXmlAnnotations(session, images) +% xas = getImageXmlAnnotations(session, ids, 'include', include) +% xas = getImageXmlAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETIMAGECOMMENTANNOTATIONS, % GETIMAGETAGANNOTATIONS, GETIMAGEFILEANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getPlateCommentAnnotations.m b/components/tools/OmeroM/src/annotations/getPlateCommentAnnotations.m index c780936d473..1b251e54943 100644 --- a/components/tools/OmeroM/src/annotations/getPlateCommentAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getPlateCommentAnnotations.m @@ -5,6 +5,10 @@ % annotations linked to the plates specified by the input identifiers ids % and owned by the session user. % +% cas = getPlateCommentAnnotations(session, plates) returns all comment +% annotations linked to the input plates and owned by the session +% user. +% % cas = getPlateCommentAnnotations(session, ids, 'include', include) % only returns comment annotations with the input namespace. % @@ -14,6 +18,7 @@ % Examples: % % cas = getPlateCommentAnnotations(session, ids) +% cas = getPlateCommentAnnotations(session, plates) % cas = getPlateCommentAnnotations(session, ids, 'include', include) % cas = getPlateCommentAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getPlateFileAnnotations.m b/components/tools/OmeroM/src/annotations/getPlateFileAnnotations.m index a1afc542f5e..c130419748d 100644 --- a/components/tools/OmeroM/src/annotations/getPlateFileAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getPlateFileAnnotations.m @@ -5,6 +5,9 @@ % annotations linked to the plates specified by the input identifiers % and owned by the session user. % +% fas = getPlateFileAnnotations(session, plates) returns all file +% annotations linked to the input plates and owned by the session user. +% % fas = getPlateFileAnnotations(session, ids, 'include', include) only % returns file annotations with the input namespace. % @@ -14,6 +17,7 @@ % Examples: % % fas = getPlateFileAnnotations(session, ids) +% fas = getPlateFileAnnotations(session, plates) % fas = getPlateFileAnnotations(session, ids, 'include', include) % fas = getPlateFileAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getPlateTagAnnotations.m b/components/tools/OmeroM/src/annotations/getPlateTagAnnotations.m index 1949833f600..b2d96fe1ac6 100644 --- a/components/tools/OmeroM/src/annotations/getPlateTagAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getPlateTagAnnotations.m @@ -5,6 +5,9 @@ % linked to the plates specified by the input identifiers ids and owned % by the session user. % +% tas = getPlateTagAnnotations(session, plates) returns all tag +% annotations linked to the input plates and owned by the session user. +% % tas = getPlateTagAnnotations(session, ids, 'include', include) only % returns tag annotations with the input namespace. % @@ -14,8 +17,9 @@ % Examples: % % tas = getPlateTagAnnotations(session, ids) -% fas = getPlateTagAnnotations(session, ids, 'include', include) -% fas = getPlateTagAnnotations(session, ids, 'exclude', exclude) +% tas = getPlateTagAnnotations(session, plates) +% tas = getPlateTagAnnotations(session, ids, 'include', include) +% tas = getPlateTagAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETPLATECOMMENTANNOTATIONS, % GETPLATEFILEANNOTATIONS, GETPLATEXMLANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getPlateXmlAnnotations.m b/components/tools/OmeroM/src/annotations/getPlateXmlAnnotations.m index 5855ebc1100..80cbe90d301 100644 --- a/components/tools/OmeroM/src/annotations/getPlateXmlAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getPlateXmlAnnotations.m @@ -1,21 +1,25 @@ function xas = getPlateXmlAnnotations(session, ids, varargin) % GETPLATEXMLANNOTATIONS Retrieve xml annotations linked to plates % -% fas = getPlateXmlAnnotations(session, ids) returns all xml +% xas = getPlateXmlAnnotations(session, ids) returns all xml % annotations linked to the plates specified by the input identifiers % and owned by the session user. % -% fas = getPlateXmlAnnotations(session, ids, 'include', include) only +% xas = getPlateXmlAnnotations(session, plates) returns all xml +% annotations linked to the input plates and owned by the session user. +% +% xas = getPlateXmlAnnotations(session, ids, 'include', include) only % returns xml annotations with the input namespace. % -% fas = getPlateXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getPlateXmlAnnotations(session, ids, 'exclude', exclude) % excludes xml annotations with the input namespace. % % Examples: % -% fas = getPlateXmlAnnotations(session, ids) -% fas = getPlateXmlAnnotations(session, ids, 'include', include) -% fas = getPlateXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getPlateXmlAnnotations(session, ids) +% xas = getPlateXmlAnnotations(session, plates) +% xas = getPlateXmlAnnotations(session, ids, 'include', include) +% xas = getPlateXmlAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETPLATECOMMENTANNOTATIONS, % GETPLATETAGANNOTATIONS, GETPLATEFILEANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getProjectCommentAnnotations.m b/components/tools/OmeroM/src/annotations/getProjectCommentAnnotations.m index 6770e5cb42d..e197a61f25a 100644 --- a/components/tools/OmeroM/src/annotations/getProjectCommentAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getProjectCommentAnnotations.m @@ -5,6 +5,10 @@ % annotations linked to the projects specified by the input identifiers % and owned by the session user. % +% cas = getProjectCommentAnnotations(session, projects) returns all +% comment annotations linked to the input projects and owned by the +% session user. +% % cas = getProjectCommentAnnotations(session, ids, 'include', include) % only returns comment annotations with the input namespace. % @@ -14,6 +18,7 @@ % Examples: % % cas = getProjectCommentAnnotations(session, ids) +% cas = getProjectCommentAnnotations(session, projects) % cas = getProjectCommentAnnotations(session, ids, 'include', include) % cas = getProjectCommentAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getProjectFileAnnotations.m b/components/tools/OmeroM/src/annotations/getProjectFileAnnotations.m index 9e189567139..ac80d3a8c2c 100644 --- a/components/tools/OmeroM/src/annotations/getProjectFileAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getProjectFileAnnotations.m @@ -5,6 +5,10 @@ % annotations linked to the projects specified by the input identifiers % and owned by the session user. % +% fas = getProjectFileAnnotations(session, projects) returns all file +% annotations linked to the input projects and owned by the session +% user. +% % fas = getProjectFileAnnotations(session, ids, 'include', include) only % returns file annotations with the input namespace. % @@ -14,6 +18,7 @@ % Examples: % % fas = getProjectFileAnnotations(session, ids) +% fas = getProjectFileAnnotations(session, projects) % fas = getProjectFileAnnotations(session, ids, 'include', include) % fas = getProjectFileAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getProjectTagAnnotations.m b/components/tools/OmeroM/src/annotations/getProjectTagAnnotations.m index c55e9ef72e2..d3f7fefb795 100644 --- a/components/tools/OmeroM/src/annotations/getProjectTagAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getProjectTagAnnotations.m @@ -5,6 +5,10 @@ % annotations linked to the projects specified by the input identifiers % ids and owned by the session user. % +% tas = getProjectTagAnnotations(session, projects) returns all tag +% annotations linked to the input projects and owned by the session +% user. +% % tas = getProjectTagAnnotations(session, ids, 'include', include) only % returns tag annotations with the input namespace. % @@ -14,8 +18,9 @@ % Examples: % % tas = getProjectTagAnnotations(session, ids) -% fas = getProjectTagAnnotations(session, ids, 'include', include) -% fas = getProjectTagAnnotations(session, ids, 'exclude', exclude) +% tas = getProjectTagAnnotations(session, projects) +% tas = getProjectTagAnnotations(session, ids, 'include', include) +% tas = getProjectTagAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETPROJECTCOMMENTANNOTATIONS, % GETPROJECTFILEANNOTATIONS, GETPROJECTXMLANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getProjectXmlAnnotations.m b/components/tools/OmeroM/src/annotations/getProjectXmlAnnotations.m index 3ee60d519bf..5f1b23f4bcf 100644 --- a/components/tools/OmeroM/src/annotations/getProjectXmlAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getProjectXmlAnnotations.m @@ -1,21 +1,26 @@ function xas = getProjectXmlAnnotations(session, ids, varargin) % GETPROJECTXMLANNOTATIONS Retrieve xml annotations linked to projects % -% fas = getProjectXmlAnnotations(session, ids) returns all xml +% xas = getProjectXmlAnnotations(session, ids) returns all xml % annotations linked to the projects specified by the input identifiers % and owned by the session user. % -% fas = getProjectXmlAnnotations(session, ids, 'include', include) only +% xas = getProjectXmlAnnotations(session, projects) returns all xml +% annotations linked to the input projects and owned by the session +% user. +% +% xas = getProjectXmlAnnotations(session, ids, 'include', include) only % returns xml annotations with the input namespace. % -% fas = getProjectXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getProjectXmlAnnotations(session, ids, 'exclude', exclude) % excludes xml annotations with the input namespace. % % Examples: % -% fas = getProjectXmlAnnotations(session, ids) -% fas = getProjectXmlAnnotations(session, ids, 'include', include) -% fas = getProjectXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getProjectXmlAnnotations(session, ids) +% xas = getProjectXmlAnnotations(session, projects) +% xas = getProjectXmlAnnotations(session, ids, 'include', include) +% xas = getProjectXmlAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETPROJECTCOMMENTANNOTATIONS, % GETPROJECTTAGANNOTATIONS, GETPROJECTFILEANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getScreenCommentAnnotations.m b/components/tools/OmeroM/src/annotations/getScreenCommentAnnotations.m index 319262abee7..675fdea3975 100644 --- a/components/tools/OmeroM/src/annotations/getScreenCommentAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getScreenCommentAnnotations.m @@ -5,6 +5,10 @@ % annotations linked to the screens specified by the input identifiers % and owned by the session user. % +% cas = getScreenCommentAnnotations(session, screens) returns all +% comment annotations linked to the input screens and owned by the +% session user. +% % cas = getScreenCommentAnnotations(session, ids, 'include', include) % only returns comment annotations with the input namespace. % diff --git a/components/tools/OmeroM/src/annotations/getScreenFileAnnotations.m b/components/tools/OmeroM/src/annotations/getScreenFileAnnotations.m index ae18a3c9d1b..90b2f354486 100644 --- a/components/tools/OmeroM/src/annotations/getScreenFileAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getScreenFileAnnotations.m @@ -5,6 +5,9 @@ % annotations linked to the screens specified by the input identifiers % and owned by the session user. % +% fas = getScreenFileAnnotations(session, screens) returns all file +% annotations linked to the input screens and owned by the session user. +% % fas = getScreenFileAnnotations(session, ids, 'include', include) only % returns file annotations with the input namespace. % @@ -14,6 +17,7 @@ % Examples: % % fas = getScreenFileAnnotations(session, ids) +% fas = getScreenFileAnnotations(session, screens) % fas = getScreenFileAnnotations(session, ids, 'include', include) % fas = getScreenFileAnnotations(session, ids, 'exclude', exclude) % diff --git a/components/tools/OmeroM/src/annotations/getScreenTagAnnotations.m b/components/tools/OmeroM/src/annotations/getScreenTagAnnotations.m index 3781e39da89..67608da176d 100644 --- a/components/tools/OmeroM/src/annotations/getScreenTagAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getScreenTagAnnotations.m @@ -5,6 +5,9 @@ % annotations linked to the screens specified by the input identifiers % ids and owned by the session user. % +% tas = getScreenTagAnnotations(session, screens) returns all tag +% annotations linked to the input screens and owned by the session user. +% % tas = getScreenTagAnnotations(session, ids, 'include', include) only % returns tag annotations with the input namespace. % @@ -14,8 +17,9 @@ % Examples: % % tas = getScreenTagAnnotations(session, ids) -% fas = getScreenTagAnnotations(session, ids, 'include', include) -% fas = getScreenTagAnnotations(session, ids, 'exclude', exclude) +% tas = getScreenTagAnnotations(session, screens) +% tas = getScreenTagAnnotations(session, ids, 'include', include) +% tas = getScreenTagAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETSCREENCOMMENTANNOTATIONS, % GETSCREENFILEANNOTATIONS, GETSCREENXMLANNOTATIONS diff --git a/components/tools/OmeroM/src/annotations/getScreenXmlAnnotations.m b/components/tools/OmeroM/src/annotations/getScreenXmlAnnotations.m index cfb4bf70614..8dc4eabcfc7 100644 --- a/components/tools/OmeroM/src/annotations/getScreenXmlAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getScreenXmlAnnotations.m @@ -1,21 +1,25 @@ function xas = getScreenXmlAnnotations(session, ids, varargin) % GETSCREENXMLANNOTATIONS Retrieve xml annotations linked to screens % -% fas = getScreenXmlAnnotations(session, ids) returns all xml +% xas = getScreenXmlAnnotations(session, ids) returns all xml % annotations linked to the screens specified by the input identifiers % and owned by the session user. % -% fas = getScreenXmlAnnotations(session, ids, 'include', include) only +% xas = getScreenXmlAnnotations(session, screens) returns all xml +% annotations linked to the input screens and owned by the session user. +% +% xas = getScreenXmlAnnotations(session, ids, 'include', include) only % returns xml annotations with the input namespace. % -% fas = getScreenXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getScreenXmlAnnotations(session, ids, 'exclude', exclude) % excludes xml annotations with the input namespace. % % Examples: % -% fas = getScreenXmlAnnotations(session, ids) -% fas = getScreenXmlAnnotations(session, ids, 'include', include) -% fas = getScreenXmlAnnotations(session, ids, 'exclude', exclude) +% xas = getScreenXmlAnnotations(session, ids) +% xas = getScreenXmlAnnotations(session, screens) +% xas = getScreenXmlAnnotations(session, ids, 'include', include) +% xas = getScreenXmlAnnotations(session, ids, 'exclude', exclude) % % See also: GETOBJECTANNOTATIONS, GETSCREENCOMMENTANNOTATIONS, % GETSCREENTAGANNOTATIONS, GETSCREENFILEANNOTATIONS From 99aa64e35b7b442707730be483a07be691a101a3 Mon Sep 17 00:00:00 2001 From: Sebastien Besson Date: Wed, 15 May 2013 17:32:58 +0100 Subject: [PATCH 4/4] Fix header of getObjectAnnotations to include new signatures --- .../src/annotations/getObjectAnnotations.m | 23 ++++++++++++------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/components/tools/OmeroM/src/annotations/getObjectAnnotations.m b/components/tools/OmeroM/src/annotations/getObjectAnnotations.m index 9d208d83c1b..543f2bb1fca 100644 --- a/components/tools/OmeroM/src/annotations/getObjectAnnotations.m +++ b/components/tools/OmeroM/src/annotations/getObjectAnnotations.m @@ -1,23 +1,30 @@ function annotations = getObjectAnnotations(session, annotationType, parentType, ids, varargin) % GETOBJECTANNOTATIONS Retrieve annotations of a given type associated with an object % -% files = getObjectAnnotations(session, annotationType, parentType, ids) +% anns = getObjectAnnotations(session, annotationType, parentType, ids) % returns all annotations of type annotationType linked to the object of % type parentType and identifiers ids owned by the session user. % -% files = getObjectAnnotations(session, annotationType, parentType, ids, +% anns = getObjectAnnotations(session, annotationType, parentType, +% parents) returns all annotations of type annotationType linked to the +% input parent objects of type parentType owned by the session user. +% +% anns = getObjectAnnotations(session, annotationType, parentType, ids, % 'include', include) only returns annotations with the input namespace. % -% files = getObjectAnnotations(session, annotationType, parentType, ids, +% anns = getObjectAnnotations(session, annotationType, parentType, ids, % 'exclude', exclude) excludes annotations with the input namespace. % % Examples: % -% anns = getObjectAnnotations(session, annotationType, parentType, ids) -% anns = getObjectAnnotations(session, annotationType, parentType, ids,... -% 'include', include) -% anns = getObjectAnnotations(session, annotationType, parentType, ids,... -% 'exclude', exclude) +% anns = getObjectAnnotations(session, annotationType, parentType, +% ids) +% anns = getObjectAnnotations(session, annotationType, parentType, +% parents) +% anns = getObjectAnnotations(session, annotationType, parentType, +% ids, 'include', include) +% anns = getObjectAnnotations(session, annotationType, parentType, +% ids, 'exclude', exclude) % % See also: GETIMAGEFILEANNOTATIONS, GETIMAGETAGANNOTATIONS, % GETIMAGECOMMENTANNOTATIONS