Editing User:Sharan.nyn/GSoC18/Project

'''Name:''' Saran Narayan

'''IRC Nick:''' SaranNarayan

'''SourceForge Profile:''' '''https://sourceforge.net/u/sharannyn'''

'''GitHub Profile:''' '''https://github.com/sharan-nyn'''

'''Brief Background Information'''

<p>3rd year B.Tech student aspiring Computer Science and Engineering at Govt. Model Engineering College, Thrikkakara, India.</p>
<p>Google Code-In 2012 and 2013 finalist for BRL-CAD. I did 10 tasks in 2012 and 20 tasks in 2013. Most of them were modeling, graphics designing and a few related to finding bugs.</p>
<p>I am well versed with C/C++ and have experience in graphic designing, UI designing.</p>

= Project Information =

= Project Title: Implementing Check command in C and its GUI in Tcl/Tk =

= Brief Project Summary =

This project aims to bring cross platform compatibility to the existing check command that is
used by the Overlap tool. Also designing a GUI in TCL that runs the check command. The
output of this check command is then used by the existing checker GUI.

= Detailed Project Description =

'''Introduction'''

This project is amongst the user interface project ideas under the high priority list. The
overlap tool is used very often when creating models. Overlaps are undesirable but they are
bound to happen most of the times. This tool provides features like detecting the overlaps,
listing the overlaps, visualizing it and giving options on how to eliminate them.


'''Major Issue'''

One of the major issues with the current implementation is the Linux dependency of the
overlap tool.The check.sh is a Linux script that is used to detect overlaps and save them in
an overlap file which is then used by the overlap tool to tabulate, visualize and solve them.
After going through the current implementation of the check.sh, these are the following steps
that happen:

<ol style="list-style-type: decimal;">
<b><li>Finding the locations of the commands</li></b>
<p>The first step that happens in the script is that it finds the locations of the commands the tool
uses which are rtcheck, gqa, mged and loop.</p>
<b><li>Getting list of top objects if not provided</li></b>
<p>Next step is getting the list of top objects in the database file provided, this list of objects are
used to run the rtcheck and gqa command.</p>
<b><li>Running rtcheck</li></b>
<p>Now for each object in the list, the rtcheck command is run for all possible combinations of
az, el ( 0, 45, 90, 135). Which gives 16 combinations for all objects. The logs of the rtcheck
command is saved.</p>
<b><li>Parsing the logs of rtcheck</li></b>
<p>The logs of rtcheck are then processed by sed, cut and awk to return just the overlap pairs,
volume. This data is stored to a pairings file.</p>
<b><li>Running gqa</li></b>
<p>For a second opinion, the overlaps are checked for the same objects again with grid spacing
set to 1mm,1mm. The logs of the gqa command is saved.</p>
<b><li>Parsing logs of gqa</li></b>
<p>The logs of gqa are now parsed using sed and awk to return just the overlap pairs and
volume. This data is appended to the pairing file.</p>
<b><li>Sorting and removing duplicate overlaps</li></b>
<p>The next step involves sorting the overlaps and removing duplicate overlaps to get just the
unique pairings. This output is then passed to the checker.tcl file.</p>
</ol>
<p>Now to implement the above described features in C,
I need to remove the use of text processing done on the outputs of rtcheck and gqa
commands and refactor these commands so that they return required outputs which can be
directly used by the main program without the need of parsing.
</p><p>
The rtcheck command’s code is in /src/rt/viewcheck.c, the overlap list is a linked list that has the following node structure:</p>

<ol style="list-style-type: decimal">
<li><p>A pointer to the next node in the list, it’s a must in linked list. So that we can iterate
the list</p></li>
<li><p>Two character variables to store the overlapping regions</p></li>
<li><p>A size_t type to store the unsigned count of overlaps</p></li>
<li><p>A double type variable to store the depth of the overlaps</p></li>
</ol>

<p>What I have to do is refactor the rtcheck command to a libanalyse function, then make
rtcheck use this function. Exactly what happens in gqa command, which calls the
add_unique_pair( ) function stored in /src/libanalyse/overlaps.c
The add_unique_pair function has the parameters of the form:</p>

<ol style="list-style-type: decimal">
<li><p>Pointer to a type of region_pair, which gets the address of the local overlap list used
in gqa command.</p></li>
<li><p>Two region structures which are passed from gqa after finding the overlapping pairs.</p></li>
<li><p>A double type variable to pass the depth/thickness of the overlap.</p></li>
<li><p>A point_t type variable to pass the coordinates where the overlap happens.</p></li>
</ol>

'''User Interface'''
<p>I have thought of an interface that is easy to use, there will be two ways to define the objects
list to check the overlaps:</p>
<ol style="list-style-type: decimal">
<li><p>Manually typing and add to the list of the objects to check</p></li>
<li><p>Select from tree display of all items.</p></li>
</ol>
<p>For a better idea look at the prototype I have in mind :</p>
<center>[[File:CheckGUI.png|800px]]</cener>
<p>There are five components:</p>
<ol style="list-style-type: decimal">
<li><p>Tree display of all objects in DB.</p></li>
<li><p>List of the selected objects to check.</p></li>
<li><p>Text input field to manually add or remove items from the list of selected objects.</p></li>
<li><p>Check top objects button.</p></li>
<li><p>Check and Clear buttons.</p></li>
</ol>
<p>For tree display, I will look into the code for the browse geometry tool, located in
/src/tclscripts/geometree/</p>
<p>Adding the list would be fairly simple, I would look into the checker.tcl which uses a list to
display overlap pairs.</p>
<p>For the manual inputs, I need to check if it exists already in the list of objects before
removing or adding items and show an error if an already added item is being added or an
item is deleted which doesn’t exist in the list.</p>
<p>The check top objects button calls the check.c command without any arguments so it
automatically run the tool on top objects.</p>
<p>The clear button would be useful to discard the list of selected objects and start over.</p>
<p>The check button executes the newly written check.c command with selected objects as
arguments.</p>

= Milestones =
TODO

= Time Availability =

<p>I will be devoting at least 40 hours/week for this project and more if needed. During my
vacations that is from May 17,2018 to August 1,2018, I have no other obligations planned that
overlaps with the coding period. I will be having my end semester exams from April 26,2018 to May 17,2018. I will manage by allocating time judiciously.</p>

= Additional Information =
<p>I have submitted the following patches during application period and application review period:</p>
<p>Fixed a bug with the existing overlap tool:</p>
	https://sourceforge.net/p/brlcad/patches/476/
<p>A task assigned by Sean, a simple command that prints hello message</p>
	https://sourceforge.net/p/brlcad/patches/478/
<p>A TODO task under libged, in src/libged/tables.c where a temporary file is getting used, is created by bu_temp_file( ).</p>
	https://sourceforge.net/p/brlcad/patches/479/
<p>A TODO task, added support to rt tools and gtools for specifying az/el in radians or degrees with an explicit 'rad' suffix and an implicit 'deg' suffix. </p>
	https://sourceforge.net/p/brlcad/patches/481/
	https://sourceforge.net/p/brlcad/patches/482/

= Why BRL-CAD? =

<p>CAD softwares and making models in 3D were always my interests. BRL-CAD gave me the
taste for open source development in my experience with Google Code-In. The mentors are
really friendly and helpful. The projects under BRL-CAD are interesting and practical.</p>

= Why Me? =

<p>I am really excited to work with BRL CAD on this project. I am always looking forward to
opportunities to learn new things. I am persistent and hardworking.</p>
@@ Line 1: / Line 1: @@
 '''Name:''' Saran Narayan
-'''Project Mentor:''' Daniel Rossberg
 '''IRC Nick:''' SaranNarayan
 '''SourceForge Profile:''' '''https://sourceforge.net/u/sharannyn'''
+'''GitHub Profile:''' '''https://github.com/sharan-nyn'''
 '''Brief Background Information'''
@@ Line 101: / Line 101: @@
 </ol>
 <p>For a better idea look at the prototype I have in mind :</p>
-<center>[[File:CheckGUI.png|800px]]</center>
+<center>[[File:CheckGUI.png|800px]]</cener>
 <p>There are five components:</p>
 <ol style="list-style-type: decimal">
@@ Line 123: / Line 123: @@
 arguments.</p>
-= Deliverables =
+= Milestones =
-* First Deliverable:
+TODO
-** Libanalyze function.
-** Refactored rtcheck command.
-** Basic implementation of check command.
-* Second Deliverable:
-** Complete implementation of the check command
-** Basic GUI for the check command.
-* Final Deliverable:
-** Finished GUI for the check command.
-= Timeline =
-* Week 1:
-** Implement a libanalyze function - analyze_overlaps() to do the work rtcheck does.
-** Start implementation of the check command - call this libanalyze function like the current shell script does for rtcheck, get the results as overlapList.
-* Week 2:
-** Continue work on rtcheck if it was incomplete in the previous week.
-** Add capabilities of gqa to this libanalyze function.
-** Call the libanalyze function for the newly added gqa features and get the results as the overlapList in check command
-* Week 3:
-** Continue work on gqa if it was incomplete in the previous week.
-** Refactor the existing rtcheck to use the new libanalyze function.
-* Week 4:
-** Testing, debugging and cleanup.
-** Getting the check command ready for the first deliverable.
-** Start adding functions to do the processing of the overlapList.
-* Week 5:
-** 1st evaluation report submission.
-** Add the remaining work done by the shell script to the check command, like sorting, removing duplicates and writing output to a pairing files to be used by the overlap GUI.
-* Week 6:
-** Calling the overlap checker tool from the check command.
-** Start working on the GUI part of the check command.
-* Week 7:
-** Finish a basic GUI to call the check command before the 2nd evaluation.
-* Week 8:
-** Testing, debugging, documentation and cleanup to prepare for the second deliverable.
-* Week 9:
-** 2nd evaluation report submission.
-** Start adding more advanced features to the check commands GUI like tree list view.
-* Week 10 & 11:
-** Complete the GUI part with the proposed features fully implemented.
-** If time allows add ability to use * wild card for bulk add/remove objects to the list.
-* Week 12:
-** Final testing and bug fixing.
-** Documentation and code cleanups before final submission.
-* Week 13:
-** Prepare final report on the project.
 = Time Availability =