Project Overview

Projects are designed for three person teams. Each team member is responsible for a different component of the project. Team members will be evaluated on their individual component and the success of the entire project.

Documentation and Code Walk Throughs 

Review of documentation and code using the mechanism of Walk Throughs is one of the best ways of insure the quality of the product . Walk throughs are  done as a group with other team members. In order to perform these walk throughs, each teams must schedule weekly one hour meetings with the instructor. These walk throughs along with a public demonstration of your product will be used as the primary evaluation instruments of your project.

Project Demonstrations

Final evaluation of team projects will be done at a public demonstration during final week. The event will be posted and open to all. Tentatively, the demonstration will be Friday afternoon of finals week.

Last semester we had two TV stations and the town newspaper at the presentation. Hopefully we will have the same this semester.

Team Roles

Teams will be formed to maximize diversity of talents and interests. Every effort will be made to matched students to their interests. There will be three nominal roles in each team requiring different knowledge, skills and interest:

• Networking and I/O - Sockets, device drivers (including Twain drivers), file I/O; video acquisition, storage transmission and display
• Numerical Methods - image enhancement, motion analysis, curve fitting, data visualization 
• User Interface and System Engineer - GUI design, image display, 2D graphics, human factors, system integration, user manual

These are nominal roles. Each team must evolve each member's responsibilities to suit the strengths of the individual and to maximize the productivity of the team. .

Team Selection

All teams will be selected by the instructor. In order to facilitate the assignment of team members students are required to write a cover letter applying for the project of their choice and their preferred role on the team. Include with the cover letter your resume. Both resumes and cover letter will be reviewed in class. 

Deliverables

The project will be divided into four product cycles. The product, which includes software and documentation, will be  evolve as the semester progresses. At the end of each cycle the following items will be delivered:

• software product - working software will be demonstrated to the instructor and students
• software code
  • provide JavaDoc documentation inline with the code.
  • each component in a separate package
  • Java standard formatting
  • no magic numbers
  • Class and methods header
    • original author
    • revision history
    • a brief description and pointers to relevant off or on-line documentation
    • description of input and output
  • include all import statements  immediately after header
  • descriptive and pertinent names
    • Classes begin with upper case l, ever
• documentation
  • Requirements
    • context diagram - assign responsibilities to actors, software, etc.
    • cycle deliverables
      • updated concise description of the software deliverables for each cycle
    • use cases
  • Specification
    • "shalls" for the three major modules
      • qualify risk and importance
      • define dependencies between shalls
    • rational for shalls
    • structural decomposition of software
    • technology to shalls mapping 
      • list source of all technologies used to implement shalls
  • Design
    • rational for all major design decisions
    • module interface 
      • inter-module data flow diagram 
      • public interface
    • module design
      • class diagrams
      • data flow
      • state diagrams for significant state dependent behaviors
  • Product Brochure Manual - one page handout for final demonstration. See the Labyrinth Mapper Brochure from the Fall 2001 Programming Project Class for an example. 

Each  document will begin with a revision history. Any significant change in the document, including modifications, additions, and deletions, should be noted with data and author. 

Cycles

The following are preliminary guidelines for deliverables at the end of each cycle:

Cycle 1

• acquire image to disk and screen in real-time
• GUI mockup with text fields, buttons, and menu system
• plot the brightness of the image in real-time
• Preliminary Requirements Document
• JavaDoc generated documentation 

Cycle 2

• analyze single image frames, uniquely identifying at least five different images. 
• display pertinent single frame statistics
• overlay applicable graphics on image
• Final Requirements Document and initial Specification

Cycle 3

• analyze a subset of target dynamics using real-time images
• real-time graphing of all statistics
• finish the GUI 
• Final Specification Document and initial Design Document

Cycle 4

• robustly analyze live video in real-time
• final testing
• document all discrepancies between requirements and final product
• finalize documentation and place on web

Documentation for the first three cycles shall be included in a single three ring binder, with the product name, and team members on the cover and spline. Revisions of the documentation will insert after inspection by the instructor at the biweekly team meetings.

Deliverables for the final cycle will in the form of a web page with all documentation and source code. This work product will be appended to the course web page, allowing you to show prospective employers your work.