GSOC 2010 Makefile Lib Proposal - Revision history

Erik Krause: categorized

2010-06-25T13:34:19Z

categorized

Flo: better Schedule

2010-04-07T08:14:33Z

better Schedule

Flo: crop abstract

2010-04-06T08:37:06Z

crop abstract

Flo at 16:01, 5 April 2010

2010-04-05T16:01:03Z

Flo at 14:01, 5 April 2010

2010-04-05T14:01:47Z

Flo: Created page with '

About Me

My name is Florian Achleitner, I'm 26, from Austria and studying Telematics (a blend of computer science and electric engineering) at the Graz University o...'

2010-04-05T11:02:16Z

Created page with '<h2>About Me</h2> <p> My name is Florian Achleitner, I'm 26, from Austria and studying Telematics (a blend of computer science and electric engineering) at the Graz University o...'

New page

<h2>About Me</h2>
<p>
My name is Florian Achleitner, I'm 26, from Austria and studying Telematics
(a blend of computer science and electric engineering) at the Graz University of Technology.
</p><p>
Currently I'm in the second year of my studies. I will graduate to BSc next year and then
continue the master studies.
Before starting my studies I worked for four years as a developer in industry, mainly on automotive
embedded systems.
</p>
<h2>My Experience</h2>
<p>
My programming experience grew since I started writing programs on TI calculators in school
probably 15 years ago.
From my work and university experience I'm good with C, C++, Python, Makefiles, Unix Tools in general,
Java, Shell Scripts.. (sorted by experience).
</p><p>
I'm open-source enthusiast, exclusively using Linux since years. Until now I haven't made major
contributions to open-source projects, except some bug reports and testing. But I have often checked
out source codes, to take a look at how it works, and why something doesn't work.
I frequently patched and built my own kernel images. That's why I like the open source spirit, I like
to be able to look into things.
</p><p>
My development platform is a Core2Duo E8500 with 4GB RAM running Ubuntu 64bit (currently karmic).
For testing I usually setup other platforms in virtual machines
</p>

<h2>About Photography</h2>
<p>
My camera is a Konica Minolta Dimage Z5, which is no longer new or good unfortunately,
but provides advanced capture modes. I don't have any special panorama equipment, except a tripod :).
</p><p>
I played with hugin and also commercial panorama tools before. Since many years I like shooting panoramas
from mountain summits. I mostly photograph during outdoor activities.
</p><p>
Here are two examples:
</p>
<ul>
<li>[http://filestore.mg34.vc-graz.ac.at/pano/linz.jpg A view of Linz], an Austrian town I visited some days ago. Freehand shot.</li>
<li>[http://filestore.mg34.vc-graz.ac.at/pano/eiffelpeakpanorama.jpg This one was shot last summer in the Canadian Rockies] on the over 3000m high Eiffel Peak on a
great trip through Canada. (also stitched with hugin). Shot on a mini-tripod.</li>
</ul>
<p>
Photography is the reason why I apply to hugin. Because I'm interested in photography and creating
panoramas, and because I'm interested in image processing.
</p>

<h2>About Me, Hugin, and GSOC</h2>
<p>
Until now, I've never actively contributed to hugin, I was an interested user.
</p><p>
I've also never before participated in GSOC. I see this as an altervative to a regular summer job,
which is normally also related to development. So working as much as in a regular job goes without saying.
</p>

<h2>The Project: Implementing a Makefile Output Library and Integration with the existing Tools</h2>

<h3>Current situation</h3>
<p>
Hugin uses makefiles and GNU Make to invoke the tools actually doing the work, when creating a panorama.
The makefile contains all configuration values and can therefore be used independently from the hugin
project in the GUI, once created.
</p><p>
Currently the makefile is created by one huge method, namely
HuginBase::PanoramaMakefileExport::createMakefile(..). Which contains both, the preparation of
the data and the output into the makefile. It is hard to maintain and error prone, because of
quoting problems and easily occurring violation of makefile syntax when making changes.
</p>

<h3>Replacement of the Makefile output with a generic library</h3>
<p>
First step is the creation of bulletproof makefile creation library. The implementation is done in C++.
The Design is an object oriented abstraction of the items existing in a makefile. For example, rules
dependencies, targets, prerequisites. As a guideline an
[http://search.cpan.org/~bpostle/Panotools-Script-0.24/lib/Panotools/Makefile.pm existing implementation]
in Perl by Bruno Postle can be used.
</p><p>
An important aspect is, that every object can output itself to
the actual makefile, considering quoting and escaping with respect to the GNU Make specification
and probably invoked sub-shells. Because this is critical, research about special characters,
extensive testing, and creation of a suitable tester is necessary. It's also important to consider
differences on different platforms.
A top level object will hold an manage all makefile items representations and handle the output and
creation.
</p><p>
The code part that currently collects the data to be written to the makefile will be isolated, maybe
replaced to use the new makefile framework, and create the representing makefile items.
Then changing the panorama creation process no longer involves dealing with makefile syntax or quoting,
and is easy to understand and to change.
</p>

<h3>Adapt Control Point Detection to use Makefile</h3>
<p>
Changing the invocation of Control Point Creation Tools to use makefiles too has the advantage that
this process becomes detachable from the GUI program and can be executed by the batch processor tool
PTBatcherGUI.
</p>

<h3>Extend PTBatcherGUI to queue Makefiles</h3>
<p>
PTBatcherGUI handles and executes preconfigured actions, currently only stitching of panoramas.
The extension of PTBatcherGUI to support generic makefile-based jobs allows us to queue for later
processing not only
stitching but also control point detection, or automatic detection of panoramas, or whatever we are
going to figure out in the future.
</p>

<h3>Automatic detection of panoramas</h3>
<p>
Using the makefile framework automatic detection of panoramas by analyzing the photos in a folder
can be realized. The detection can consider image metadata, like creation time, or several capture
conditions and use control point detectors to find overlapping pictures.
</p>

<h2>Schedule</h2>
<p>
The above described points are probably to much to complete during summer of code. So the core
of the project is the creation of the Makefile output library, which will be scheduled first, while
the other points come afterwards and may be done after the end of GSOC 2010.
Sorted by importance:
</p>
<ul>
<li>Replacement of the Makefile output with a generic library</li>
<li>Adapt Control Point Detection to use Makefile</li>
<li>Extend PTBatcherGUI to queue Makefiles</li>
<li>Automatic detection of panoramas</li>
</ul>

<p>
One problem I face when scheduling GSOC work is, that it's timetable doesn't suit very well to that of
the universities in Austria. Our Semester ends with the end of June, that means in this month, there will
be a lot of submissions and exams and not too much time to program for GSOC. But our holidays extend until
the beginning of October, which allows me to continue working for Hugin for more than a month after GSOC
is over.
</p>
<h3>Preliminary Schedule</h3>
<ul>
<li>30. June: Design of the Makefile creation library finished, design classes stubbed.</li>
<li>31. July: Implementation of Makefile library ready for extensive testing and review.
Tester framework is up and running. Integration into the existing hugin code.</li>
<li>9. August: Testing complete. Final code review.</li>
<li>16. August: Finished documentation, project submission.</li>
<li>31. August: Integration into hugin done and tested.</li>
<li>30. September: Control Point Creation and PTBatcherGUI use makefiles.</li>
</ul>

← Older revision		Revision as of 13:34, 25 June 2010
Line 158:		Line 158:
	<li>30. September: Working on the remaining points. Priority to be discussed. </li>		<li>30. September: Working on the remaining points. Priority to be discussed. </li>
	</ul>		</ul>
		+
		+	[[Category:Community:Project]]

@@ Line 7: / Line 7: @@
 that encapsulates the output of makefiles and handles all makefile-specific issues, especially
 quoting.
 </p>
 __TOC__

@@ Line 1: / Line 1: @@
 <h2>Abstract</h2>
 <p>
-Hugin uses makefiles to drive the actual panorama creation process, it creates a makefile
+Hugin uses GNU Make to drive the actual panorama creation process, it creates a makefile
-from the project settings and GNU Make is used, to invoke the several tools that create the
+from the project settings to invoke the several tools that create the panorama.
 panorama.
 </p><p>
-The current makefile output code is not satifactory. It will be replaced by a reliable library
+The current makefile output code is not satisfactory. It will be replaced by a reliable library
 that encapsulates the output of makefiles and handles all makefile-specific issues, especially
 quoting.
@@ Line 27: / Line 26: @@
 My programming experience grew since I started writing programs on TI calculators in school
 probably 15 years ago.
-From my work and university experience I'm good with C, C++, Python, Makefiles, Unix Tools in general,
+From my work and university experience I'm good in C, C++, Python, Makefiles, Unix Tools in general,
 Java,  Shell Scripts.. (sorted by experience).
 </p><p>
@@ Line 34: / Line 33: @@
 out source codes, to take a look at how it works, and why something doesn't work.
 I frequently patched and built my own kernel images. That's why I like the open source spirit, I like
-to be able to look into things.
+to look into things.
 </p><p>
 My development platform is a Core2Duo E8500 with 4GB RAM running Ubuntu 64bit (currently karmic).
-For testing I usually setup other platforms in virtual machines
+For testing I usually setup other platforms in virtual machines.
 </p>
@@ Line 56: / Line 55: @@
 </ul>
 <p>
-Photography is the reason why I apply to hugin. Because I'm interested in photography and creating
+Photography is the reason why I apply to hugin. Because I'm interested in photography, creating
-panoramas, and because I'm interested in image processing.
+panoramas and image processing.
 </p>
@@ Line 142: / Line 141: @@
 <p>
-One problem I face when scheduling GSOC work is, that it's timetable doesn't suit very well to that of
+One limitation I face when scheduling GSOC work is, that it's timetable doesn't suit very well to that of
 the universities in Austria. Our Semester ends with the end of June, that means in this month, there will
 be a lot of submissions and exams and not too much time to program for GSOC. But our holidays extend until

← Older revision		Revision as of 14:01, 5 April 2010
Line 1:		Line 1:
		+	<h2>Abstract</h2>
		+	<p>
		+	Hugin uses makefiles to drive the actual panorama creation process, it creates a makefile
		+	from the project settings and GNU Make is used, to invoke the several tools that create the
		+	panorama.
		+	</p><p>
		+	The current makefile output code is not satifactory. It will be replaced by a reliable library
		+	that encapsulates the output of makefiles and handles all makefile-specific issues, especially
		+	quoting.
		+	</p><p>
		+	The project consists of design, implementation and testing and adapting multiple existing
		+	parts of hugin to make use of the new functionality.
		+	</p>
		+	__TOC__
	<h2>About Me</h2>		<h2>About Me</h2>
	<p>		<p>

@@ Line 143: / Line 143: @@
 the beginning of October, which allows me to continue working for Hugin for more than a month after GSOC
 is over.
 </p>
 <h3>Preliminary Schedule</h3>
 <ul>
-<li>30. June: Design of the Makefile creation library finished, design classes stubbed.</li>
+<li>10. June: Design of the Makefile creation library finished, design classes stubbed.</li>
-<li>31. July: Implementation of Makefile library ready for extensive testing and review.
+<li>16. July: (mid-term evaluation): Implementation of Makefile library ready for
-  Tester framework is up and running. Integration into the existing hugin code.</li>
+  extensive testing and review.</li>
-<li>9. August: Testing complete. Final code review.</li>
+<li>20. July: Tester framework is up and running, testcases are complete.
-<li>16. August: Finished documentation, project submission.</li>
+  Integration into the existing hugin code.</li>
-<li>31. August: Integration into hugin done and tested.</li>
+<li>9. August: Testing complete, bugs fixed. Hugin uses the new lib. Final code review.</li>
-<li>30. September: Control Point Creation and PTBatcherGUI use makefiles.</li>
+<li>16. August: (pencils-down) Finished documentation, project submission.</li>
 </ul>