Fix AIAA docs and update version to 1.0.1 (#16)

* Fix AIAA docs and update version to 1.0.1
* Encode space in URI param for label and model names

Author: SachidanandAlle

README.md

@@ -13,7 +13,7 @@ AI-Assisted Annotation is a cross-platform C++/Python Client API to communicate
  - Windows (Windows 10)
 
 ## Quick Start
-Follow the [Quick Start](https://docs.nvidia.com/clara/aiaa/sdk-api/docs/quickstart.html) guide to build/install AI-Assisted Annotation Client Libraries for C++/Python and run some basic tools to verify few important functionalities like *dextr3D*, *fixPolygon* over an existing AI-Assisted Annotation Server.
+Follow the [Quick Start](https://docs.nvidia.com/clara/aiaa/sdk-api/docs/quickstart.html) guide to build/install AI-Assisted Annotation Client Libraries for C++/Python and run some basic tools to verify few important functionalities like *dextr3D*, *segmentation*, *fixPolygon* over an existing AI-Assisted Annotation Server.
 
 >C++ Client Library provides support for CMake project
 

VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

cpp-client/include/nvidia/aiaa/client.h

@@ -56,7 +56,7 @@ class AIAA_CLIENT_API Client {
   /*!
    @brief create AIAA Client object
    @param[in] serverUri  AIAA Server end-point. For example: "http://10.110.45.66:5000/v1"
-   @param[in] serverUri  AIAA Server operation timeout. Default is 60 seconds
+   @param[in] timeoutInSec  AIAA Server operation timeout. Default is 60 seconds
    @return Client object
    */
   Client(const std::string& serverUri, const int timeoutInSec = 60);
@@ -72,6 +72,8 @@ class AIAA_CLIENT_API Client {
 
   /*!
    @brief This API is used to fetch all the possible Models support by AIAA Server for matching label and model type
+   @param[in] label  Filter models by matching label
+   @param[in] type  Filter models by matching model type (segmentation/annotation)
    @return ModelList object representing a list of Models
 
    @throw nvidia.aiaa.error.101 in case of connect error
@@ -122,7 +124,7 @@ class AIAA_CLIENT_API Client {
    @param[in] outputImageFile  File name to store 3D binary mask image result from AIAA server in itk::Image<unsigned char, *> format
    @param[in] imageInfo  Optional Original ImageInfo to recover in case of annotation models after inference
 
-   @retval New/Updated Pointset in case of segmentation which represents a set of points in 3-Dimensional for the organ.
+   @retval New/Updated Pointset in case of segmentation which represents a set of extreme points in 3-Dimensional for the organ.
 
    @throw nvidia.aiaa.error.101 in case of connect error
    @throw nvidia.aiaa.error.102 if case of response parsing
@@ -134,7 +136,7 @@ class AIAA_CLIENT_API Client {
   /*!
    @brief 3D image annotation using DEXTR3D method  (this combines sampling + segmentation into single operation for 3D images)
    @param[in] model  Model to be used
-   @param[in] pointSet  PointSet object which represents a set of points in 3-Dimensional for the organ. Minimum Client::MIN_POINTS_FOR_SEGMENTATION are expected
+   @param[in] pointSet  PointSet object which represents a set of extreme points in 3-Dimensional for the organ. Minimum Client::MIN_POINTS_FOR_SEGMENTATION are expected
    @param[in] inputImageFile  Input image filename where image is stored in itk::Image<?, 3> format
    @param[in] pixelType  PixelType for Input Image
    @param[in] outputImageFile  File name to store 3D binary mask image result from AIAA server in itk::Image<unsigned char, 3> format

cpp-client/src/client.cpp

@@ -60,7 +60,10 @@ ModelList Client::models() const {
 }
 
 ModelList Client::models(const std::string &label, const Model::ModelType type) const {
-  std::string uri = serverUri + EP_MODELS + "?label=" + label;
+  std::string l = label;
+  std::replace(l.begin(), l.end(), ' ', '+');
+
+  std::string uri = serverUri + EP_MODELS + "?label=" + l;
   if (type != Model::unknown) {
     uri += std::string("&type=") + (type == Model::segmentation ? "segmentation" : "annotation");
   }
@@ -196,7 +199,10 @@ PointSet Client::segmentation(const Model &model, const PointSet &pointSet, cons
   std::string tmpResultFile = postProcess ? (Utils::tempfilename() + IMAGE_FILE_EXTENSION) : outputImageFile;
   AIAA_LOG_DEBUG("TmpResultFile: " << tmpResultFile << "; PostProcess: " << postProcess);
 
-  std::string uri = serverUri + (model.type == Model::segmentation ? EP_SEGMENTATION : EP_DEXTRA_3D) + "?model=" + model.name;
+  std::string m = model.name;
+  std::replace(m.begin(), m.end(), ' ', '+');
+  std::string uri = serverUri + (model.type == Model::segmentation ? EP_SEGMENTATION : EP_DEXTRA_3D) + "?model=" + m;
+
   std::string paramStr = "{\"sigma\":" + Utils::lexical_cast<std::string>(model.sigma) + ",\"points\":\"" + pointSet.toJson() + "\"}";
   std::string response = CurlUtils::doPost(uri, paramStr, inputImageFile, tmpResultFile, timeoutInSec);
 

docs/quickstart.rst

@@ -46,7 +46,7 @@ Linux
 
 .. code-block:: bash
 
-   export version=1.0.0
+   export version=1.0.1
    wget https://github.com/NVIDIA/ai-assisted-annotation-client/releases/download/v${version}/NvidiaAIAAClient-${version}-Linux.sh
    sudo sh NvidiaAIAAClient-${version}-Linux.sh --prefix=/usr/local --exclude_sub_dir --skip-license
 
@@ -60,7 +60,7 @@ MacOS
 
 .. code-block:: bash
 
-   export version=1.0.0
+   export version=1.0.1
    wget https://github.com/NVIDIA/ai-assisted-annotation-client/releases/download/v${version}/NvidiaAIAAClient-${version}-Darwin.sh
    sh NvidiaAIAAClient-${version}-Darwin.sh --prefix=/usr/local --exclude_sub_dir --skip-license
    
@@ -122,7 +122,7 @@ Find Package
 ^^^^^^^^^^^^
 To use this library from a CMake project, you can locate it directly with find_package() and use the namespaced imported target from the generated package configuration:
 
-.. code-block:: guess
+::
 
    # CMakeLists.txt
    find_package(NvidiaAIAAClient REQUIRED)
@@ -142,13 +142,13 @@ External Project
 ^^^^^^^^^^^^^^^^
 You can achieve this by adding External Project in CMake.
 
-.. code-block:: guess
+::
 
    # CMakeLists.txt
    ...
    ExternalProject_Add(NvidiaAIAAClient
       GIT_REPOSITORY https://github.com/NVIDIA/ai-assisted-annotation-client.git
-      GIT_TAG v1.0.0
+      GIT_TAG v1.0.1
    )
    ...
    target_link_libraries(foo ${NvidiaAIAAClient_LIBRARY})

docs/tools.rst

@@ -47,6 +47,7 @@ Following are the options available
    -h,Prints the help information,,
    -server,Server URI for AIAA Server,,-server http://10.110.45.66:5000/v1
    -label,Label Name for matching,,-label liver
+   -type,Find Matching Model of type (segmentation/annotation),,-type segmentation
    -output,Save output result into a file,,-output models.json
 
 Example
@@ -58,8 +59,8 @@ Example
       -label spleen
 
 
-DEXTR3D
--------
+DEXTR3D (Annotation)
+--------------------
 
 Provides implementation for ``nvidia::aiaa::Client::dextra3d()`` API.
 For more details refer `aiaa-dextra3d.cpp <https://github.com/NVIDIA/ai-assisted-annotation-client/blob/master/src/cpp-client/tools/aiaa/aiaa-dextra3d.cpp>`_
@@ -110,7 +111,7 @@ Example
 
 
 Segmentation
--------
+------------
 
 Provides implementation for ``nvidia::aiaa::Client::segmentation()`` API.
 For more details refer `aiaa-segmentation.cpp <https://github.com/NVIDIA/ai-assisted-annotation-client/blob/master/src/cpp-client/tools/aiaa/aiaa-segmentation.cpp>`_
@@ -147,8 +148,8 @@ Example
       -output tmp_out.nii.gz
 
 
-Mask 2D Polygon
----------------
+Mask To 2D-Polygon
+------------------
 
 Provides implementation for ``nvidia::aiaa::Client::mask2Polygon()`` API.
 For more details refer `aiaa-mask-polygon.cpp <https://github.com/NVIDIA/ai-assisted-annotation-client/blob/master/src/cpp-client/tools/aiaa/aiaa-mask-polygon.cpp>`_

py-client/client_api.py

@@ -164,7 +164,7 @@ def dextr3d(self, model_name, image_file_path, result_file_prefix, point_set, pa
 
     def segmentation(self, model_name, image_file_path, result_file_prefix, params):
         """
-        3D image segmentation using DEXTR3D method
+        3D image segmentation method
     
         :param model_name: model name according to the output of model_list()
         :param image_file_path: input 3D image file name