/
getImageCommentAnnotations.m
44 lines (42 loc) · 1.98 KB
/
getImageCommentAnnotations.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
function cas = getImageCommentAnnotations(session, ids, varargin)
% GETIMAGECOMMENTANNOTATIONS Retrieve comment annotations linked to images
%
% cas = getImageCommentAnnotations(session, ids) returns all comment
% 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.
%
% cas = getImageCommentAnnotations(session, ids, 'exclude', exclude)
% excludes comment annotations with the input namespace.
%
% Examples:
%
% cas = getImageCommentAnnotations(session, ids)
% cas = getImageCommentAnnotations(session, images)
% cas = getImageCommentAnnotations(session, ids, 'include', include)
% cas = getImageCommentAnnotations(session, ids, 'exclude', exclude)
%
% See also: GETOBJECTANNOTATIONS, GETIMAGEFILEANNOTATIONS,
% GETIMAGETAGANNOTATIONS, GETIMAGEXMLANNOTATIONS
% Copyright (C) 2013 University of Dundee & Open Microscopy Environment.
% All rights reserved.
%
% This program is free software; you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation; either version 2 of the License, or
% (at your option) any later version.
%
% This program is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License along
% with this program; if not, write to the Free Software Foundation, Inc.,
% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
cas = getObjectAnnotations(session, 'comment', 'image', ids, varargin{:});