forked from wg-perception/PartsBasedDetector
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added installation documentation for ECTO/ROS/Catkin
- Loading branch information
hbristow
committed
Sep 7, 2012
1 parent
45f3f62
commit cd1f7cd
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
------------------------------------------------- | ||
INSTALLATION GUIDELINES | ||
------------------------------------------------- | ||
|
||
The PartsBasedDetector can be configured to support a number | ||
of external libraries. In particular, interfaces to ROS and | ||
ECTO can be built, which requires a different build process. | ||
The different options are detailed below: | ||
|
||
|
||
STANDALONE | ||
This is regular cmake. Open the root CMakeLists.txt and | ||
change the options and flags to meet your needs. Then: | ||
mkdir build | ||
cd build | ||
cmake .. | ||
make -j8 | ||
|
||
|
||
ECTO OR ROS | ||
With the release of ROS Groovy, the build system has transitioned | ||
to Catkin. The PartsBasedDetector ECTO cell and ROS node are built | ||
using catkin. This repository must therefore be inserted into the | ||
build tree as per the catkin way. Schematically, this appears as | ||
such: | ||
|
||
-- workspace | ||
| | ||
|-- CMakeLists.txt (top-level) | ||
| | ||
|-- PartsBasedDetector | ||
| | ||
|-- cvmatio (if you have/need it) | ||
| | ||
|-- build | ||
|
||
Building the PartsBasedDetector is then a matter of invoking the | ||
top-level CMakeLists.txt from within build/ in the root of the | ||
workspace (not in PartsBasedDetector!). | ||
Catkin will automatically traverse the stacks in the workspace | ||
and build PartsBasedDetector (and ECTO cell and/or ROS node | ||
if you have selected those options) | ||
|
||
RUNNING THE DETECTOR/TRAINING | ||
To train a new model or run the detector using an existing model, | ||
please consult the README in matlab/ or the root respectively |