e9d55b985571fa2785fca31c10ee480bc8cefbd6
[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   GlSequence gs(s, color_mapper);
340   push_sequence(gs);
341 }
342
343 void GlSeqBrowser::push_sequence(boost::shared_ptr<Sequence> s)
344 {
345   boost::shared_ptr<GlSequence> gs(new GlSequence(*s, color_mapper));
346   push_sequence(gs);
347 }
348
349 void GlSeqBrowser::push_sequence(GlSequence gs)
350 {
351   boost::shared_ptr<GlSequence> new_gs(new GlSequence(gs));
352   push_sequence(new_gs);
353 }
354
355 void GlSeqBrowser::push_sequence(boost::shared_ptr<GlSequence> gs)
356 {
357   clear_links();
358   track_container.push_back(gs);
359   update_layout();
360   if (track_container.size() > 1)
361     path_segments.push_back(pair_segment_map());
362 }
363
364 const std::vector<boost::shared_ptr<GlSequence> >& GlSeqBrowser::sequences() const
365 {
366   return track_container;
367 }
368
369 void GlSeqBrowser::clear_links()
370 {
371   path_segments.clear();
372   for (int i = track_container.size()-1; i > 0; --i)
373   {
374     path_segments.push_back(pair_segment_map());
375   }
376   pathid = 0;
377 }
378
379 void 
380 GlSeqBrowser::link(const vector<int>& path, const vector<bool>& rc, int length)
381 {
382   if (path.size() < 2) {
383     // should i throw an error instead?
384     return;
385   }
386   if (path.size() != track_container.size() ) {
387     stringstream msg;
388     msg << "Path size [" << path.size() << "] and track size [" 
389         << track_container.size() << "] don't match" << endl;
390     throw mussa_error(msg.str());
391   }
392   if (path.size() != rc.size()) {
393     throw runtime_error("path and reverse compliment must be the same length");
394   }
395   vector<int>::const_iterator path_i = path.begin();
396   vector<bool>::const_iterator rc_i = rc.begin();
397   int track_i = 0;
398   int prev_x = *path_i; ++path_i;
399   bool prev_rc = *rc_i; ++rc_i;
400   while (path_i != path.end() and rc_i != rc.end())
401   {
402     segment_key p(prev_x, *path_i);
403     pair_segment_map::iterator found_segment = path_segments[track_i].find(p);
404     if (found_segment == path_segments[track_i].end()) {
405       // not already found
406       float y1 = track_container[track_i]->y();
407             y1 -= track_container[track_i]->height()/2;
408       float y2 = track_container[track_i+1]->y();
409             y2 += track_container[track_i+1]->height()/2;
410       
411       bool rcFlag = (prev_rc or *rc_i) and !(prev_rc and *rc_i);
412       Segment s(prev_x, y1, *path_i, y2, rcFlag, length);
413       s.path_ids.insert(pathid);
414       path_segments[track_i][p] = s;
415     } else {
416       //found
417       found_segment->second.path_ids.insert(pathid);
418       // make each segment the size of the largest of any link between these 
419       // two bases
420       if (found_segment->second.length < length) {
421         found_segment->second.length = length;
422       }
423     }
424     prev_x = *path_i;
425     prev_rc = *rc_i;
426     ++track_i;
427     ++path_i;
428     ++rc_i;
429   }
430   // pathid is reset by push_sequence
431   ++pathid;
432 }
433
434 void GlSeqBrowser::setSelectedPaths(std::vector<int> paths)
435 {
436   selected_paths.clear();
437   for(std::vector<int>::iterator itor = paths.begin();
438       itor != paths.end();
439       ++itor)
440   {
441     selected_paths.insert(*itor);
442   }
443 }
444
445 const set<int>& GlSeqBrowser::selectedPaths() const
446 {
447   return selected_paths;
448 }
449
450 void GlSeqBrowser::appendSelectedTrack(GLuint track, int start, int stop)
451 {
452   selected_tracks.push_back(TrackRegion(track, start, stop));
453 }
454
455 list<TrackRegion> GlSeqBrowser::selectedTracks() const 
456 {
457   return selected_tracks;
458 }
459
460 //! copy sequence from selected track using formating function
461 template<class Item>
462 size_t GlSeqBrowser::copySelectedTracks(std::list<Item>& result, 
463              Item (*formatter)(const Sequence& s, int left, int right))
464 {
465   size_t base_pairs_copied = 0;
466   result.clear();
467
468   for(selected_track_iterator track_i = selected_tracks.begin();
469       track_i != selected_tracks.end();
470       ++track_i)
471   {
472     int track_index = track_i->track_id;
473     if (track_index >= track_container.size()) {
474       // should this be an exception instead?
475       clog << "track " << track_index << " > " << track_container.size() 
476            << endl;
477     } else {
478       // we should be safe
479       Sequence seq(*track_container[track_index]);
480       result.push_back(formatter(seq, track_i->left, track_i->right));
481       base_pairs_copied += max(track_i->right-track_i->left, 0);
482     }
483   }
484   return base_pairs_copied;
485 }
486
487 //! copy sequence from selected tracks as FASTA sequences
488 size_t GlSeqBrowser::copySelectedTracksAsFasta(std::string& copy_buffer)
489 {
490   std::list<std::string> result;
491   struct AsFasta {
492     static string formatter(const Sequence& seq, int left, int right)
493     {
494       stringstream s;
495       s << ">" << seq.get_fasta_header() 
496         << "|" << "subregion=" << left << "-" << right+1
497         << std::endl
498         << seq.subseq(left, right-left+1) << std::endl;
499       return s.str();
500     }
501   };
502   size_t base_pairs_copied = copySelectedTracks(result, AsFasta::formatter);
503   // I wish there was some way to use for_each and bind here
504   for (list<string>::iterator result_i = result.begin();
505        result_i != result.end();
506        ++result_i)
507   {
508     copy_buffer.append(*result_i);
509   }
510   return base_pairs_copied;
511 }
512
513 //! copy sequence from selected tracks as new sequences
514 size_t GlSeqBrowser::copySelectedTracksAsSequences(std::list<Sequence>& result)
515 {
516   struct AsSequence {
517     static Sequence formatter(const Sequence& seq, 
518                               int left, 
519                               int right)
520     {
521       return seq.subseq(left, right-left+1);
522     }
523   };
524   return copySelectedTracks(result, AsSequence::formatter);
525 }
526
527 size_t GlSeqBrowser::copySelectedTracksAsSeqLocation(
528     std::list<SequenceLocation>& result)
529 {
530   struct AsSeqLocation {
531     static SequenceLocation formatter(const Sequence& seq, 
532                                       int left, 
533                                       int right)
534     {
535       return SequenceLocation(seq, left, right);
536     }
537   };
538   return copySelectedTracks(result, AsSeqLocation::formatter);
539 }
540
541 //! copy sequence from selected tracks as plain sequences
542 size_t GlSeqBrowser::copySelectedTracksAsString(std::string& copy_buffer)
543 {
544   std::list<string> result;
545   struct AsString {
546     static string formatter(const Sequence& seq, 
547                             int left, 
548                             int right)
549     {
550       stringstream s;
551       s << seq.subseq(left, right-left+1);
552       return s.str();
553     }
554   };
555
556   size_t base_pairs_copied = copySelectedTracks(result, AsString::formatter);
557   // I wish there was some way to use for_each and bind here
558   for (list<string>::iterator result_i = result.begin();
559        result_i != result.end();
560        ++result_i)
561   {
562     copy_buffer.append(*result_i);
563   }
564   return base_pairs_copied;
565 }
566
567 void GlSeqBrowser::centerOnPath(const vector<int>& paths)
568 {
569   if (paths.size() != track_container.size()) {
570     throw mussa_error("Path length didn't match the number of sequences");
571   }
572
573   for(size_t track_i = 0; track_i != track_container.size(); ++track_i)
574   {
575     // -15 = shift more to the left
576     track_container[track_i]->setX((viewport_center-15) - paths[track_i]);
577   }
578 }
579
580 void GlSeqBrowser::update_viewport(float center, double new_zoom)
581 {
582   // limit how close we can get
583   if (new_zoom < 0.01) {
584     new_zoom = 0.01;
585   }
586   double new_width = (new_zoom * (float)viewport_size.x);
587   cur_ortho.left = center-new_width/2.0;
588   cur_ortho.right = center+new_width/2.0;
589 }
590
591 void GlSeqBrowser::update_layout()
592 {
593   typedef std::vector<boost::shared_ptr<GlSequence> >::iterator glseq_itor_type;
594   float available_height = (float)cur_ortho.top - 2 * (float)border_width;
595   float max_base_pairs = 0;
596   size_t track_count = track_container.size();
597
598   if (track_count > 1) {
599     // we have several sequences
600     float track_spacing = available_height / (track_count-1);
601     float y = available_height + (float)border_width;
602     for(glseq_itor_type seq_i = track_container.begin();
603         seq_i != track_container.end();
604         ++seq_i, y-=track_spacing)
605     {
606       (*seq_i)->setX(0);
607       (*seq_i)->setY(y);
608       if ((*seq_i)->size() > max_base_pairs)
609         max_base_pairs = (*seq_i)->size();
610     }
611   } else if (track_count == 1) {
612     // center the single track
613     glseq_itor_type seq_i = track_container.begin();
614     (*seq_i)->setX(0);
615     (*seq_i)->setY(viewport_size.x /2);
616     max_base_pairs = (*seq_i)->size();
617   } else {
618     // nothing to do as we're empty
619     return;
620   }
621   cur_ortho.right = max_base_pairs + border_width;
622   cur_ortho.left = -border_width;
623   cur_ortho.top = viewport_size.x;
624   cur_ortho.bottom = 0;
625   viewport_center = (cur_ortho.width()/2) + cur_ortho.left;
626   zoomOut();
627 }
628
629 void GlSeqBrowser::draw() const
630 {
631   glMatrixMode(GL_MODELVIEW);
632   glInitNames();
633   glPushName(MussaSegment);
634   draw_segments();
635   glLoadName(MussaTrack);
636   draw_tracks();
637   glPopName();
638   // a selection shouldn't have a glName associated with it
639   draw_selection();
640 }
641
642 void GlSeqBrowser::draw_selection() const
643 {
644   // draw selection box
645   glEnable(GL_BLEND);
646   glDepthMask(GL_FALSE);
647   if (selectedMode) {
648     glColor4f(0.6, 0.6, 0.6, 0.9);
649     glRectf(selectedRegion.left, selectedRegion.top, 
650             selectedRegion.right, selectedRegion.bottom);
651   }
652   glDepthMask(GL_TRUE);
653   glDisable(GL_BLEND);
654 }
655
656 void GlSeqBrowser::draw_tracks() const
657 {
658   for(size_t track_i = 0; track_i != track_container.size(); ++track_i)
659   {
660     glPushName(track_i);
661     track_container[track_i]->draw(cur_ortho.left, cur_ortho.right);
662     glPopName();
663   }
664 }
665
666 void GlSeqBrowser::draw_segments() const
667 {
668   glLineWidth(1);
669   glEnable(GL_BLEND);
670   glDepthMask(GL_FALSE);
671   const float zdepth = -1.0;
672   const float min_segment_width = max((float)(1.0), get_pixel_width());
673   
674   // each vector contains path_segment_maps of all the connections
675   // between this track and the next
676   path_segment_map_vector::const_iterator psmv_i;
677   for(psmv_i = path_segments.begin();
678       psmv_i != path_segments.end();
679       ++psmv_i)
680   {
681     path_segment_map_vector::difference_type path_index;
682     path_index = psmv_i - path_segments.begin();
683     // these maps contain the pair index (used so we dont keep drawing the
684     // same segment) and the actual segment structure.
685     pair_segment_map::const_iterator psm_i;
686     for(psm_i = psmv_i->begin();
687         psm_i != psmv_i->end();
688         ++psm_i)
689     {
690       // grab the index into our segment map
691       const segment_key& key = psm_i->first;
692       // the second element of our map pair is a segment
693       const Segment &s = psm_i->second;
694       // need to do something so we can detect our selection
695       vector<int> selected;
696       set_intersection(selected_paths.begin(), selected_paths.end(),
697                        s.path_ids.begin(), s.path_ids.end(),
698                        back_inserter(selected));
699
700       if (not s.reversed) {
701         // forward
702         if (selected_paths.size() == 0 or selected.size() > 0) {
703           glColor4f(1.0, 0.0, 0.0, 1.0);
704         } else {
705           glColor4f(1.0, 0.7, 0.7, 0.4);
706         }
707       } else { 
708         // reverse
709         if (selected_paths.size() == 0 or selected.size() > 0) {
710           glColor4f(0.0, 0.0, 1.0, 1.0);
711         } else {
712           glColor4f(0.7, 0.7, 1.0, 0.4);
713         }
714       }
715       // save the multipart name for our segment
716       glPushName(path_index); glPushName(key.first); glPushName(key.second);
717       float seq_start_x = s.start.x 
718                         + track_container[path_index]->x();
719       float seq_end_x = s.end.x
720                       + track_container[path_index+1]->x();
721       if (s.length <= min_segment_width) {
722         // use lines for elements of length <=1 or < 1 pixel.
723         // and try to center the line
724         const float offset = s.length * 0.5;
725         glBegin(GL_LINES);
726           glVertex3f(seq_start_x+offset, s.start.y, -1);
727           glVertex3f(seq_end_x  +offset, s.end.y, -1);
728         glEnd();
729       } else {
730         // otherwise use quads
731         // compute length
732         float seq_start_x_length = s.start.x 
733                                  + s.length
734                                  + track_container[path_index]->x();
735         float seq_end_x_length = s.end.x
736                                + s.length
737                                + track_container[path_index+1]->x();
738         glBegin(GL_QUADS);
739           glVertex3f(seq_start_x, s.start.y, zdepth);
740           glVertex3f(seq_end_x, s.end.y, zdepth);
741           glVertex3f(seq_end_x_length, s.end.y, zdepth);
742           glVertex3f(seq_start_x_length, s.start.y, zdepth);
743         glEnd();
744       }      
745       // clear the names
746       glPopName(); glPopName(); glPopName();
747     }
748   }
749   glDepthMask(GL_TRUE);
750   glDisable(GL_BLEND);
751 }