Menu
Logged-In As
ACCOUNTNot Logged In
Write manual page documentation (for g-voxel)BRL-CAD
Status: ClosedTime to complete:
100 hrs
Mentors: Harmanpreet, IshwerdasBeginner
BRL-CAD has hundreds of tools but they're not all documented. We use the Docbook XML system for documentation, which is very much like HTML, but don't worry -- we have LOTS of examples you can follow. Our build system will even validate your file to make sure you didn't make a mistake.
This task entails briefly learning how this geometry converter application works and then writing initial documentation for it. Look at the other g-*.xml files in the doc/docbook/system/man1/en directory for a couple dozen examples.
Once you've created your new file, you'll want to check your work.
- download BRL-CAD from Subversion or use our VM image
- compile BRL-CAD: http://brlcad.org/wiki/Compiling
- create your new file (doc/docbook/system/man1/en/g-voxel.xml)
- add it to the build system ( edit doc/docbook/system/man1/en/CMakeLists.txt )
- compile again (make) and make sure it doesn't give an error
- check the compiled version ( in your build directory, run: bin/brlman g-voxel )
A lot of little steps, but it's really very easy.
References:- doc/docbook/system/man1/en/g-*.xml
- http://brlcad.org/VolumeIV-Converting_Geometry.pdf
- src/conv/g-voxel.c
- doc/docbook/system/man1/en/g-voxel.xml -- you'll create this
- doc/docbook/system/man1/en/CMakeLists.txt -- add your new file here
Uploaded Work
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| g-voxel_patch.diff | 3.0 KB | December 13 2014 06:56 UTC | |
| g-voxel_patch.diff | 3.2 KB | December 14 2014 06:44 UTC |
I would like to work on this task.
This task has been assigned to mandarj. You have 100 hours to complete this task, good luck!
What does the g-voxel command do?
I went over the .c file but I could not understand what the g-voxel command does (and its options).
Please Help!
g-voxel generates a list of voxels (fat points, you may see them as cubes) from a .g file and writes them in a voxels.txt file. Together with the coordiantes of the center of each voxel it writes the corresponding BRL-CAD region and the ratio it is filled to the file.
Parameters are the voxels size in x, y and z, the level of detail (which influences the number of rays used) and the threshold upon which a voxel will be considered.
See:
what options can it take?
also, if possible, could you give an example?
The work on this task is ready to be reviewed.
One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.
Mandarj, I was almost going to mark this as completed but then tested the compilation, and noticed that the synopsis was missing the file and object arguments. You talk about them, but they need to be in the usage statement.
The work on this task is ready to be reviewed.
You will need to apply the patch to the current BRL-CAD svn repository (not over the one I submitted previously).
You will need to apply the patch to the main BRL-CAD svn trunk (not 'over' the previously submitted patch)
Mandarj,
Thank you! This looks good now. It's already been committed to our sources and you've been credited in our authorship documentation. If you'd like to be credited with your full name, please provide it to contest@brlcad.org with a link to this task.
Congratulations, this task has been completed successfully.