Page for Team B slot 15
You can write tex in twiki like this:
Background (from the news)
Archeologists have discovered that the recently recovered fragments from the Scrolls of Oumroum in Egypt may contain the answer to Life, the Universe and Everything. This is indicated by some of the words on the fragments that have been translated out of Koine Greek. The reconstruction of the scrolls is of great importance.
The fragments have already been digitally processed with an automatic analysis system in order to match them. Unfortunately, it turned out that there are many ways in which you can combine the fragments, and the scientists have also observed that most matches are just physical and not logical. The reconstruction has failed until now. As a last effort to unveil the secrets of Oumroum, the scientists requested a collaborative system in which other scientists and passionate people can join forces to solve this puzzle.
System description and requirements
As the newspaper fragment above indicates, this project is the final effort to decipher the scrolls of Oumroum. Therefore our system has to provide a pleasant working environment for the scientists who are working on the process of putting the pieces together. It has to provide ample communication mechanisms and an intuitive way of putting pieces together. Then it also needs a way of having multiple scientists working together, so we need a consistent way of storing and handling differences in opinions on the composition of the pieces.
The system should provide:
- intuitive way of putting pieces together
- collaborative and private workspaces
- mechanisms for:
- saving intermediate work
- viewing history
- restoring a previous version of the work
- combining the work of different scientists
- suggestions for matching pieces *ample communication mechanisms
The stakeholders involved in the system are:
- Scientist - those who are using the system to solve the puzzle
- Data providers - the persons who add new pieces to the system
- Community - passionate people that are not scientists but whom are interested in solving the puzzle
- Moderators - persons who monitor the communication channels of the system
- System administrators - have to maintain the system and install updates
- Sponsors - those whom are funding the project
A piece is a scan of a single physical scroll fragment.
- Can be disabled/re-enabled (e.g. duplicates)
- When disabled will be marked in compositions
= the set of all pieces
A composition member is a piece along with a position (relative to the origin of the workspace) and a rotation.
= the set of all possible composition members
The position includes a z-index which is used to determine how overlapping pieces are displayed.
A composition member can only be used in one composition.
An annotation is a user information that is attached to a composition. Its main purpose is to help users identify compositions and explain their intentions about combining pieces.
= the set of all sequences of annotations
We define the following operations on annotations:
Intermediate combinations of pieces on which the scientists are working are stored in compositions.
A composition consists of a set of 0 or more composition members and a sequence of annotations.
= the set of all compositions
The work of a group of scientists is modeled using the workspace.
A workspace is a 2.5-D coordinate system which contains 0 or more compositions.
The coordinate system,
, is described be the following:
- a point that is the origin,
- positive x axis goes to the right,
- positive y axis goes up,
- z axis is the cross product of x and y,
= the set of all compositions from the workspace
A revision is used to represent a certain version of the work of a group of scientists.
A revision has:
- a set of compositions
- a revision number
= the set of all revisions
A branch represents the versioned workspace of a group of scientists.
A branch is a sequence of revisions of a single workspace.
= the set of all branches
Piece management component manages pieces and operation that can be done on them.
It provides the following operations on pieces:
get retrieves all stored pieces
add adds a new piece to the system
remove removes a piece from the system
The component is used by the Compositor which displays the pieces to the user, by the Versioning system which needs the pieces in order to version compositions, and by the ASS when searching for matches.
operations are intended to be used when new scroll pieces are found (
) or when duplicate pieces are discovered (
) and only by system administrators.
The Version management system provides a number of operations on compositions and workpaces:
checkout given a revision number creates a a new workspace from a branch
- adds all compositions from newer revisions in the branch to the workspace
- may result in conflicts
- stores the workspace as a new revision in the branch
- requires conflicts to be resolved first (uniqueness constraint)
- requires workspace to be up-to-date (same revision as branch)
- the revision number is the previous revision number increased by 1
- copies a composition from another branch into workspace
- may result in conflicts
branch creates a new branch as a copy of another branch
- given two branches imports the compositions of the first into the second
- in case of conflicts the user is asked to resolve them and the operation is tried again
Automatic Suggestion system
ASS analyses pieces and compositions to find matching between them. Each match is rated with a value (the quality index) between minQuality
(no match) and maxQuality
The ASS specification is given by the following functions:
matchPiece given piece returns a list of matching pieces together with quality indices
matchComposition searches the specified version of the workspace for matches with the specified piece and returns all matches together with their quality index
qualityInterval returns the matching quality interval
This component is used from the Compositor. Users can perform searches for matches between pieces or compositions. The result is a list with the corresponding matches and their quality indices. In order to search for a composition match the user has to provide the version of the workspace in which ASS should search.
User Management component handles user registration, rights management, user authentication and group management.
It provides the following operation on users and groups:
authenticateUser checks the given user credentials
registerUser registers a user with the provided user data
createGroup creates a group using the provided group data
modifyGroup adds or removes users from a certain group
modifyUser updates the information about the user
The compositor contains the following elements:
Shows part of the workspace and provide the following operations:
- pan moves to another part of the workspace
- zoom views a smaller or larger part of the workspace
For the current selected pieces/compositions lists all pieces and all compositions from all branches ordered by ASS match ranking. It provide the following operation:
- search searches for a specific annotation
Contains operations that eases composition management in the workspace:
(Main article formal specification user interface
The following operations can be performed in the compositor to modify the workspace:
- adds a piece or composition to the workspace
- to add a single piece, a one-element composition is created
- remove composition removes a composition, including all its members, from the workspace
- remove member removes a member from a composition and from the workspace
- extract removes a piece from a composition and re-adds it to the workspace in a new composition
- takes the members of two compositions and creates a new composition with those members
- removes the old compositions
- rotate rotate a member or a composition around its center by the given angle
- translates translate (move) a member or composition to the given point
- annotate add a annotation to a composition
The Navigation Manager is responsible for the transitions between the screens of the system. The following diagram present how this transitions are made.
We assume that the following transitions are implicit
- from each screen you can logout (back to LogIn)
- from each screen you can go back to home screen only if you are still logged in
A user is allowed to do actions from a certain component only if the user's current screen equals the screen associated to the component.
| Component || Screen |
| Compositor || Compositor Screen |
| Communication || Discussion Screen |
| User management || User management Screen |
| Piece management || Piece management Screen |
The Communication somponent has to provide the following communication services:
- Direct public communication between multiple users. The users need to be online and logged in to be able to use the realtime communication service. The messages need not be accessible at later dates.
- Indirect private communication between 2 users. A user(sender) sends a message to another user (recipient) in a mail like manner. This message is private to the two users. No other user should be able to access it. The recipient need not be online to receive the messages, he can access his messages after logging in.
- Indirect public communication between multiple users in a forum. A user can post a message on a specific topic and other users can comment on this. The messages are stored within the system and are accessible at later dates. A moderator is able to delete topics or comments and close topics for further discussion.
The Communication component accesses the User Management interface for user authentication and to be able to identify moderators.
We describe the behaviour of the system by means of a state machine. The following components are specified as state machines:
- Versioning system
- Navigation manger
- Communication system
- User management
We assume that the input and output actions of all the components are distinct.
The system state, SysState
, is the combination between the global state and all the local states of the users.
= the set of users
= the set of all possible local states
= the set of all possible global states
- (takes a user and returns the corresponding local state)
A local state is specific to a certain user. It contains data that are accessible and modifiable only by its owner.
The local state for a user contains the following:
- navigation state (current screen)
- compositor state
- = the set of compositions from the workspace
- = the set of all current suggestions as given by the recommendation panel
- = (pieces recommendations, compositions recommendations)
- local communication state (instant messaging)
The global state is the same for all users. It can be accessed and modified by any user (with respect to the user rights).
The global sate contains the following:
- versioning system state
- = the set of all branches
- communication component state (forum, mail system)
- piece management state
- user management state