Skip to content
Snippets Groups Projects

enh(doc): update documentation to match latest version of sight

Merged Marc SCHWEITZER requested to merge 29-doc-remove-how-to-add-a-new-dependency into dev
All threads resolved!
Files
5
+ 0
67
@@ -48,13 +48,6 @@ Which prerequisites do I need to develop new services and modules ?
You must have a good knowledge in C++. Concerning the configuration files, they are written in XML.
What are the BinPkgs?
======================
The BinPkgs (binary packages) contain all the extern libraries needed by sight.
For each BinPkg, a CMakeLists provides the OS specific instructions to build it.
They can be downloaded on https://git.ircad.fr/sight/sight-deps.
Is it difficult to compile an application with sight?
======================================================
@@ -128,63 +121,3 @@ i.e. for sight::data::Image, itk::Image vs vtkImage ?
sight::data::Image<=>itk::Image and sight::data::Image<=>vtkImage.
- Otherwise, you can just encapsulated an itk::Image in sight::data::Image and create an accessor on it. ( however,
this choice implies that all applications that use sight::data::Image need ITK library for running. )
.. _campPath:
What is a camp path ?
======================
A **camp path** (also called sesh@ path) is a path used to browse an object (and sub-object)
using the introspection (see fwDataCamp and :ref:`SADSerialization`).
The path begins with a '@' or a '!'.
- ``@`` : the returned string is the fwID of the sub-object defined by the path.
- ``!`` : the returned string is the value of the sub-object,
it works only on String, Integer, Float and Boolean object.
Sadly, we do not have yet a document giving the paths for all existing data.
To know how an object can be accessed with a sesh@ path, you can
have a look at the corresponding fwDataCamp implementation of the object.
For instance, the file *fwDataCamp/Image.cpp* shows :
.. code:: c++
SIGHT_IMPLEMENT_DATA_REFLECTION((sight)(data)(Image))
{
builder
.tag("object_version", "2")
.tag("lib_name", "fwData")
.base<sight::data::Object>()
.property("size", &sight::data::Image::m_size)
.property("type", &sight::data::Image::m_type)
.property("spacing", &sight::data::Image::m_spacing)
.property("origin", &sight::data::Image::m_origin)
.property("array", &sight::data::Image::m_dataArray)
.property("nb_components", &sight::data::Image::m_numberOfComponents)
.property("window_center", &sight::data::Image::m_windowCenter)
.property("window_width", &sight::data::Image::m_windowWidth)
;
}
Which means that each property is a reachable by a **camp path**.
This is notably used by services in the ``ctrlCamp`` module, like ``SExtractObjObj`` or ``SCopy``.
For instance the height of the image can be retrieved using:
.. code:: xml
@size.1
Other examples:
----------------
To get the image contained in a ``sight::data::Composite`` with the key ``myImage``
.. code:: xml
@values.myImage
To get the first reconstruction of a ModelSeries contained in a ``sight::data::Composite`` with the key ``myModel``
.. code:: xml
@values.myModel.reconstruction_db.0
Loading