/*
 * Permission is hereby granted, free of charge, 
 * to any person obtaining a copy of this software and 
 * associated documentation files (the "Software"), to 
 * deal in the Software without restriction, including 
 * without limitation the rights to use, copy, modify, 
 * merge, publish, distribute, sublicense, and/or sell 
 * copies of the Software, and to permit persons to whom 
 * the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice 
 * shall be included in all copies or substantial portions of the Software.
 * 
 * Users shall give appropriate references to the eNTERFACE'05 Website
 * (www.enterface.net) in scholarly literature for which this software is used or mentioned.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 
 * IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 */

/***********************************
 * Serdar Kemal Balci              *
 * serdar.balci@gmail.com          *
 * Enterface Workshop Summer 2005  *
 ***********************************/

========================================================================
    Console AppWizard : LM_Minimize Project Overview
========================================================================

Console AppWizard has created this LM_Minimize project for you as a starting point. This project contains 
a simple console application without pre-compiled headers. If you wish to create a console 
application using pre-compiled headers, please use the Visual C++ Win32 Project Wizard.

This file contains a summary of what you will find in each of the files that make up your project.

LM_Minimize.vcproj :
    This is the main project file for projects generated using an Application Wizard. 
    It contains information about the version of the product that generated the file, and 
    information about the platforms, configurations, and project features selected with the
    Application Wizard.

LM_Minimize.cpp : 
    Defines the entry point for the console-mode application.

readme.txt : 
    This text file.

=======================================================================
				User Written Files				
=======================================================================
LM_Minimizer.h
LM_Minimizer.cpp
	The main file for the definitions of the functions for fitting a 
	geometric shape to a curve. Include this file in your project to use
	the 2D shape fitting property.

Shapes.h
Shapes.cpp
	Functions to calculate the errors for shapes with given parameters.
	The functions calculate the total error for given parameters for their geometrical shapes
	The total error is not square summed, instead each error for each point is returned in a vector
	for efficient search of the LM algorithm

ShapeParams.h
	Structure to hold the parameters of the geometrical shapes.
	See the header file for details.

ReadWrite.h
ReadWrite.cpp
	Function to read&write data to file

Helperfunctions.h
Helperfunctions.cpp
	Contains functions, which are used to calculate the errors for shapes
    e.g. basic functions to find minimum, maximum and mean of a data set
    
Filterpoints.h
Filterpoints.cpp
	Contains a function which resamples the given points so that the 
	distance between successive points is uniform

======================================================================
			Imported libraries for LM Algorithm
======================================================================
Axb.c
Axb_core.c
lm.c
lm_core.c
lmbc.c
lmbc_core.c
lmlec.c
lmlec_core.c
misc.c
misc_core.c
lm.h
misc.h

See http://www.ics.forth.gr/~lourakis/levmar/ for the details of these files implementing
"levmar: Levenberg-Marquardt non-linear least squares algorithms in C/C++"

=======================================================================

Read the SourceGuide for compiling this code

Serdar Kemal Balci
serdar.balci@gmail.com
Enterface Summer Workshop 2005
				