Manual: Motif/Annotation documentation

Load Motif List png

New version of mussagl, updated screenshot.

Manual: Main Window section added

Screenshots for next patch of the manual.

Updated manual

* Updated threshold setting based on latest build of Mussagl
* Continued outline development
* Added FIXME: where ever work needs to be done.

rename the python extension to _mussa.so
when working on the setup.py version of the build system it seemd like I
might want some python code to wrap the extension, so I renamed it to
_mussa. not sure if i still need that or not.

expose more of the sequence class to python

finish implementing annotation by sequence
I connected the previous find_sequence code with the new spirit annotation
loading file. So now I can actually use (nearly exact) sequences for
annotating.

switch to a character based spirit parser
by not letting spirit automatically deal with the spacing I was able
to actually get parsing to work correctly.

try to read fasta blocks in the annotation file
though this also revealed some problems with the spirit parser not
really splitting on whitespace. I should look into how to do per
character parsing.

use spirit parser for reading annot file
This basically duplicates tristans original annot parser using boost::spirit.
That was more complicated than I thought, and required implementing
a functor struct that stored data when the class was instantiated and then
performed some action with the operator() was called. Look at the comment
at sequence.cpp:push_back_annot for more descriptions of how that worked.

I improved the annotate_from_sequence unit test to not use hard coded values.

I have the start of a unit test fort the annot parsing code.
(currently it parses a string and then dumps out the result)

Though I did run the gui using this code and annotations did show up in roughly
the right places.

add annotations by sequence string
Ok so this is a rather limited search system as it is just using the
motif searching code, but adding things to the annot list instead of the
motif list. (and it handles looking at a list of sequences).

Ideally there should be some better way of specifying which algorithm to use
but i'm really tired today and not coding well.

try to make setup.py multiplatform

minor tweaks for building mussa under setup.py

super simple mussa gui driver

build all of mussagl as a python extension
unfortunately only works on os x so far.

lets try letting python build mussa
I wonder how distutils will fare building mussa? As I made more progress
getting to interact with the C++ libraries from python than the reverse
I want to see if I can everything to build with just distutils.

increase the use of python in mussa
This patch does let the python extension launch the gui successfully.
I tried to get the C++ gui app to also be able to talk to the python extension
but that didn't work so well. (causes a crash on os x when I statically
link the python extension module in).

allow saving aligned window browser to image
ticket:70

show the name of the analysis loaded
ticket:84 put the filename (for gui loaded) or the analysis name
(for command line loaded) names in the mussa window.

allow opening multiple MussaWindows
closes ticket:93 the only real downside is on os x the windows land on top
of each other.

win32 paths need some conversion
boosts native path type doesn't match win32
conventions quite correctly so before passing
a user entered file name we need to convert it.***END OF DESCRIPTION***

Place the long patch description above the ***END OF DESCRIPTION*** marker.
The first line of this file will be the patch name.

This patch contains the following changes:

M ./alg/glseqbrowser.cpp -1 +1
M ./mussa_exceptions.hpp +1
M ./mussagl.pro -1 +4
M ./qui/MussaWindow.cpp -3 +9
M ./qui/mussa_setup_dialog/MussaSetupWidget.cpp -5 +8
M ./qui/mussagl.cpp -6 +17

try to get mussagl to build on win32

implement commandline arguments for makedmg

the fasta error message should include the filename

fix ticket:83 throw an error when we don't have a fasta file
If the user gives us someting that doesn't look like a fasta file throw
an error.

create an options structure to indicate if we need a gui
My last attempt at making mussagl not need to run a gui on linux caused os x
to break. This implements a more complicated scheme that involves
initialize_mussa learning how to pass multiple options and a hidden
argument to QApplication to not initialize the gui when (in X11) $DISPLAY
isn't set.

ticket:85 fix, extend code crashes with 1 path
when there was only 1 path the refinement code attempted to access a null
pointer. (The "next" path, which was alas, pathz.end() )

use a custom target for python extension
the custom command to make the properly names python extension sometimes
failes, so lets see if a custom target (which has better dependency checking)
works

record cmake commands to deal with some dependency problems

default to building a debug version

put qt gui launching code into a function
Delaying instaintation QApplication allows us to run even if we don't
have a connection to an X server

AMD64 needs -fPIC for mussa_core

put spaces instead of <TAB> on gui/module.mk

ln -s is not that reliable
ln throws an error if the file already exists, rm throws a file
if it doesn't exist, only cp works regardless of the start of the
python extensions existence status.

build the python interface
CMake can build the python version (and on os x/unix test it)
CMakes targets aren't quite appropriate for python extensions the
ADD_LIBRARY target gets the right build settings but names the file
libX.so while python needs X.so. I got around this by adding a custom
command which makes a symlink to the right name--of course that depends
on shell commands not available on windows. :(

Also there's some problems with boost.python not knowing about the
string to boost/filesystem converter. I manually wrapped load_mupa_file
but it might be more advantagious to write a general wrapper.

I also only have the simplest test case included, to test to make sure
that the environment can actually run python test cases.

minor fixes for older buildsystems
Just some updates so the older build systems still work.

rename _LIB to _LIBRARY to be more consistent with cmake

build fltk version and deal with debian qt4 weirdness
Debian named the qt4 qmake/moc commands -qt4 which the standard cmake
has trouble finding so I manaullay looked for them.

additionally the fltk stuff doesn't look for .H as used for newer fltk
installations so I had to manually look for that as well.

make include gl.h multiplatform
On OSX the location of gl.h is a bit weird.

Also fix a problem with where our example data ends up being dumped when
running unittests

switch to using boost::filesystem
I changed the loading code to use boost::filesystem, and also updated the
build system to hardcode the location of the example data in the unittest
program.

The result of this is I can now use easier filesystem handling code
and my unittests will work even when we build the app out of source

put build environment support tools in makelib

cmake setupfiles
I wonder how well CMake might work, this patch'll build mussagl and the
core unittests. (Though they get dropped deep within the build hierarchy
which I don't like very much)

There's also a problem where os x wants to include the gl.h as OpenGL/gl.h
and linux wants GL/gl.h (though I didn't commit the OS X version yet.)

QSplitter has rendering problems on os x
QSplitter and QGlWidget don't get along that well on OS X. when toggling
the maximize state bits of the splitter are left in the opengl canvas.

Replacing the splitter with just a simple QHBoxLayout is much less
problematics, though of course it doesn't let the user hide the sidebars.

an int signal doesn't connect to a size_t slot

allow making dmgs for things other than mussa

allow running without using the gui
Also I moved some of the reverse compliment code onto single lines to
see if that made it make any more sense.

better setup dialog label names

keep the sequence view at higher zoom level

motifs should render on top of annotations

make annotations big enough to show up
fixes ticket:69 (or at least improves it)
Annotations could disapper if the width of the annotation was less than
one pixel. This patch forces it to be at least one pixel. However
it appears that the scrollbar is moving things in non-integral pixel sizes
so the annotations end up flashing as they render over different fractions
of two pixels.

View sequence alignment at non default thresholds
ticket:63
The counter being used to track what segments went to what paths wasn't
being reset properly. One would be looking for a selectedid (from the
opengl objects) that was greather than any currently viewable path.

choose alignment needs to force the sequences to redraw

Provide a zoom widget in MussaAlignedWindow

Move zoom spinbox into its own widget
and use doubles indicating the actual bp/pix instead of an int = bp/pix*100

setAlignment, as a target of a qt signal, needs to match type
Though size_t is a bit better for how setAlignment uses it, the type
mismatch causes the signal to break

ignore some generated product
there's no need to version control things we build.

fix more warnings
ticket:34 inspired me to go fix more warnings.

threshold widget shows both base pair and percents
ticket:31 also mentioned reporting the current threshold as both
number of basepairs out of the window size and the current percentage.

recover threshold and window size
ticket:55 This recovers the threshold and window size from the museq
and makes sure that the spinner is set to that range.

improve os x makefiles
OS X puts things in weird places, this tries to capture that

use qt resources for icons
WARNING: Seems to need qt 4.1.1 to work correctly
This uses QT resources to link the icons directly into the application, so
they'll always show up, even when not being run from the source directory.

Of course in practice it seems like qt 4.1.0 has a bug so the resource
feature doesn't quite work right.

First (incomplete) rough draft of the Mussagl Manual

Win32 Inno Setup installer script

disable coloring things with reverse compliment colors.
since the reverse compliment color (blue) is being applied incorrectly
just disable it for the moment. ticket:44

this of course needs to be reversed when I actually fix the bug.

define an analysis should keep settings
The define an analysis dialog should keep its values (as it doesn't do
a good job of validating input) (ticket:57) because when something is wrong
you'd have to then reenter everything.

change from slider to spinner for threshold
Use a spinner instead of a slider as its useful to be able to type in a
threshold. (starts implementation of ticket:39)
Also ticket:55 would be _very_ helpful.

better sidebar rendering
This should fix the problems with the sidebar's output getting messed up,
(ala ticket:39) also it outputs the species name

fix selection box coordinate bugs
ticket:41 and ticket:43 were both due to the fact that the right screen
coordinates weren't being properly offset by the current ortho.

spurious mouseReleaseEvent caused a crash
For some reason a mouseReleaseEvent was making it to mussa when
using one of the load dialog boxes. This caused a crash.
This patch causes it to not crash.
Though this patch also seems to sometimes select things for no apparent
reason.

finish dialog box to setup an analysis
Closes ticket:5 (though I'm sure it'll introduce some new tickets).

this gets the dialog box brandon coded working so you can now setup an
analysis from the gui.

I think this finishes everything tristan's mussa had, and I think it took
5 weeks instead of the 3-4 estimated.

Increase line thickness
On some OS X machines the lines on the opengl canvas were nearly illegible.
I'm guessing it was because they were being rendered as sub-pixel objects
Hopefully this'll fix those problems.

provide more information in the about box.

Progress towards MussaSetupDialog (Currently will cause crash! Be warned!)

bless osx Qt components and make a .dmg
OS X needs to have the location of any shared libraries prelinked
(at build time). This does that, and then makes a dmg.

tell doxygen about motif_editor and mussa_setup_dialog

Removed 'create subanalysis' from menu for now (until implemented)

Added two load icons to file menu.

Work towards MussaSetupDialog (Not finished yet).

provide a user interface to edit motifs

resizing should also change the sequence position indicators

hopefully this fixes the off by one error
with the left sequence position.

when changing alignment the position also needs to update

set inital left position
when starting with the sequences at a non-zero position, make sure the
positions shown in the sidebar actually corresponds to what sequence
is currently visible (ticket:40)

resizing increases the viewable world
When resizing increase the amount of world that's visibile in the viewport
(and a couple of { moves.

changing the set of links does need to redraw
Somehow I deleted an update that was needed for redrawing the links.
This puts one back in so changing the threshold works.

Mussa aligned sequence view seems to work
I added a "normalizedIndexes" to the ConservedPath classes to return
vectors which don't have any negative path values.

I also think the use of menu entries is a bit annoying as it wont extend
well to large numbers of selected paths. Additionally, deselecting an
alignment doesnt seem to do much as I suspect there's a fair amount of
overlap betwen the various alignments.

But i was eventually able to make them all go away.

dont crash when loading a new analysis
Since the MussaAlignedWindow uses a pointer to the mussa analysis, when
we load a different analysis it crashes. So close (and delete) all the
aligned windows when we load a new analysis.

draw alignment lines
A step toward getting the alignment view... This draws the alignment
lines. And even gets it right occasionally.

Open issues are: reverse complimented sequences get shifted
by the wrong sign. There's an off by one error (ticket:37), and of course
there's a need for a user interface to pick which alignment to use & show.

render sequence correctly in mussa aligned window
My math for locating a sequence when seq_x moved was wrong, so I was
drawing the sequence in some weird off the wall place.

implement zoom in terms of base pairs per pixel
Though the value we return from zoom is actually basepairs/pixels*100
(so i can use int).

I also implemented a zoomOut function that zooms far enough out to fit the
current scene on the display.

center on path
This manages to make the various sequences line up along some provided path.
(a vector<int> listing the sequences positions).

This has problems because of the use of the negative flag to indicate
reverse compliment (as it moves the sequence the wrong direction).

Additionally to get this to work I had to get all of the glsequence code
necessary to allow non-zero x values.

define window for showing a mussa alignment
Create a new window to hold the mussa sequence alignment. (aka
show all the sequences lined up at a starting point with lines connecting
base pairs.)

(This also fixes a bug I introduced into the fltk version of mussa back
when I changed paths from just being a vector of ints into an actual
class.)

I still need to actually allow the user to pick the aligned path and show
the conserved base pairs.

Work towards MussaSetupDialog

This patch just adds a director qui/mussa_setup_dialog/ and includes the .cpp and .hpp files to support the dialog box. This patch does not touch any other areas of the code and therefor is a safe patch to pull (without worrying about merge conflicts).

Zoom Icon Patch

refactored PathScene into SequenceBrowserWidget
The thing that was really hurting my brain was trying to keep track of
which of all the classes needed to actually implement the
SequenceBrowserWidget was actually implementing some function.

SequenceBrowserWidget is now the central control widget that manages
how all of the sub-widgets connect.

I could've tried to simplify how the SequenceBrowserWidget::updatePosition
code worked but it was to hard and I didn't bother.

specify where the gl.h is on a mac

fix motif coloring
Need to force tying a GlSequence's AnnotationColor mapper to the one in
the mussa analysis, not the default being created in GlTracks

track labels
ticket:3
This adds two side bars to the PathWidget that show the current position
(and the total length of the sequence, and should show the name).

Scrolling the viewport around makes the position number change too.
(Which revealed a bug that glsequence.leftbase would return values larger
than the sequence).

I also fixed the default size hint.

However all is not completely well, I really need to specialize the
right and left sidebars. And there were way too many classes created for
trying to handle all the user interface widgets. And I'm the locations
of the various signals and updating code could certainly be better thought
out.