don't seqcomp sequences that are too small
[mussa.git] / alg / mussa.cpp
1 //  This file is part of the Mussa source distribution.
2 //  http://mussa.caltech.edu/
3 //  Contact author: Tristan  De Buysscher, tristan@caltech.edu
4
5 // This program and all associated source code files are Copyright (C) 2005
6 // the California Institute of Technology, Pasadena, CA, 91125 USA.  It is
7 // under the GNU Public License; please see the included LICENSE.txt
8 // file for more information, or contact Tristan directly.
9
10
11 //                        ----------------------------------------
12 //                          ---------- mussa_class.cc -----------
13 //                        ----------------------------------------
14
15 #include <boost/filesystem/path.hpp>
16 #include <boost/filesystem/operations.hpp>
17 #include <boost/filesystem/fstream.hpp>
18 namespace fs = boost::filesystem;
19
20 #include <boost/spirit/core.hpp>
21 #include <boost/spirit/actor/push_back_actor.hpp>
22 #include <boost/spirit/iterator/file_iterator.hpp>
23 #include <boost/spirit/utility/chset.hpp>
24 namespace spirit = boost::spirit;
25
26 #include <iostream>
27 #include <sstream>
28
29 #include "mussa_exceptions.hpp"
30 #include "alg/mussa.hpp"
31 #include "alg/flp.hpp"
32
33 using namespace std;
34
35
36 Mussa::Mussa()
37   : color_mapper(new AnnotationColors)
38 {
39   clear();
40   connect(&the_paths, SIGNAL(progress(const std::string&, int, int)), 
41           this, SIGNAL(progress(const std::string&, int, int)));
42 }
43
44 Mussa::Mussa(const Mussa& m)
45   : analysis_name(m.analysis_name),
46     window(m.window),
47     threshold(m.threshold),
48     soft_thres(m.soft_thres),
49     ana_mode(m.ana_mode),
50     win_append(m.win_append),
51     thres_append(m.thres_append),
52     motif_sequences(m.motif_sequences),
53     color_mapper(m.color_mapper),
54     analysis_path(m.analysis_path),
55     dirty(m.dirty)
56 {
57   connect(&the_paths, SIGNAL(progress(const std::string&, int, int)), 
58           this, SIGNAL(progress(const std::string&, int, int)));
59 }
60
61 boost::filesystem::path Mussa::get_analysis_path() const
62 {
63   return analysis_path;
64 }
65
66 void Mussa::set_analysis_path(boost::filesystem::path pathname)
67 {
68   analysis_path = pathname;
69 }
70
71 // set all parameters to null state
72 void
73 Mussa::clear()
74 {
75   analysis_name = "";
76   ana_mode = TransitiveNway;
77   window = 0;
78   threshold = 0;
79   soft_thres = 0;
80   win_append = false;
81   thres_append = false;
82   motif_sequences.clear();
83   if(color_mapper) color_mapper->clear();
84   the_seqs.clear();
85   the_paths.clear();
86   analysis_path = fs::path();
87   dirty = false;
88 }
89
90 bool Mussa::is_dirty() const
91 {
92   return dirty;
93 }
94
95 bool Mussa::empty() const
96 {
97   return the_seqs.empty();
98 }
99
100
101 // these 5 simple methods manually set the parameters for doing an analysis
102 // used so that the gui can take input from user and setup the analysis
103 // note - still need a set_append(bool, bool) method...
104 void
105 Mussa::set_name(string a_name)
106 {
107   analysis_name = a_name;
108   dirty = true;
109 }
110
111 string Mussa::get_name() const
112 {
113   return analysis_name;
114 }
115
116 string Mussa::get_title() const
117 {
118   fs::path analysis_path = get_analysis_path();
119   if (not analysis_path.empty()) {
120     return analysis_path.native_file_string();
121   } else if (get_name().size() > 0) {
122     return get_name();
123   } else {
124     return std::string("Unnamed");
125   }
126 }
127
128 int 
129 Mussa::size() const
130 {
131   if (the_seqs.size() > 0)
132     return the_seqs.size();
133   else
134     return 0;
135 }
136
137 void
138 Mussa::set_window(int a_window)
139 {
140   window = a_window;
141   dirty = true;
142 }
143
144 int Mussa::get_window() const
145 {
146   return window;
147 }
148
149 void
150 Mussa::set_threshold(int a_threshold)
151 {
152   threshold = a_threshold;
153   dirty = true;
154   if (a_threshold > soft_thres) {
155     soft_thres = a_threshold;
156   }
157 }
158
159 int Mussa::get_threshold() const
160 {
161   return threshold;
162 }
163
164 void
165 Mussa::set_soft_threshold(int new_threshold)
166 {
167   if (new_threshold < threshold) {
168     soft_thres = threshold;
169   } else if (new_threshold > window) {
170     soft_thres = window; 
171   } else {
172     soft_thres = new_threshold;
173   }
174 }
175
176 int Mussa::get_soft_threshold() const
177 {
178   return soft_thres;
179 }
180
181 void
182 Mussa::set_analysis_mode(enum analysis_modes new_ana_mode)
183 {
184   ana_mode = new_ana_mode;
185   dirty = true;
186 }
187
188 enum Mussa::analysis_modes Mussa::get_analysis_mode() const
189 {
190   return ana_mode;
191 }
192
193 string Mussa::get_analysis_mode_name() const
194 {
195   switch (ana_mode)
196   {
197   case TransitiveNway:
198     return string("Transitive");
199     break;
200   case RadialNway:
201     return string("Radial");
202     break;
203   case EntropyNway:
204     return string("Entropy");
205     break;
206   case RecursiveNway:
207     return string("[deprecated] Recursive");
208     break;
209   default:
210     throw runtime_error("invalid analysis mode type");
211     break;
212   }
213 }
214
215 const NwayPaths& Mussa::paths() const
216 {
217   return the_paths;
218 }
219
220 //template <class IteratorT>
221 //void Mussa::createLocalAlignment(IteratorT begin, IteratorT end)
222 void Mussa::createLocalAlignment(std::list<ConservedPath>::iterator begin, 
223                                  std::list<ConservedPath>::iterator end, 
224                                  std::list<ConservedPath::path_type>& result,
225                                  std::list<std::vector<bool> >& reversed)
226 {
227   const vector_sequence_type& raw_seq = the_seqs;
228   ConservedPath::path_type aligned_path;
229   size_t i2, i3;
230   int x_start, x_end;
231   int window_length, win_i;
232   int rc_1 = 0; 
233   int rc_2 = 0;
234   vector<bool> rc_list;
235   bool full_match;
236   vector<bool> matched;
237   int align_counter;
238
239   align_counter = 0;
240   for(std::list<ConservedPath>::iterator pathz_i=begin; pathz_i != end; ++pathz_i)
241   {
242     ConservedPath& a_path = *pathz_i;
243     window_length = a_path.window_size;
244     // determine which parts of the path are RC relative to first species
245     rc_list = a_path.reverseComplimented();
246     
247     // loop over each bp in the conserved region for all sequences
248     for(win_i = 0; win_i < window_length; win_i++)
249     {
250       aligned_path.clear();
251       // determine which exact base pairs match between the sequences
252       full_match = true;
253       for(i2 = 0; i2 < a_path.size()-1; i2++)
254       {
255         // assume not rc as most likely, adjust below
256         rc_1 = 0;
257         rc_2 = 0;
258         // no matter the case, any RC node needs adjustments
259         if (a_path[i2] < 0)
260           rc_1 = window_length-1;
261         if (a_path[i2+1] < 0)
262           rc_2 = window_length-1;        
263          
264         x_start = (abs(a_path[i2]-rc_1+win_i));
265         x_end =   (abs(a_path[i2+1]-rc_2+win_i));
266         
267         boost::shared_ptr<Sequence> cur(raw_seq[i2]) ;
268         boost::shared_ptr<Sequence> next(raw_seq[i2+1]);
269         // RC case handling
270         // ugh, and xor...only want rc coloring if just one of the nodes is rc
271         // if both nodes are rc, then they are 'normal' relative to each other
272         if((rc_list[i2] || rc_list[i2+1] )&&!(rc_list[i2] && rc_list[i2+1]))
273         { //the hideous rc matching logic - not complex, but annoying
274           if(!(( ((*cur)[x_start]=='A')&&((*next)[x_end]=='T')) ||
275                 (((*cur)[x_start]=='T')&&((*next)[x_end]=='A')) ||
276                 (((*cur)[x_start]=='G')&&((*next)[x_end]=='C')) ||
277                 (((*cur)[x_start]=='C')&&((*next)[x_end]=='G'))) ) 
278           {
279             full_match = false;
280           } else {
281             aligned_path.push_back(x_start);
282           }
283         }
284         else
285         { // forward match
286           if (!( ((*cur)[x_start] == (*next)[x_end]) &&
287                 ((*cur)[x_start] != 'N') && ((*next)[x_end] != 'N') ) ) {
288             full_match = false;
289           } else {
290             aligned_path.push_back(x_start);
291           }
292         }
293       }
294       // grab the last part of our path, assuming we matched
295       if (full_match)
296         aligned_path.push_back(x_end);
297
298       if (aligned_path.size() == a_path.size()) {
299         result.push_back(aligned_path);
300         reversed.push_back(rc_list);
301       }
302     }
303     align_counter++;
304   }
305 }
306
307
308 void Mussa::append_sequence(const Sequence& a_seq)
309 {
310   boost::shared_ptr<Sequence> seq_copy(new Sequence(a_seq));
311   the_seqs.push_back(seq_copy);
312   dirty = true;
313 }
314
315 void Mussa::append_sequence(boost::shared_ptr<Sequence> a_seq)
316 {
317   the_seqs.push_back(a_seq);
318   dirty = true;
319 }
320
321
322 const vector<boost::shared_ptr<Sequence> >& 
323 Mussa::sequences() const
324 {
325   return the_seqs;
326 }
327
328 void Mussa::load_sequence(fs::path seq_file, fs::path annot_file, 
329                           int fasta_index, int sub_seq_start, int sub_seq_end,
330                           std::string *name)
331 {
332   boost::shared_ptr<Sequence> aseq(new Sequence);
333   aseq->load_fasta(seq_file, fasta_index, sub_seq_start, sub_seq_end);
334   if ( not annot_file.empty() ) {
335     aseq->load_annot(annot_file, sub_seq_start, sub_seq_end);
336   }
337   if (name != 0 and name->size() > 0 ) {
338     aseq->set_species(*name);
339   }
340   the_seqs.push_back(aseq);
341   dirty = true;
342 }
343
344 void
345 Mussa::load_mupa_file(fs::path para_file_path)
346 {
347   fs::ifstream para_file;
348   string file_data_line;
349   string param, value; 
350   fs::path annot_file;
351   int split_index, fasta_index;
352   int sub_seq_start, sub_seq_end;
353   bool seq_params, did_seq;
354   string err_msg;
355   bool parsing_path;
356   string::size_type new_index, dir_index;
357
358   // initialize values
359   clear();
360
361   // if file was opened, read the parameter values
362   if (not fs::exists(para_file_path))
363   {
364     throw mussa_load_error("Config File: " + para_file_path.string() + " not found");
365   } else if (fs::is_directory(para_file_path)) {
366     throw mussa_load_error("Config File: " + para_file_path.string() + " is a directory.");
367   } else if (fs::is_empty(para_file_path)) {
368     throw mussa_load_error("Config File: " + para_file_path.string() + " is empty");
369   } else  {
370     para_file.open(para_file_path, ios::in);
371
372     // what directory is the mupa file in?
373     fs::path file_path_base = para_file_path.branch_path();
374
375     // setup loop by getting file's first line
376     getline(para_file,file_data_line);
377     split_index = file_data_line.find(" ");
378     param = file_data_line.substr(0,split_index);
379     value = file_data_line.substr(split_index+1);
380     
381     while (para_file)
382     {
383       did_seq = false;
384       if (param == "ANA_NAME")
385         analysis_name = value;
386       else if (param == "APPEND_WIN")
387         win_append = true;
388       else if (param == "APPEND_THRES")
389         thres_append = true;
390       else if (param == "SEQUENCE_NUM")
391         ; // ignore sequence_num now
392       else if (param == "WINDOW")
393         window = atoi(value.c_str());
394       else if (param == "THRESHOLD")
395         threshold = atoi(value.c_str());
396       else if (param == "SEQUENCE")
397       {
398         fs::path seq_file = file_path_base / value;
399         //cout << "seq_file_name " << seq_files.back() << endl;
400         fasta_index = 1;
401         annot_file = "";
402         sub_seq_start = 0;
403         sub_seq_end = 0;
404         seq_params = true;
405
406         while (para_file && seq_params)
407         {
408           getline(para_file,file_data_line);
409           split_index = file_data_line.find(" ");
410           param = file_data_line.substr(0,split_index);
411           value = file_data_line.substr(split_index+1);
412
413           if (param == "FASTA_INDEX")
414             fasta_index = atoi(value.c_str());
415           else if (param == "ANNOTATION")
416             annot_file = file_path_base / value;
417           else if (param == "SEQ_START")
418             sub_seq_start = atoi(value.c_str());
419           else if (param == "SEQ_END")
420           {
421             sub_seq_end = atoi(value.c_str());
422           }
423           //ignore empty lines or that start with '#'
424           else if ((param == "") || (param == "#")) {}
425           else seq_params = false;
426         }
427         load_sequence(seq_file, annot_file, fasta_index, sub_seq_start, 
428                       sub_seq_end);
429         did_seq = true;
430       }
431       //ignore empty lines or that start with '#'
432       else if ((param == "") || (param == "#")) {}
433       else
434       {
435         clog << "Illegal/misplaced mussa parameter in file\n";
436         clog << param << "\n";
437       }
438
439       if (!did_seq)
440       {
441         getline(para_file,file_data_line);
442         split_index = file_data_line.find(" ");
443         param = file_data_line.substr(0,split_index);
444         value = file_data_line.substr(split_index+1);
445         did_seq = false;
446       }
447     }
448
449     para_file.close();
450
451     soft_thres = threshold;
452     //cout << "nway mupa: analysis_name = " << analysis_name 
453     //     << " window = " << window 
454     //     << " threshold = " << threshold << endl;
455   }
456   // no file was loaded, signal error
457   dirty = true;
458 }
459
460
461 void
462 Mussa::analyze()
463 {
464   if (the_seqs.size() < 2) {
465     throw mussa_analysis_error("you need to have at least 2 sequences to "
466                                "do an analysis.");
467   }
468   
469   seqcomp();
470   the_paths.setup(window, threshold);
471   nway();
472 }
473
474 void
475 Mussa::seqcomp()
476 {
477   vector<int> seq_lens;
478   vector<FLPs> empty_FLP_vector;
479   FLPs dummy_comp;
480   string save_file_string;
481
482   empty_FLP_vector.clear();
483   for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
484   {
485     all_comps.push_back(empty_FLP_vector); 
486     for(vector<Sequence>::size_type i2 = 0; i2 < the_seqs.size(); i2++)
487       all_comps[i].push_back(dummy_comp);
488   }
489   for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++) {
490     seq_lens.push_back(the_seqs[i]->size());
491   }
492   int seqcomps_done = 0;
493   int seqcomps_todo = (the_seqs.size() * (the_seqs.size()-1)) / 2;
494   emit progress("seqcomp", seqcomps_done, seqcomps_todo);
495
496   for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
497     for(vector<Sequence>::size_type i2 = i+1; i2 < the_seqs.size(); i2++)
498     {
499       //cout << "seqcomping: " << i << " v. " << i2 << endl;
500       all_comps[i][i2].setup(window, threshold);
501       all_comps[i][i2].seqcomp(*the_seqs[i], *the_seqs[i2], false);
502       all_comps[i][i2].seqcomp(*the_seqs[i], the_seqs[i2]->rev_comp(),true);
503       ++seqcomps_done;
504       emit progress("seqcomp", seqcomps_done, seqcomps_todo);
505     }
506 }
507
508 void
509 Mussa::nway()
510 {
511
512   the_paths.set_soft_threshold(soft_thres);
513
514   if (ana_mode == TransitiveNway) {
515     the_paths.trans_path_search(all_comps);
516   }
517   else if (ana_mode == RadialNway) {
518     the_paths.radiate_path_search(all_comps);
519   }
520   else if (ana_mode == EntropyNway)
521   {
522     vector<Sequence> some_Seqs;
523     //unlike other methods, entropy needs to look at the sequence at this stage
524     some_Seqs.clear();
525     for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
526     {
527       some_Seqs.push_back(*the_seqs[i]);
528     }
529
530     the_paths.setup_ent(ent_thres, some_Seqs); // ent analysis extra setup
531     the_paths.entropy_path_search(all_comps);
532   }
533
534   // old recursive transitive analysis function
535   else if (ana_mode == RecursiveNway)
536     the_paths.find_paths_r(all_comps);
537
538   the_paths.simple_refine();
539 }
540
541 void
542 Mussa::save(fs::path save_path)
543 {
544   fs::path flp_filepath;
545   fs::fstream save_file;
546   ostringstream append_info;
547   int dir_create_status;
548
549   if (save_path.empty()) {
550     if (not analysis_path.empty()) {
551       save_path = analysis_path;
552     } else if (not analysis_name.empty()) {
553       std::string save_name = analysis_name;
554        // gotta do bit with adding win & thres if to be appended
555        if (win_append) {
556         append_info.str("");
557         append_info <<  "_w" << window;
558         save_name += append_info.str();
559       }
560
561       if (thres_append) {
562         append_info.str("");
563         append_info <<  "_t" << threshold;
564         save_name += append_info.str();
565       }
566       save_path = save_name;
567     } else {
568       throw mussa_save_error("Need filename or analysis name to save");
569     }
570   }
571
572   if (not fs::exists(save_path)) {
573     fs::create_directory(save_path);
574   }
575   // save sequence and annots to a special mussa file
576   save_file.open(save_path / (save_path.leaf()+".museq"), ios::out);
577   save_file << "<Mussa_Sequence>" << endl;
578
579   for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
580   {
581     the_seqs[i]->save(save_file);
582   }
583
584   save_file << "</Mussa_Sequence>" << endl;
585   save_file.close();
586
587   // if we have any motifs, save them.
588   if (motif_sequences.size()) {
589     save_motifs(save_path/(save_path.leaf()+".mtl"));
590   }
591
592   // save nway paths to its mussa save file
593   the_paths.save(save_path / (save_path.leaf()+ ".muway"));
594
595   for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++) {
596     for(vector<Sequence>::size_type i2 = i+1; i2 < the_seqs.size(); i2++)
597     {
598       append_info.str("");
599       append_info <<  "_sp_" << i << "v" << i2;
600       all_comps[i][i2].save(save_path/(save_path.leaf()+append_info.str()+".flp"));
601     }
602   }
603
604   dirty = false;
605   analysis_path = save_path;
606 }
607
608 void
609 Mussa::save_muway(fs::path save_path)
610 {
611   the_paths.save(save_path);
612 }
613
614 void
615 Mussa::load(fs::path ana_file)
616 {
617   int i, i2;
618   fs::path file_path_base;
619   fs::path a_file_path; 
620   fs::path ana_path(ana_file);
621   bool parsing_path;
622   string err_msg;
623   ostringstream append_info;
624   vector<FLPs> empty_FLP_vector;
625   FLPs dummy_comp;
626
627   analysis_path = ana_file;
628   analysis_name = ana_path.leaf();
629   file_path_base =  ana_path.branch_path() / analysis_name;
630   a_file_path = file_path_base / (analysis_name + ".muway");
631   the_paths.load(a_file_path);
632   // perhaps this could be more elegent, but at least this'll let
633   // us know what our threshold and window sizes were when we load a muway
634   window = the_paths.get_window();
635   threshold = the_paths.get_threshold();
636   soft_thres = threshold;
637
638   int seq_num = the_paths.sequence_count();
639
640   a_file_path = file_path_base / (analysis_name + ".museq");
641
642   // this is a bit of a hack due to C++ not acting like it should with files
643   for (i = 1; i <= seq_num; i++)
644   {
645     boost::shared_ptr<Sequence> tmp_seq(new Sequence);
646     tmp_seq->load_museq(a_file_path, i);
647     the_seqs.push_back(tmp_seq);
648   }
649   
650   fs::path motif_file = file_path_base / (analysis_name + ".mtl");
651   if (fs::exists(motif_file)) {
652     load_motifs(motif_file);
653   }
654   empty_FLP_vector.clear();
655   for(i = 0; i < seq_num; i++)
656   {
657     all_comps.push_back(empty_FLP_vector); 
658     for(i2 = 0; i2 < seq_num; i2++)
659       all_comps[i].push_back(dummy_comp);
660   }
661   
662   for(i = 0; i < seq_num; i++)
663   {
664     for(i2 = i+1; i2 < seq_num; i2++)
665     {
666       append_info.str("");
667       append_info << analysis_name <<  "_sp_" << i << "v" << i2 << ".flp";
668       //clog << append_info.str() << endl;
669       a_file_path = file_path_base / append_info.str();
670       //clog << "path " << a_file_path.string() << endl;
671       all_comps[i][i2].load(a_file_path);
672       //clog << "real size = " << all_comps[i][i2].size() << endl;
673     }
674   }
675 }
676
677
678 void
679 Mussa::save_old()
680 {
681   fs::fstream save_file;
682
683   save_file.open(analysis_name, ios::out);
684
685   for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
686     save_file << *(the_seqs[i]) << endl;
687
688   save_file << window << endl;
689   save_file.close();
690   //note more complex eventually since analysis_name may need to have
691   //window size, threshold and other stuff to modify it...
692   the_paths.save_old(analysis_name);
693 }
694
695
696 void
697 Mussa::load_old(char * load_file_path, int s_num)
698 {
699   fstream save_file;
700   string file_data_line; 
701   int i, space_split_i, comma_split_i;
702   vector<int> loaded_path;
703   string node_pair, node;
704   Sequence a_seq;
705
706   int seq_num = s_num;
707   the_paths.setup(0, 0);
708   save_file.open(load_file_path, ios::in);
709
710   // currently loads old mussa format
711
712   // get sequences
713   for(i = 0; i < seq_num; i++)
714   {
715     getline(save_file, file_data_line);
716     boost::shared_ptr<Sequence> a_seq(new Sequence(file_data_line));
717     the_seqs.push_back(a_seq);
718   }
719
720   // get window size
721   getline(save_file, file_data_line);
722   window = atoi(file_data_line.c_str());
723   // get paths
724
725   while (!save_file.eof())
726   {
727     loaded_path.clear();
728     getline(save_file, file_data_line);
729     if (file_data_line != "")
730     for(i = 0; i < seq_num; i++)
731     {
732       space_split_i = file_data_line.find(" ");
733       node_pair = file_data_line.substr(0,space_split_i);
734       //cout << "np= " << node_pair;
735       comma_split_i = node_pair.find(",");
736       node = node_pair.substr(comma_split_i+1);
737       //cout << "n= " << node << " ";
738       loaded_path.push_back(atoi (node.c_str()));
739       file_data_line = file_data_line.substr(space_split_i+1);
740     }
741     //cout << endl;
742     // FIXME: do we have any information about what the threshold should be?
743     the_paths.add_path(0, loaded_path);
744   }
745   save_file.close();
746
747   //the_paths.save("tmp.save");
748 }
749
750 void Mussa::add_motif(const Sequence& motif, const Color& color)
751 {
752   motif_sequences.insert(motif);
753   color_mapper->appendInstanceColor("motif", motif.get_sequence(), color);
754 }
755
756 void Mussa::set_motifs(const vector<Sequence>& motifs, 
757                        const vector<Color>& colors)
758 {
759   if (motifs.size() != colors.size()) {
760     throw mussa_error("motif and color vectors must be the same size");
761   }
762
763   motif_sequences.clear();
764   for(size_t i = 0; i != motifs.size(); ++i)
765   {
766     add_motif(motifs[i], colors[i]);
767   }
768   update_sequences_motifs();
769 }
770
771 // Helper functor to append created motifs to our Mussa analysis
772 struct push_back_motif {
773   Mussa::motif_set& motifs;
774   boost::shared_ptr<AnnotationColors> color_mapper;
775   std::string& seq_string;
776   std::string& name;
777   float& red;
778   float& green;
779   float& blue;
780   float& alpha;
781   int& parsed;
782
783   push_back_motif(Mussa::motif_set& motifs_,
784                   boost::shared_ptr<AnnotationColors> color_mapper_,
785                   std::string& seq_, 
786                   std::string& name_,
787                   float &red_, float &green_, float &blue_, float &alpha_,
788                   int &parsed_)
789     : motifs(motifs_),
790       color_mapper(color_mapper_),
791       seq_string(seq_),
792       name(name_),
793       red(red_),
794       green(green_),
795       blue(blue_),
796       alpha(alpha_),
797       parsed(parsed_)
798   {
799   }
800
801   void operator()(std::string::const_iterator, 
802                   std::string::const_iterator) const 
803   {
804     Sequence seq(seq_string, Sequence::nucleic_alphabet);
805     // shouldn't we have a better field than "fasta header" and speices?
806     seq.set_fasta_header(name);
807     // we need to clear the name in case the next motif doesn't have one.
808     name.clear();
809     // be nice if glsequence was a subclass of sequence so we could
810     // just attach colors directly to the motif.
811     Color c(red, green, blue, alpha);
812     color_mapper->appendInstanceColor("motif", seq.c_str(), c);
813     alpha = 1.0;
814     motifs.insert(seq);
815     ++parsed;
816   };
817 };
818
819 void Mussa::load_motifs(fs::path filename)
820 {
821   fs::ifstream f;
822   f.open(filename, ifstream::in);
823   load_motifs(f);
824 }
825
826 // I mostly split the ifstream out so I can use a stringstream to test it.
827 void Mussa::load_motifs(std::istream &in)
828 {
829   std::string data;
830   const char *alphabet = Alphabet::nucleic_alphabet.c_str();
831   string seq;
832   string name;
833   float red = 1.0;
834   float green = 0.0;
835   float blue = 0.0;
836   float alpha = 1.0;
837   int parsed = 1;
838
839   // slurp our data into a string
840   std::streamsize bytes_read = 1;
841   while (in.good() and bytes_read) {
842     const std::streamsize bufsiz=512;
843     char buf[bufsiz];
844     bytes_read = in.readsome(buf, bufsiz);
845     data.append(buf, buf+bytes_read);
846   }
847   // parse our string
848   bool ok = spirit::parse(data.begin(), data.end(),
849      *(
850        ( 
851         (
852          (+spirit::chset<>(alphabet))[spirit::assign_a(seq)] >> 
853          +spirit::space_p
854         ) >>
855         !(
856           (
857             // names can either be letter followed by non-space characters
858             (spirit::alpha_p >> *spirit::graph_p)[spirit::assign_a(name)]
859             |
860             // or a quoted string
861             (
862              spirit::ch_p('"') >> 
863                (+(~spirit::ch_p('"')))[spirit::assign_a(name)] >>
864              spirit::ch_p('"')
865             )
866           ) >> +spirit::space_p
867         ) >>
868         spirit::real_p[spirit::assign_a(red)] >> +spirit::space_p >>
869         spirit::real_p[spirit::assign_a(green)] >> +spirit::space_p >>
870         spirit::real_p[spirit::assign_a(blue)] >> +spirit::space_p >>
871         !(spirit::real_p[spirit::assign_a(alpha)] >> +spirit::space_p)
872        )[push_back_motif(motif_sequences, color_mapper, seq, name, red, green, blue, alpha, parsed)]
873      )).full;
874   if (not ok) {
875     stringstream msg;
876     msg << "Error parsing motif #" << parsed;
877     // erase our potentially broken motif list
878     motif_sequences.clear();
879     throw motif_load_error(msg.str());
880   }
881   update_sequences_motifs();
882 }
883
884 void Mussa::save_motifs(fs::path filename)
885 {
886   fs::ofstream out_stream;
887   out_stream.open(filename, ofstream::out);
888   save_motifs(out_stream);
889 }
890
891 void Mussa::save_motifs(std::ostream& out)
892 {
893   for(motif_set::iterator motif_i = motif_sequences.begin();
894       motif_i != motif_sequences.end();
895       ++motif_i)
896   {
897     out << motif_i->get_sequence() << " ";
898     if (motif_i->get_name().size() > 0) {
899       out << "\"" << motif_i->get_name() << "\" ";
900     }
901     out << color_mapper->lookup("motif", motif_i->get_sequence());
902     out << std::endl;
903   }
904 }
905
906 void Mussa::update_sequences_motifs()
907 {
908   // once we've loaded all the motifs from the file, 
909   // lets attach them to the sequences
910   for(vector<boost::shared_ptr<Sequence> >::iterator seq_i = the_seqs.begin();
911       seq_i != the_seqs.end();
912       ++seq_i)
913   {
914     // clear out old motifs
915     (*seq_i)->clear_motifs();
916     // for all the motifs in our set, attach them to the current sequence
917     for(set<Sequence>::iterator motif_i = motif_sequences.begin();
918         motif_i != motif_sequences.end();
919         ++motif_i)
920     {
921       (*seq_i)->add_motif(*motif_i);
922     }
923   }
924 }
925
926 const set<Sequence>& Mussa::motifs() const
927 {
928   return motif_sequences;
929 }
930
931 boost::shared_ptr<AnnotationColors> Mussa::colorMapper()
932 {
933   return color_mapper;
934 }