Skip to content

Commit 6d7bf0d

Browse files
author
Shushman Choudhury
committed
README for perception pipeline
1 parent e5f0733 commit 6d7bf0d

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ adetector = ApriltagsModule(marker_topic='/apriltags_kinect2/marker_array',
198198
detected_objects = adetector.DetectObjects(robot)
199199
```
200200

201-
### Perception Methods
201+
### Perception Modules
202202

203203
Currently, the following perception routines are supported:
204204

@@ -207,9 +207,24 @@ Currently, the following perception routines are supported:
207207
- `SimTrack`
208208
- `BlockDetector`
209209
- `ROCK`: Robust Object Constellation and Kinematic Pose
210-
211210

212211

212+
### Common Perception Methods
213+
214+
At this point, two methods are common to all perception routines. However, some
215+
routine-specific knowledge may be required to make them work.
216+
217+
- `DetectObjects(self, robot, **kw_args)`: This runs the perception method for all
218+
objects that the particular routine knows about. Typically, this information is specified
219+
either as a config file (in the case of AprilTags) or in the constructor of the respective
220+
module.
221+
- `DetectObject(self,robot,obj_name)`: This runs the perception routine to detect a particular object,
222+
based on the known names in the database.
223+
224+
The return type for both is typically one or more OpenRAVE kinbodies, with the correct
225+
transformation relative to the current environment, if the input `tf`s have been
226+
correctly provided.
227+
213228
## Environment Cloning
214229

215230
Cloning environments is critical to enable planning with multiple planners in

0 commit comments

Comments
 (0)