Mercurial > hg > orthanc

comparison OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4836:ec1e9571b645

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
document number of dimensions in numpy arrays
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 27 Nov 2021 12:31:51 +0100
parents bec432ee1094
children b3d0a3a4d890
comparison
equal deleted inserted replaced
4835:f3f93695d6df 4836:ec1e9571b645
1257 { 1257 {
1258 DocumentSharedNumpy(call); 1258 DocumentSharedNumpy(call);
1259 call.GetDocumentation() 1259 call.GetDocumentation()
1260 .SetTag("Instances") 1260 .SetTag("Instances")
1261 .SetSummary("Decode frame for numpy") 1261 .SetSummary("Decode frame for numpy")
1262 .SetDescription("Decode one frame of interest from the given DICOM instance, for use with numpy in Python") 1262 .SetDescription("Decode one frame of interest from the given DICOM instance, for use with numpy in Python. "
1263 "The numpy array has 3 dimensions: (height, width, color channel).")
1263 .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)"); 1264 .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)");
1264 } 1265 }
1265 else 1266 else
1266 { 1267 {
1267 const std::string instanceId = call.GetUriComponent("id", ""); 1268 const std::string instanceId = call.GetUriComponent("id", "");
1294 { 1295 {
1295 DocumentSharedNumpy(call); 1296 DocumentSharedNumpy(call);
1296 call.GetDocumentation() 1297 call.GetDocumentation()
1297 .SetTag("Instances") 1298 .SetTag("Instances")
1298 .SetSummary("Decode instance for numpy") 1299 .SetSummary("Decode instance for numpy")
1299 .SetDescription("Decode the given DICOM instance, for use with numpy in Python"); 1300 .SetDescription("Decode the given DICOM instance, for use with numpy in Python. "
1301 "The numpy array has 4 dimensions: (frame, height, width, color channel).");
1300 } 1302 }
1301 else 1303 else
1302 { 1304 {
1303 const std::string instanceId = call.GetUriComponent("id", ""); 1305 const std::string instanceId = call.GetUriComponent("id", "");
1304 const bool compress = call.GetBooleanArgument("compress", false); 1306 const bool compress = call.GetBooleanArgument("compress", false);
1333 { 1335 {
1334 DocumentSharedNumpy(call); 1336 DocumentSharedNumpy(call);
1335 call.GetDocumentation() 1337 call.GetDocumentation()
1336 .SetTag("Series") 1338 .SetTag("Series")
1337 .SetSummary("Decode series for numpy") 1339 .SetSummary("Decode series for numpy")
1338 .SetDescription("Decode the given DICOM series, for use with numpy in Python"); 1340 .SetDescription("Decode the given DICOM series, for use with numpy in Python. "
1341 "The numpy array has 4 dimensions: (frame, height, width, color channel).");
1339 } 1342 }
1340 else 1343 else
1341 { 1344 {
1342 const std::string seriesId = call.GetUriComponent("id", ""); 1345 const std::string seriesId = call.GetUriComponent("id", "");
1343 const bool compress = call.GetBooleanArgument("compress", false); 1346 const bool compress = call.GetBooleanArgument("compress", false);