incorporate drawable and annotations
[mussa.git] / alg / glseqbrowser.cpp
1 #include "alg/glseqbrowser.hpp"
2 #include "mussa_exceptions.hpp"
3
4 #include <math.h>
5 #include <iostream>
6 #include <sstream>
7 #include <stdexcept>
8
9 using namespace std;
10
11 GlSeqBrowser::GlSeqBrowser()
12   : border_width(25),
13     cur_ortho(400.0, 0.0, 600.0, 0.0),
14     viewport_size(600, 400),
15     viewport_center((cur_ortho.right-cur_ortho.left)/2+cur_ortho.left),
16     zoom_level(2),
17     color_mapper(),
18     track_container()
19 {
20 }
21
22 GlSeqBrowser::GlSeqBrowser(const GlSeqBrowser& gt)
23   : border_width(gt.border_width),
24     cur_ortho(gt.cur_ortho),
25     viewport_size(gt.viewport_size),
26     viewport_center(gt.viewport_center),
27     zoom_level(gt.zoom_level),
28     color_mapper(gt.color_mapper),
29     track_container(gt.track_container),
30     path_segments(gt.path_segments)
31 {
32 }
33
34 void GlSeqBrowser::initializeGL()
35 {
36   glEnable(GL_DEPTH_TEST);
37   glClearColor(1.0, 1.0, 1.0, 0.0);
38   glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
39   glShadeModel(GL_FLAT);
40 }
41
42 void GlSeqBrowser::resizeGL(int width, int height)
43 {
44   viewport_size.x = width;
45   viewport_size.y = height;
46   glViewport(0, 0, (GLsizei)width, (GLsizei)height);
47   update_viewport(viewport_center, zoom_level);
48 }
49
50 void GlSeqBrowser::paintGL() const
51 {
52   glClear(GL_COLOR_BUFFER_BIT|GL_DEPTH_BUFFER_BIT);
53
54   glPushMatrix();
55   glMatrixMode(GL_PROJECTION);
56   glLoadIdentity();
57   glOrtho(cur_ortho.left, cur_ortho.right,
58           cur_ortho.bottom, cur_ortho.top,
59           -50.0, 50);
60
61   draw();
62
63   glPopMatrix();
64   glFlush();
65 }
66
67 void GlSeqBrowser::processSelection(GLuint hits, GLuint buffer[], GLuint bufsize, const rect<float>& r)
68 {
69   GLuint *ptr;
70   GLuint names;
71   GLuint consumed_names = 0;
72   float z1;
73   float z2;
74   GLuint objtype;
75   GLuint objid;
76   GLuint path_index = 0;
77   GLuint pair_key_0 = 0;
78   GLuint pair_key_1 = 0;
79   TrackRegion track;
80
81   selected_paths.clear();
82   selected_tracks.clear();
83
84   ptr = (GLuint *) buffer;
85   if (hits > 0)
86     selectedMode = true;
87   for (GLuint i=0; i < hits; ++i)
88   {
89     if ((i + 5) > bufsize) {
90       std::clog << "*** selection overflow***" << std::endl;
91     } else {
92       consumed_names = 0;
93       names = *ptr++;
94       z1 = ((float)*ptr++)/0x7fffffff;
95       z2 = ((float)*ptr++)/0x7fffffff;
96       objtype = *ptr++; ++consumed_names;
97       switch (objtype) {
98         case MussaSegment:
99           path_index = *ptr++; ++consumed_names;
100           pair_key_0 = *ptr++; ++consumed_names;
101           pair_key_1 = *ptr++; ++consumed_names;
102           if (path_index < path_segments.size()) {
103             segment_key k(pair_key_0, pair_key_1);
104             pair_segment_map::iterator psm_i;
105             psm_i = path_segments[path_index].find(k);
106             if (psm_i != path_segments[path_index].end()) {
107               Segment &seg = psm_i->second;
108               selected_paths.insert(seg.path_ids.begin(), seg.path_ids.end());
109             }
110             // else something else is wrong
111           } else {
112             // something wasn't right
113             clog << "invalid path_index " << path_index 
114                  << " should have been [0,"<<path_segments.size()
115                  << ") " << endl;
116           }
117           break;
118         case MussaTrack:
119         {
120           objid = *ptr++; ++consumed_names;
121
122           int left = track_container[objid]->leftbase(r.left);
123           int right = track_container[objid]->rightbase(r.right);
124           // the static_cast should be ok, since basepairs line up on 
125           // integral values
126           //TrackRegion track(objid, left, right); 
127           track.set(objid, left, right);
128           selected_tracks.push_back(track);
129           //clog << "selected track " << objid
130           //     << "(" << left << ", " << right << ")" << endl;
131         }
132         break;
133         default:
134           cout << "unknown type " << objtype << " ";
135           for(; consumed_names < names; ++consumed_names) {
136             cout << consumed_names << "," << *ptr++ << " ";
137           }
138           cout << endl;
139           break;
140       }
141     }
142   }
143 }
144
145 void GlSeqBrowser::selectRegion(int top, int left, int bottom, int right)
146 {
147   GLfloat x_scale = cur_ortho.width()/((float)viewport_size.x);
148   GLfloat y_scale = cur_ortho.height()/((float)viewport_size.y);
149   GLfloat x_left = cur_ortho.left + (left*x_scale);
150   GLfloat x_right = cur_ortho.left + (right * x_scale);
151
152   if (top > bottom) {
153     // woah, someone gave us a rectangle with the origin in the lower left
154     int temp = top;
155     bottom = top;
156     top = temp;
157   }
158   // swap the orientation of canvas coordinates
159   GLfloat y_top = cur_ortho.top-(bottom*y_scale);
160   GLfloat y_bottom = cur_ortho.top - top * y_scale;
161   selectedRegion = rect<float>(y_top, x_left, y_bottom, x_right);
162
163   // hopefully this will make a buffer big enough to receive 
164   // everything being selected
165   //const size_t pathz_count = mussaAnalysis->paths().refined_pathz.size();
166   //const GLuint select_buf_size = 1 + 5 * (pathz_count + sequences.size());
167   const GLuint select_buf_size = 500000;
168   GLuint selectBuf[select_buf_size];
169   glSelectBuffer(select_buf_size, selectBuf);
170   GLint hits;
171
172   (void)glRenderMode(GL_SELECT);
173   glPushMatrix();
174   glMatrixMode(GL_PROJECTION);
175   glLoadIdentity();
176   glOrtho(x_left, x_right, y_top, y_bottom, -50.0, 50.0);
177   glMatrixMode(GL_MODELVIEW);
178   glLoadIdentity();
179
180   draw();
181
182   glFlush();
183   glPopMatrix();
184   hits = glRenderMode(GL_RENDER);
185   processSelection(hits, selectBuf, select_buf_size, selectedRegion);
186 }
187
188 float GlSeqBrowser::border() const
189 {
190   return border_width;
191 }
192
193 float GlSeqBrowser::left() const
194
195   float left;
196   if (track_container.size() == 0)
197   {
198     return cur_ortho.left;
199   } else {
200     vector<boost::shared_ptr<GlSequence> >::const_iterator track_i = track_container.begin();    
201     left = (*track_i)->x();
202     for( ; track_i != track_container.end(); ++track_i)
203     {
204       if ((*track_i)->x() < left) {
205         left = (*track_i)->x();
206       }
207     }
208     return left-border_width;
209   }
210 }
211
212 float GlSeqBrowser::right() const
213
214   float right;
215   if (track_container.size() == 0) {
216     return cur_ortho.right;
217   } else {
218     vector<boost::shared_ptr<GlSequence> >::const_iterator track_i = track_container.begin();
219     right = (*track_i)->right();
220     for( ; track_i != track_container.end(); ++track_i) {
221       if ((*track_i)->right() > right)
222         right = (*track_i)->right();
223     }
224     return right+border_width;
225   }
226 }
227
228 float GlSeqBrowser::get_pixel_width() const
229 {
230   GLint viewport[4];
231   glGetIntegerv(GL_VIEWPORT, viewport);
232   GLint vp_width = viewport[3]; // grab the viewport width
233   
234   return round((cur_ortho.right-cur_ortho.left)/vp_width);
235 }  
236
237 void GlSeqBrowser::setViewportCenter(float x)
238 {
239   update_viewport(x, zoom_level);
240   viewport_center = x;
241 }
242
243 float GlSeqBrowser::viewportLeft() const
244
245   return cur_ortho.left; 
246 }
247
248 float GlSeqBrowser::viewportCenter() const
249 {
250   return viewport_center;
251 }
252
253 float GlSeqBrowser::viewportRight() const
254
255   return cur_ortho.right; 
256 }
257
258 float GlSeqBrowser::viewportHeight() const
259 {
260   return cur_ortho.top - cur_ortho.bottom;
261 }
262
263 float GlSeqBrowser::viewportWidth() const
264 {
265   return cur_ortho.right - cur_ortho.left;
266 }
267
268 int GlSeqBrowser::viewportPixelHeight() const
269 {
270   return viewport_size.y;
271 }
272
273 int GlSeqBrowser::viewportPixelWidth() const
274 {
275   return viewport_size.x;
276 }
277
278 double GlSeqBrowser::zoomOut()
279 {
280
281   if (right() - left() > 0) {
282     cur_ortho.left = left();
283     cur_ortho.right = right();
284     zoom_level =  (right() - left()) / (double)viewport_size.x;
285     return zoom_level;
286   } else {
287     // made up number representing 50 bp / pixel
288     return 50.0;
289   }
290 }
291
292 double GlSeqBrowser::zoomToSequence()
293 {
294   // (experimentally determined zoom level)
295   const double friendly_zoom = 0.10;
296   setZoom(friendly_zoom);
297   return friendly_zoom;
298 }
299
300 void GlSeqBrowser::setZoom(double new_zoom)
301 {
302   update_viewport(viewport_center, new_zoom);
303   zoom_level = new_zoom;
304 }
305
306 double GlSeqBrowser::zoom() const
307 {
308   return zoom_level;
309 }
310
311 void GlSeqBrowser::setColorMapper(boost::shared_ptr<AnnotationColors> cm)
312 {
313   color_mapper = cm;
314 }
315
316 const AnnotationColors& GlSeqBrowser::colorMapper()
317 {
318   return *color_mapper;
319 }
320
321 void GlSeqBrowser::clear()
322 {
323   clear_selection();
324   clear_links();
325   path_segments.clear();
326   track_container.clear();
327 }
328
329 void GlSeqBrowser::clear_selection()
330 {
331   selectedMode = false;
332   selectedRegion.clear();
333   selected_paths.clear();
334   selected_tracks.clear();
335 }
336
337 void GlSeqBrowser::push_sequence(const Sequence& s)
338 {
339   GlSequenceRef gs(new GlSequence(s, color_mapper));
340   push_sequence(gs);
341 }
342
343 void GlSeqBrowser::push_sequence(SequenceRef s)
344 {
345   GlSequenceRef gs(new GlSequence(*s, color_mapper));
346   push_sequence(gs);
347 }
348
349 void GlSeqBrowser::push_sequence(GlSequence gs)
350 {
351   GlSequenceRef new_gs(new GlSequence(gs));
352   push_sequence(new_gs);
353 }
354
355 void GlSeqBrowser::push_sequence(GlSequenceRef gs)
356 {
357   GlSequenceRef new_gs(new GlSequence(gs));
358   clear_links();
359   track_container.push_back(new_gs);
360   update_layout();
361   if (track_container.size() > 1)
362     path_segments.push_back(pair_segment_map());
363 }
364
365 const std::vector<boost::shared_ptr<GlSequence> >& GlSeqBrowser::sequences() const
366 {
367   return track_container;
368 }
369
370 void GlSeqBrowser::clear_links()
371 {
372   path_segments.clear();
373   for (int i = track_container.size()-1; i > 0; --i)
374   {
375     path_segments.push_back(pair_segment_map());
376   }
377   pathid = 0;
378 }
379
380 void 
381 GlSeqBrowser::link(const vector<int>& path, const vector<bool>& rc, int length)
382 {
383   if (path.size() < 2) {
384     // should i throw an error instead?
385     return;
386   }
387   if (path.size() != track_container.size() ) {
388     stringstream msg;
389     msg << "Path size [" << path.size() << "] and track size [" 
390         << track_container.size() << "] don't match" << endl;
391     throw mussa_error(msg.str());
392   }
393   if (path.size() != rc.size()) {
394     throw runtime_error("path and reverse compliment must be the same length");
395   }
396   vector<int>::const_iterator path_i = path.begin();
397   vector<bool>::const_iterator rc_i = rc.begin();
398   int track_i = 0;
399   int prev_x = *path_i; ++path_i;
400   bool prev_rc = *rc_i; ++rc_i;
401   while (path_i != path.end() and rc_i != rc.end())
402   {
403     segment_key p(prev_x, *path_i);
404     pair_segment_map::iterator found_segment = path_segments[track_i].find(p);
405     if (found_segment == path_segments[track_i].end()) {
406       // not already found
407       float y1 = track_container[track_i]->y();
408             y1 -= track_container[track_i]->height()/2;
409       float y2 = track_container[track_i+1]->y();
410             y2 += track_container[track_i+1]->height()/2;
411       
412       bool rcFlag = (prev_rc or *rc_i) and !(prev_rc and *rc_i);
413       Segment s(prev_x, y1, *path_i, y2, rcFlag, length);
414       s.path_ids.insert(pathid);
415       path_segments[track_i][p] = s;
416     } else {
417       //found
418       found_segment->second.path_ids.insert(pathid);
419       // make each segment the size of the largest of any link between these 
420       // two bases
421       if (found_segment->second.length < length) {
422         found_segment->second.length = length;
423       }
424     }
425     prev_x = *path_i;
426     prev_rc = *rc_i;
427     ++track_i;
428     ++path_i;
429     ++rc_i;
430   }
431   // pathid is reset by push_sequence
432   ++pathid;
433 }
434
435 void GlSeqBrowser::setSelectedPaths(std::vector<int> paths)
436 {
437   selected_paths.clear();
438   for(std::vector<int>::iterator itor = paths.begin();
439       itor != paths.end();
440       ++itor)
441   {
442     selected_paths.insert(*itor);
443   }
444 }
445
446 const set<int>& GlSeqBrowser::selectedPaths() const
447 {
448   return selected_paths;
449 }
450
451 void GlSeqBrowser::appendSelectedTrack(GLuint track, int start, int stop)
452 {
453   selected_tracks.push_back(TrackRegion(track, start, stop));
454 }
455
456 list<TrackRegion> GlSeqBrowser::selectedTracks() const 
457 {
458   return selected_tracks;
459 }
460
461 //! copy sequence from selected track using formating function
462 template<class Item>
463 size_t GlSeqBrowser::copySelectedTracks(std::list<Item>& result, 
464              Item (*formatter)(const Sequence& s, int left, int right))
465 {
466   size_t base_pairs_copied = 0;
467   result.clear();
468
469   for(selected_track_iterator track_i = selected_tracks.begin();
470       track_i != selected_tracks.end();
471       ++track_i)
472   {
473     int track_index = track_i->track_id;
474     if (track_index >= track_container.size()) {
475       // should this be an exception instead?
476       clog << "track " << track_index << " > " << track_container.size() 
477            << endl;
478     } else {
479       // we should be safe
480       Sequence seq(*track_container[track_index]);
481       result.push_back(formatter(seq, track_i->left, track_i->right));
482       base_pairs_copied += max(track_i->right-track_i->left, 0);
483     }
484   }
485   return base_pairs_copied;
486 }
487
488 //! copy sequence from selected tracks as FASTA sequences
489 size_t GlSeqBrowser::copySelectedTracksAsFasta(std::string& copy_buffer)
490 {
491   std::list<std::string> result;
492   struct AsFasta {
493     static string formatter(const Sequence& seq, int left, int right)
494     {
495       stringstream s;
496       s << ">" << seq.get_fasta_header() 
497         << "|" << "subregion=" << left << "-" << right+1
498         << std::endl
499         << seq.subseq(left, right-left+1) << std::endl;
500       return s.str();
501     }
502   };
503   size_t base_pairs_copied = copySelectedTracks(result, AsFasta::formatter);
504   // I wish there was some way to use for_each and bind here
505   for (list<string>::iterator result_i = result.begin();
506        result_i != result.end();
507        ++result_i)
508   {
509     copy_buffer.append(*result_i);
510   }
511   return base_pairs_copied;
512 }
513
514 //! copy sequence from selected tracks as new sequences
515 size_t GlSeqBrowser::copySelectedTracksAsSequences(std::list<Sequence>& result)
516 {
517   struct AsSequence {
518     static Sequence formatter(const Sequence& seq, 
519                               int left, 
520                               int right)
521     {
522       return seq.subseq(left, right-left+1);
523     }
524   };
525   return copySelectedTracks(result, AsSequence::formatter);
526 }
527
528 size_t GlSeqBrowser::copySelectedTracksAsSeqLocation(
529     std::list<SequenceLocation>& result)
530 {
531   struct AsSeqLocation {
532     static SequenceLocation formatter(const Sequence& seq, 
533                                       int left, 
534                                       int right)
535     {
536       return SequenceLocation(seq, left, right);
537     }
538   };
539   return copySelectedTracks(result, AsSeqLocation::formatter);
540 }
541
542 //! copy sequence from selected tracks as plain sequences
543 size_t GlSeqBrowser::copySelectedTracksAsString(std::string& copy_buffer)
544 {
545   std::list<string> result;
546   struct AsString {
547     static string formatter(const Sequence& seq, 
548                             int left, 
549                             int right)
550     {
551       stringstream s;
552       s << seq.subseq(left, right-left+1);
553       return s.str();
554     }
555   };
556
557   size_t base_pairs_copied = copySelectedTracks(result, AsString::formatter);
558   // I wish there was some way to use for_each and bind here
559   for (list<string>::iterator result_i = result.begin();
560        result_i != result.end();
561        ++result_i)
562   {
563     copy_buffer.append(*result_i);
564   }
565   return base_pairs_copied;
566 }
567
568 void GlSeqBrowser::centerOnPath(const vector<int>& paths)
569 {
570   if (paths.size() != track_container.size()) {
571     throw mussa_error("Path length didn't match the number of sequences");
572   }
573
574   for(size_t track_i = 0; track_i != track_container.size(); ++track_i)
575   {
576     // -15 = shift more to the left
577     track_container[track_i]->setX((viewport_center-15) - paths[track_i]);
578   }
579 }
580
581 void GlSeqBrowser::update_viewport(float center, double new_zoom)
582 {
583   // limit how close we can get
584   if (new_zoom < 0.01) {
585     new_zoom = 0.01;
586   }
587   double new_width = (new_zoom * (float)viewport_size.x);
588   cur_ortho.left = center-new_width/2.0;
589   cur_ortho.right = center+new_width/2.0;
590 }
591
592 void GlSeqBrowser::update_layout()
593 {
594   typedef std::vector<boost::shared_ptr<GlSequence> >::iterator glseq_itor_type;
595   float available_height = (float)cur_ortho.top - 2 * (float)border_width;
596   float max_base_pairs = 0;
597   size_t track_count = track_container.size();
598
599   if (track_count > 1) {
600     // we have several sequences
601     float track_spacing = available_height / (track_count-1);
602     float y = available_height + (float)border_width;
603     for(glseq_itor_type seq_i = track_container.begin();
604         seq_i != track_container.end();
605         ++seq_i, y-=track_spacing)
606     {
607       (*seq_i)->setX(0);
608       (*seq_i)->setY(y);
609       if ((*seq_i)->size() > max_base_pairs)
610         max_base_pairs = (*seq_i)->size();
611     }
612   } else if (track_count == 1) {
613     // center the single track
614     glseq_itor_type seq_i = track_container.begin();
615     (*seq_i)->setX(0);
616     (*seq_i)->setY(viewport_size.x /2);
617     max_base_pairs = (*seq_i)->size();
618   } else {
619     // nothing to do as we're empty
620     return;
621   }
622   cur_ortho.right = max_base_pairs + border_width;
623   cur_ortho.left = -border_width;
624   cur_ortho.top = viewport_size.x;
625   cur_ortho.bottom = 0;
626   viewport_center = (cur_ortho.width()/2) + cur_ortho.left;
627   zoomOut();
628 }
629
630 void GlSeqBrowser::draw() const
631 {
632   glMatrixMode(GL_MODELVIEW);
633   glInitNames();
634   glPushName(MussaSegment);
635   draw_segments();
636   glLoadName(MussaTrack);
637   draw_tracks();
638   glPopName();
639   // a selection shouldn't have a glName associated with it
640   draw_selection();
641 }
642
643 void GlSeqBrowser::draw_selection() const
644 {
645   // draw selection box
646   glEnable(GL_BLEND);
647   glDepthMask(GL_FALSE);
648   if (selectedMode) {
649     glColor4f(0.6, 0.6, 0.6, 0.9);
650     glRectf(selectedRegion.left, selectedRegion.top, 
651             selectedRegion.right, selectedRegion.bottom);
652   }
653   glDepthMask(GL_TRUE);
654   glDisable(GL_BLEND);
655 }
656
657 void GlSeqBrowser::draw_tracks() const
658 {
659   for(size_t track_i = 0; track_i != track_container.size(); ++track_i)
660   {
661     glPushName(track_i);
662     track_container[track_i]->draw(cur_ortho.left, cur_ortho.right);
663     glPopName();
664   }
665 }
666
667 void GlSeqBrowser::draw_segments() const
668 {
669   glLineWidth(1);
670   glEnable(GL_BLEND);
671   glDepthMask(GL_FALSE);
672   const float zdepth = -1.0;
673   const float min_segment_width = max((float)(1.0), get_pixel_width());
674   
675   // each vector contains path_segment_maps of all the connections
676   // between this track and the next
677   path_segment_map_vector::const_iterator psmv_i;
678   for(psmv_i = path_segments.begin();
679       psmv_i != path_segments.end();
680       ++psmv_i)
681   {
682     path_segment_map_vector::difference_type path_index;
683     path_index = psmv_i - path_segments.begin();
684     // these maps contain the pair index (used so we dont keep drawing the
685     // same segment) and the actual segment structure.
686     pair_segment_map::const_iterator psm_i;
687     for(psm_i = psmv_i->begin();
688         psm_i != psmv_i->end();
689         ++psm_i)
690     {
691       // grab the index into our segment map
692       const segment_key& key = psm_i->first;
693       // the second element of our map pair is a segment
694       const Segment &s = psm_i->second;
695       // need to do something so we can detect our selection
696       vector<int> selected;
697       set_intersection(selected_paths.begin(), selected_paths.end(),
698                        s.path_ids.begin(), s.path_ids.end(),
699                        back_inserter(selected));
700
701       if (not s.reversed) {
702         // forward
703         if (selected_paths.size() == 0 or selected.size() > 0) {
704           glColor4f(1.0, 0.0, 0.0, 1.0);
705         } else {
706           glColor4f(1.0, 0.7, 0.7, 0.4);
707         }
708       } else { 
709         // reverse
710         if (selected_paths.size() == 0 or selected.size() > 0) {
711           glColor4f(0.0, 0.0, 1.0, 1.0);
712         } else {
713           glColor4f(0.7, 0.7, 1.0, 0.4);
714         }
715       }
716       // save the multipart name for our segment
717       glPushName(path_index); glPushName(key.first); glPushName(key.second);
718       float seq_start_x = s.start.x 
719                         + track_container[path_index]->x();
720       float seq_end_x = s.end.x
721                       + track_container[path_index+1]->x();
722       if (s.length <= min_segment_width) {
723         // use lines for elements of length <=1 or < 1 pixel.
724         // and try to center the line
725         const float offset = s.length * 0.5;
726         glBegin(GL_LINES);
727           glVertex3f(seq_start_x+offset, s.start.y, -1);
728           glVertex3f(seq_end_x  +offset, s.end.y, -1);
729         glEnd();
730       } else {
731         // otherwise use quads
732         // compute length
733         float seq_start_x_length = s.start.x 
734                                  + s.length
735                                  + track_container[path_index]->x();
736         float seq_end_x_length = s.end.x
737                                + s.length
738                                + track_container[path_index+1]->x();
739         glBegin(GL_QUADS);
740           glVertex3f(seq_start_x, s.start.y, zdepth);
741           glVertex3f(seq_end_x, s.end.y, zdepth);
742           glVertex3f(seq_end_x_length, s.end.y, zdepth);
743           glVertex3f(seq_start_x_length, s.start.y, zdepth);
744         glEnd();
745       }      
746       // clear the names
747       glPopName(); glPopName(); glPopName();
748     }
749   }
750   glDepthMask(GL_TRUE);
751   glDisable(GL_BLEND);
752 }