Commit 2c266d76 authored by Emmanuel Promayon's avatar Emmanuel Promayon

Fix some spelling mistakes

Signed-off-by: Emmanuel Promayon's avatarEmmanuel Promayon <Emmanuel.Promayon@imag.fr>
parent 3be1e2f9
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro appropriately
# find components
get_subdirectories(ACTIONS_LIST)
......
......@@ -50,7 +50,7 @@ public:
public slots:
/** this method is automatically called when the action is triggered.
* !!! This method works only if theWidget has been instantiated
* !!! This method works only if theWidget has been instanciated
* (i.e. if getWidget has been called at least once, this is the case when there is a GUI)
* if not, please use the apply method with the parameters...
*/
......
......@@ -4,7 +4,7 @@
# To add an application, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_application() macro apropriately
# In your CMakeLists.txt, use the camitk_application() macro appropriately
# Find applications
get_subdirectories(APPLICATIONS_LIST)
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro appropriately
# Inform the user he has the choice of the DICOM component, by default uses the incomplete ITK one
......
......@@ -46,11 +46,11 @@ using namespace camitk;
// --------------- Constructor -------------------
DicomComponent::DicomComponent(DicomSerie* dicomSerie) throw(AbortException) : ImageComponent("") {
// associated the component's dicom serie
// associated the component's dicom series
serie = dicomSerie;
std::vector<std::string> stdFileNames = dicomSerie->getStdFileNames();
// scan files for serie description
// scan files for series description
gdcm::Scanner scanner;
gdcm::Tag serieDescriptionTag = gdcm::Tag(0x0008, 0x103e);
scanner.AddTag(serieDescriptionTag);
......
......@@ -37,7 +37,7 @@ class vtkGDCMImageReader;
* @ingroup group_cepimaging_components_dicom
*
* @brief
* DICOM Component represents a volumic image of a DICOM SERIE with its corresponding tags information (as CamiTK properties).
* DICOM Component represents a volumic image of a DICOM SERIES with its corresponding tags information (as CamiTK properties).
* This class is part of the MODEL (in the MVP pattern) of the DICOM COMPONENT.
*
* @note This component uses GDCM >= 2.2 library.
......
......@@ -56,7 +56,7 @@ Component* DicomComponentExtension::open(const QString& path) throw (AbortExcept
serieParsed = DicomParser::parseDirectory(path);
// create a Dialog entry for each serie parsed
// create a Dialog entry for each series parsed
foreach(DicomSerie * dicomSerie, serieParsed) {
DicomDialogEntry* entry = new DicomDialogEntry();
entry->setSelected(false);
......@@ -69,7 +69,7 @@ Component* DicomComponentExtension::open(const QString& path) throw (AbortExcept
serieDialogEntries.append(entry);
}
// Prompt the user which serie he wishes to open
// Prompt the user which series he wishes to open
QApplication::setOverrideCursor(QCursor(Qt::ArrowCursor));
dialog = new DicomDialog(serieDialogEntries);
serieDialogEntries = dialog->getSelectedDicomDialogEntries();
......@@ -78,7 +78,7 @@ Component* DicomComponentExtension::open(const QString& path) throw (AbortExcept
// Open each selected Dicom as a component
if (!serieDialogEntries.isEmpty()) {
foreach(DicomDialogEntry * entry, serieDialogEntries) {
// Find the corresponding Dicom Serie in the List
// Find the corresponding Dicom Series in the List
foreach(DicomSerie * serie, serieParsed) {
if ( (serie->getStudyName() == entry->getStudyName()) &&
(serie->getSerieName() == entry->getSerieName()) ) {
......
......@@ -99,10 +99,10 @@ private:
/// The dialog that asks the user which dicom image files he wishes to open
DicomDialog* dialog;
/// The different Dicom SERIE parsed
/// The different Dicom SERIES parsed
QList<DicomSerie*> serieParsed;
/// The serie dialog entries representation in the VIEW
/// The series dialog entries representation in the VIEW
QList<DicomDialogEntry*> serieDialogEntries;
};
......
......@@ -78,22 +78,22 @@ public:
private:
/// Is this SERIE selected for opening?
/// Is this SERIES selected for opening?
bool selected;
/// Acquisition date of the SERIE.
/// Acquisition date of the SERIES.
QDate acquisitionDate;
/// Acquisition time of the SERIE.
/// Acquisition time of the SERIES.
QTime acquisitionTime;
/// Name of the STUDY this SERIE belongs to.
/// Name of the STUDY this SERIES belongs to.
QString studyName;
/// Name of this SERIE.
/// Name of this SERIES.
QString serieName;
/// Description of this SERIE.
/// Description of this SERIES.
QString serieDescription;
/// Name of the patient.
......
......@@ -96,7 +96,7 @@ QList<DicomSerie*> DicomParser::parseDirectory(const QString& directory) {
seriesScanner.Scan(studyFileNames);
const std::set< std::string > serieValues = seriesScanner.GetValues();
foreach(std::string serieName, serieValues) {
// get file associated with this serie
// get file associated with this series
std::vector< std::string > serieFileNames = seriesScanner.GetAllFilenamesFromTagToValue(serieUIDTag, serieName.c_str());
// build a DicomSerie object corresponding to what we have found
......
......@@ -59,7 +59,7 @@ public:
/**
* @brief Parse the input directory for DICOM series.
* @param directory The input directory to parse DICOM image files.
* @return A list of DicomSerie, high level CamiTK object which store information of a SERIE
* @return A list of DicomSerie, high level CamiTK object which store information of a SERIES
*/
static QList<DicomSerie*> parseDirectory(const QString& directory);
......@@ -86,43 +86,43 @@ private:
static std::vector< std::string > qtListOfStringToStd(const QList<QString>& inputList);
/**
* @brief Retrieve the SERIE acquisition date.
* @param serieFileNames The filenames belonging to a single serie.
* @return the acquisition date of this SERIE.
* @brief Retrieve the SERIES acquisition date.
* @param serieFileNames The filenames belonging to a single series.
* @return the acquisition date of this SERIES.
*/
static QDate getAcquisitionDate(const std::vector<std::string>& serieFileNames);
/**
* @brief Retrieve the SERIE acquisition time.
* @param serieFileNames The filenames belonging to a single serie.
* @return the acquisition time of this SERIE.
* @brief Retrieve the SERIES acquisition time.
* @param serieFileNames The filenames belonging to a single series.
* @return the acquisition time of this SERIES.
*/
static QTime getAcquisitionTime(const std::vector<std::string>& serieFileNames);
/**
* @brief Retrieve the patient name information from the input files.
* @param serieFileNames The filenames belonging to a single serie.
* @param serieFileNames The filenames belonging to a single series.
* @return the patient name.
*/
static QString getPatientName(const std::vector<std::string>& serieFileNames);
/**
* @brief Retrieve the serie name.
* @param serieFileNames The filenames belonging to a single serie.
* @return the serie name.
* @brief Retrieve the series name.
* @param serieFileNames The filenames belonging to a single series.
* @return the series name.
*/
static QString getSerieName(const std::vector<std::string>& serieFileNames);
/**
* @brief Retrieve the serie description.
* @param serieFileNames The filenames belonging to a single serie.
* @return the serie description.
* @brief Retrieve the series description.
* @param serieFileNames The filenames belonging to a single series.
* @return the series description.
*/
static QString getSerieDescription(const std::vector<std::string>& serieFileNames);
/**
* @brief Retrieve the study name.
* @param serieFileNames The filenames belonging to a single serie.
* @param serieFileNames The filenames belonging to a single series.
* @return the study name.
*/
static QString getStudyName(const std::vector<std::string>& serieFileNames);
......
......@@ -37,8 +37,8 @@
/**
* @ingroup group_cepimaging_components_dicom
*
* @brief DicomSerie is a CamiTK high level class to represent a DICOM SERIE
* This class encapsulates GDCM objects to handle a DICOM SERIE
* @brief DicomSerie is a CamiTK high level class to represent a DICOM SERIES
* This class encapsulates GDCM objects to handle a DICOM SERIES
*
* @note This class is part of the model (in the MVP pattern) of the DICOM COMPONENT
* @note This class does NOT represent a CamiTK Component.
......@@ -82,28 +82,28 @@ public:
private:
/// Acquisition date of the SERIE.
/// Acquisition date of the SERIES.
QDate acquisitionDate;
/// Acquisition time of the SERIE.
/// Acquisition time of the SERIES.
QTime acquisitionTime;
/// Name of the STUDY this SERIE belongs to.
/// Name of the STUDY this SERIES belongs to.
QString studyName;
/// Name of this SERIE.
/// Name of this SERIES.
QString serieName;
/// Description of this SERIE (sometime more readable than the SERIE name itself).
/// Description of this SERIES (sometime more readable than the SERIES name itself).
QString serieDescription;
/// Name of the patient.
QString patientName;
/// The image file names associated to this SERIE
/// The image file names associated to this SERIES
QList<QString> fileNames;
/// The image file names associated to this SERIE (std list, for GDCM API)
/// The image file names associated to this SERIES (std list, for GDCM API)
std::vector<std::string> stdFileNames;
};
......
......@@ -39,17 +39,17 @@
*
* To betterly understand how this component works, here's a little reminder on how DICOM images are organized.
* For a given PATIENT, we can have several STUDIES. Each STUDY represent a collection of several medical examinations (which can result with images taken from different MODALITIES). A MODALITY is the provider of information, which is, in other words, the machine that allows the doctor to acquire images from the PATIENT. MODALITY are mainly scanners (MRI ...).
* Each STUDY can have several SERIES of images. One SERIE of images is the result of one medical examination using ONE MODALITY.
* Each STUDY can have several SERIES of images. One SERIES of images is the result of one medical examination using ONE MODALITY.
*
* This component works on images acquired in several SERIES, each of them in a specific STUDY (which can be different).
* Each SERIE of images represents one 3D volumic image.
* Each SERIES of images represents one 3D volumic image.
* The public constructor will parse the directory for different STUDIES with different SERIES of images and prompt the user which ones he wants to represent.
* Each series of images selected is then been rendered in CamiTK's viewers as an ImageComponent.
* DICOM images tags are also displayed as Property in the PropertyExplorer (DICOM tab).
*
* @note
* Requires GDCM library in order to work correctly.
* This component does not support 2D Images serie (GDCM limitation)
* This component does not support 2D Images series (GDCM limitation)
*/
class DicomTreeDirectoryComponent : public camitk::Component {
......
......@@ -50,13 +50,13 @@ DicomTreeSerieComponent::DicomTreeSerieComponent(const std::vector < std::string
// To allow closing only this component
setParent(NULL);
// scan files for serie description
// scan files for series description
gdcm::Scanner scanner;
gdcm::Tag serieDescriptionTag = gdcm::Tag(0x0008, 0x103e);
scanner.AddTag(serieDescriptionTag);
scanner.Scan(fileNames);
setName(QString(scanner.GetValue(fileNames.at(0).c_str(), serieDescriptionTag)));
// std::cout << "SERIE name = " << getName().toStdString() << std::endl;
// std::cout << "SERIES name = " << getName().toStdString() << std::endl;
// sort the files according to Patient position ect ...
gdcm::IPPSorter ippSorter;
......
......@@ -42,17 +42,17 @@ class vtkGDCMImageReader;
/**
*
* @brief
* This component allows you to read DICOM images files of a single SERIE of a given STUDY
* This component allows you to read DICOM images files of a single SERIES of a given STUDY
*
* One SERIE of images is the result of one medical examination using one MODALITY.
* One SERIES of images is the result of one medical examination using one MODALITY.
*
* This component works on images acquired of a same SERIE for a given STUDY
* This SERIE of images will be represented as a 3D volumic image (ImageComponent)
* This component works on images acquired of a same SERIES for a given STUDY
* This SERIES of images will be represented as a 3D volumic image (ImageComponent)
* DICOM images tags are also displayed as Property in the PropertyExplorer (DICOM tab).
*
* @note
* Requires GDCM library in order to work correctly.
* This component does not support 2D Images serie (GDCM limitation)
* This component does not support 2D Images series (GDCM limitation)
*
*/
class DicomTreeSerieComponent : public camitk::ImageComponent {
......@@ -63,7 +63,7 @@ public:
/**
* Build a ImageComponent representing the volumic image of the acquistion by a specific MODALITY.
* @param parent the parent DicomStudyComponent that contains all the SERIES.
* @param path: the image slices of a same SERIE for a given STUDY.
* @param path: the image slices of a same SERIES for a given STUDY.
**/
DicomTreeSerieComponent(const std::vector < std::string >& fileNames);
......@@ -88,7 +88,7 @@ private:
/**
* @brief Read the direct cosines angles from the input image
* @param fileNames the SERIE slices
* @param fileNames the SERIES slices
* @return the corresponding ImageOrientation, rounded modulo 90 degrees
*/
camitk::ImageOrientationHelper::PossibleImageOrientations readDirectCosinesAngle(const std::vector< std::string >& fileNames) const;
......
......@@ -52,9 +52,7 @@ DicomTreeStudyComponent::DicomTreeStudyComponent(const std::vector< std::string
seriesScanner.Scan(fileNames);
const std::set< std::string > serieValues = seriesScanner.GetValues();
foreach(std::string value, serieValues) {
// std::cout << "FOUND SERIE " << value << std::endl;
std::vector< std::string > serieFileNames = seriesScanner.GetAllFilenamesFromTagToValue(serieUIDTag, value.c_str());
// std::cout << "SERIE contains " << serieFileNames.size() << " files" << std::endl;
// This filter aims at removing volumic images containing only a few images, for doctors TOPO for instance
// if ippsorter algorithm returns 0, it means it hasn't been able to sort the files according to their Z spacing
......@@ -65,7 +63,6 @@ DicomTreeStudyComponent::DicomTreeStudyComponent(const std::vector< std::string
ippsorter.Sort(serieFileNames);
serieFileNames = ippsorter.GetFilenames();
// std::cout << "SERIE contains (after filering images (IPPSorter)) : " << serieFileNames.size() << " files" << std::endl;
if (serieFileNames.size() > 0) {
addChild(new DicomTreeSerieComponent(serieFileNames));
}
......
......@@ -43,16 +43,16 @@ class DicomTreeSerieComponent;
* This component allows you to read DICOM images files of several SERIES of a same STUDY
*
* Each STUDY represents a collection of several medical examinations (which can result with images taken from different MODALITIES). A MODALITY is the provider of information, which is, in other words, the machine that allows the doctor to acquire images from the PATIENT. MODALITY are mainly scanners (MRI ...).
* Each STUDY can have several SERIES of images. One SERIE of images is the result of one medical examination using ONE MODALITY.
* Each STUDY can have several SERIES of images. One SERIES of images is the result of one medical examination using ONE MODALITY.
*
* This component works on images acquired in several SERIES, but on the same specific STUDY.
* Each SERIE of images represents one 3D volumic image.
* Each SERIE of images selected is then been rendered in CamiTK's viewers as an ImageComponent.
* Each SERIES of images represents one 3D volumic image.
* Each SERIES of images selected is then been rendered in CamiTK's viewers as an ImageComponent.
* DICOM images tags are also displayed as Property in the PropertyExplorer (DICOM tab).
*
* @note
* Requires GDCM library in order to work correctly.
* This component does not support 2D Images serie (GDCM limitation)
* This component does not support 2D Images series (GDCM limitation)
*/
class DicomTreeStudyComponent : public camitk::Component {
......@@ -60,7 +60,7 @@ class DicomTreeStudyComponent : public camitk::Component {
public:
/**
* Parse the list of files and build a DicomSerieComponent per SERIE
* Parse the list of files and build a DicomSerieComponent per SERIES
* @param parent the parent DicomDirectoryComponent that contains all the studies
* @param fileNames images of different SERIES but of the same STUDY
**/
......
......@@ -4,7 +4,7 @@
# To add a library, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_library() macro apropriately
# In your CMakeLists.txt, use the camitk_library() macro appropriately
# Find applications
get_subdirectories(LIBRARY_LIST)
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro appropriately
# find components
get_subdirectories(ACTIONS_LIST)
......
......@@ -4,7 +4,7 @@
# To add an application, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_application() macro apropriately
# In your CMakeLists.txt, use the camitk_application() macro appropriately
# Find applications
get_subdirectories(APPLICATIONS_LIST)
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro appropriately
# Add subdirectories in CMake project, manually => handling dependencies
camitk_add_subdirectory(pmlcomponent)
......
......@@ -4,7 +4,7 @@
# To add a library, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_library() macro apropriately
# In your CMakeLists.txt, use the camitk_library() macro appropriately
# --- add every given library in dependencies order
camitk_add_subdirectory(lmlschema)
......
......@@ -35,7 +35,7 @@
* @ingroup group_cepmodeling_libraries_mml
*
* @brief
* Ansys batch writer allow to write a part of a batch file
* Ansys batch writer helps to write a part of a batch file
*/
class AnsysBatchWriter {
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro appropriately
#---------------------------------------------------------------------------------
#
# Recursively parse subdirectories for classes to expose
......
......@@ -4,7 +4,7 @@
# To add an application, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_application() macro apropriately
# In your CMakeLists.txt, use the camitk_application() macro appropriately
#---------------------------------------------------------------------------------
#
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro appropriately
#---------------------------------------------------------------------------------
#
# Recursively parse subdirectories for classes to expose
......
......@@ -4,7 +4,7 @@
# To add a library, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_library() macro apropriately
# In your CMakeLists.txt, use the camitk_library() macro appropriately
#---------------------------------------------------------------------------------
#
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro appropriately
# find components
get_subdirectories(ACTIONS_LIST)
......
......@@ -33,7 +33,7 @@
* @ingroup group_sdk_actions_application
*
* @brief
* The CloseAction class allow to close the selected component.
* The CloseAction class closes the selected component.
*
**/
class CloseAction : public camitk::Action {
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro appropriately
# find components
get_subdirectories(FRAME_ACTIONS_LIST)
......
......@@ -55,7 +55,7 @@ using namespace camitk;
// --------------- constructor -------------------
EditFrame::EditFrame(ActionExtension* extension) : Action(extension) {
setName("Edit Frame");
setDescription(tr("This action allow to edit a component's frame from its parent frame (or the world frame if it has no parent) by setting translations and rotation parameters."));
setDescription(tr("This action helps to modify a component's frame from its parent frame (or the world frame if it has no parent) by setting translations and rotation parameters."));
setComponent("Component");
// Setting classification family and tags
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro appropriately
# find components
get_subdirectories(IMAGE_ACTIONS_LIST)
......
......@@ -55,7 +55,7 @@ public:
public slots:
/** this method is automatically called when the action is triggered.
* !!! This method works only if theWidget has been instantiated
* !!! This method works only if theWidget has been instanciated
* (i.e. if getWidget has been called at least once, this is the case when there is a GUI)
* if not, please use the apply method with the parameters...
*/
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro appropriately
# find components
get_subdirectories(MESH_ACTIONS_LIST)
......
......@@ -4,7 +4,7 @@
# To add an application, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_application() macro apropriately
# In your CMakeLists.txt, use the camitk_application() macro appropriately
# Find applications
get_subdirectories(APPLICATIONS_LIST)
......
......@@ -12,11 +12,11 @@ Please visit http://camitk.imag.fr for more information.
(c) UJF\-Grenoble 1, CNRS, TIMC\-IMAG UMR 5525
.PP
camitk\-@APPLICATION_NAME@ is able to replay a pipeline (workflow) of CamiTK actions.
This application takes an CamiTK augmented version of a SCXML subset as input and allow to
replay interactive the described state-machine containing a list of CamiTK actions
and transitions.
This application takes an CamiTK augmented version of a SCXML subset as input and
interactively replays the described state-machine. The state-machine contains a list
of CamiTK actions and transitions.
.PP
The targeted users are in R&D departments or laboratories.
The targeted users are R&D departments or laboratories.
.PP
.SH "OPTIONS"
......
......@@ -12,9 +12,9 @@ Please visit http://camitk.imag.fr for more information.
(c) UJF\-Grenoble 1, CNRS, TIMC\-IMAG UMR 5525
.PP
camitk\-@APPLICATION_NAME@ is able to replay a pipeline (workflow) of CamiTK actions.
This application takes an CamiTK augmented version of a SCXML subset as input and allow to
replay interactive the described state-machine containing a list of CamiTK actions
and transitions.
This application takes an CamiTK augmented version of a SCXML subset as input and
interactively replays the described state-machine. The state-machine contains a list
of CamiTK actions and transitions.
.PP
The targeted users are in R&D departments or laboratories.
.PP
......
......@@ -12,7 +12,7 @@
for your extension. You then will have to complete one or 2 files, compile
and test it with a CamiTK application
</p>
<p>The prerequisit for this module are:
<p>The prerequisites for this module are:
<ul>
<li>Knowing what a CamiTK Extension is (see <a href="http://www.camitk.fr">http://www.camitk.fr</a> for help)</li>
<li>Knowing the differences between <b><i>Action</i></b>, <b><i>Application</i></b>
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro appropriately
# find components
get_subdirectories(COMPONENTS_LIST)
......
......@@ -4,7 +4,7 @@
# To add a library, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_library() macro apropriately
# In your CMakeLists.txt, use the camitk_library() macro appropriately
# Recursively update the shiboken path variable containing the CamiTK SDK tree structure
set(SHIBOKEN_CAMITK_SDK_PATH ${SHIBOKEN_CAMITK_SDK_PATH}:${CMAKE_CURRENT_SOURCE_DIR} CACHE INTERNAL "")
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(ACTION_EXTENSION ...) macro appropriately
# find components
get_subdirectories(ACTIONS_LIST)
......
......@@ -4,7 +4,7 @@
# To add an application, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the application_extension() macro apropriately
# In your CMakeLists.txt, use the application_extension() macro appropriately
# Find applications
get_subdirectories(APPLICATIONS_LIST)
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro appropriately
# find components
get_subdirectories(COMPONENTS_LIST)
......
......@@ -4,7 +4,7 @@
# To add a library, just add a subdirectory (the application name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_library() macro apropriately
# In your CMakeLists.txt, use the camitk_library() macro appropriately
# Find applications
get_subdirectories(LIBRARY_LIST)
......
......@@ -99,7 +99,7 @@ class ObjectControllerPrivate;
Three different view mode are available to represent/interact with the property values:
- TREE based on a list view
- GROUPBOX same as TREE, but each group of properties are viewed in a group box
- BUTTON same as GROUPBOX, but buttons allow to show/hide the sub properties
- BUTTON same as GROUPBOX, but buttons allow the user to show/hide the sub properties
The view mode can be changed at any time, even at run-time (see the "objectcontroller" application).
......@@ -172,7 +172,7 @@ public:
enum ViewMode {
TREE, ///< The property browser can be shown like a QListView
GROUPBOX, ///< It is like the TREE but with a delimitation to indicate the arborescence of the property type
BUTTON ///< It is like the GROUPBOX but the buttons allow to control the comput display of arborescence
BUTTON ///< It is like the GROUPBOX but the buttons allow the user to control the comput display of arborescence
};
/// constructor of object controller with in parameters the parent widget and the view mode (default : TREE)
......
......@@ -4,7 +4,7 @@
# To add a component, just add a subdirectory (the component name is the
# directory name). Add all your code there and a text file called
# CMakeLists.txt
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro apropriately
# In your CMakeLists.txt, use the camitk_extension(COMPONENT_EXTENSION ...) macro appropriately
# find components
get_subdirectories(APPS_TEST_LIST)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment