From: El Hadi Moussi <moussi@phimeca.com>
Date: Tue, 13 Aug 2024 09:33:03 +0000 (+0200)
Subject: Update README
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=1b2fe60e26dbc8668d84bffc1a9513dc0004a29d;p=tools%2Fmedcoupling.git

Update README
---

diff --git a/src/ShapeRecogn/README.md b/src/ShapeRecogn/README.md
index a9f17c589..61b9eb4d0 100644
--- a/src/ShapeRecogn/README.md
+++ b/src/ShapeRecogn/README.md
@@ -14,8 +14,9 @@ A tool leveraging the MEDCoupling library for recognizing canonical shapes in 3D
 ```python
 >> import ShapeRecogn as sr
 >>
->> shape_recogn = sr.ShapeRecognMesh("resources/ShapeRecognCone.med")
->> shape_recogn.recognize("ShapeRecognCone_areas.med")
+>> shape_recogn_builder = sr.ShapeRecognMeshBuilder("resources/ShapeRecognCone.med")
+>> shape_recogn = shape_recogn_builder.recognize()
+>> shape_recogn.save("ShapeRecognCone_areas.med")
 ```
 
 ### Without output file
@@ -23,9 +24,9 @@ A tool leveraging the MEDCoupling library for recognizing canonical shapes in 3D
 ```python
 >> import ShapeRecogn as sr
 >>
->> shape_recogn = sr.ShapeRecognMesh("resources/ShapeRecognCone.med")
->> shape_recogn.recognize()
->> radius_field = shape_recogn.buildRadius()
+>> shape_recogn_builder = sr.ShapeRecognMeshBuilder("resources/ShapeRecognCone.med")
+>> shape_recogn = shape_recogn_builder.recognize()
+>> radius_field = shape_recogn.getRadius()
 >> radius_field
 MEDCouplingFieldDouble C++ instance at 0x55f3418c6700. Name : "Radius (Area)".
 Nature of field : NoNature.
@@ -89,17 +90,17 @@ Some intermediate computation values concerning the nodes are also available:
  - Primitive Type (Node) : One of the canonical shape with the id describe above. The primitive type is deduced usint K1 and K2 values.
  - Normal (Node): Normal of the nodes using neighbor nodes
 
-Each field can be respectively build as a `MEDCouplingDoubleField` using the following methods of the `ShapeRecognMesh` class:
- - `buildAreaId()`
- - `buildAreaPrimitiveType()`
- - `buildAreaNormal()`
- - `buildMinorRadius()`
- - `buildRadius()`
- - `buildAngle()`
- - `buildCenter()`
- - `buildAxis()`
- - `buildApex()`
- - `buildNodeK1()`
- - `buildNodeK2()`
- - `buildNodePrimitiveType()`
- - `buildNodeNormal()`
+Each field can be retrieved as a `MEDCouplingDoubleField` using the following methods of the `ShapeRecognMesh` class:
+ - `getAreaId()`
+ - `getAreaPrimitiveType()`
+ - `getAreaNormal()`
+ - `getMinorRadius()`
+ - `getRadius()`
+ - `getAngle()`
+ - `getCenter()`
+ - `getAxis()`
+ - `getApex()`
+ - `getNodeK1()`
+ - `getNodeK2()`
+ - `getNodePrimitiveType()`
+ - `getNodeNormal()`