alg/sequence.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 //  This file is part of the Mussa source distribution.
  12 //  http://mussa.caltech.edu/
  13 //  Contact author: Tristan  De Buysscher, tristan@caltech.edu
  14
  15 // This program and all associated source code files are Copyright (C) 2005
  16 // the California Institute of Technology, Pasadena, CA, 91125 USA.  It is
  17 // under the GNU Public License; please see the included LICENSE.txt
  18 // file for more information, or contact Tristan directly.
  19
  20
  21 //                        ----------------------------------------
  22 //                           ---------- sequence.cc -----------
  23 //                        ----------------------------------------
  24 #include <boost/filesystem/fstream.hpp>
  25 namespace fs = boost::filesystem;
  26
  27 #include <boost/spirit/core.hpp>
  28 #include <boost/spirit/actor/push_back_actor.hpp>
  29 #include <boost/spirit/iterator/file_iterator.hpp>
  30 #include <boost/spirit/utility/chset.hpp>
  31 namespace spirit = boost::spirit;
  32
  33 #include "alg/sequence.hpp"
  34 #include "mussa_exceptions.hpp"
  35
  36 #include <string>
  37 #include <iostream>
  38 #include <sstream>
  39
  40 // some standard dna alphabets
  41 // \012 = nl
  42 // \015 = cr
  43 // this should make our sequence parsing end-of-line convention
  44 // independent
  45 static const char* dna_alphabet = "AaCcGgTtNn\012\015";
  46 static const char* rna_alphabet = "AaCcGgNnUu\012\015";
  47 static const char* iupac_alphabet = "AaCcGgTtUuRrYyMmKkSsWwBbDdHhVvNn\012\015";
  48
  49 annot::annot()
  50  : start(0),
  51    end(0),
  52    type(""),
  53    name("")
  54 {
  55 }
  56
  57 annot::annot(int start, int end, std::string type, std::string name)
  58  : start(start),
  59    end(end),
  60    type(type),
  61    name(name)
  62 {
  63 }
  64
  65 annot::~annot()
  66 {
  67 }
  68
  69 bool operator==(const annot& left, const annot& right)
  70 {
  71   return ((left.start == right.start) and
  72           (left.end == right.end) and
  73           (left.type == right.type) and
  74           (left.name == right.name));
  75 }
  76
  77 motif::motif(int start, std::string motif)
  78  : annot(start, start+motif.size(), "motif", motif),
  79    sequence(motif)
  80 {
  81 }
  82
  83 motif::~motif()
  84 {
  85 }
  86
  87 Sequence::Sequence()
  88  :  std::string(),
  89     header(""),
  90     species("")
  91 {
  92 }
  93
  94 Sequence::~Sequence()
  95 {
  96 }
  97
  98 Sequence::Sequence(const char *seq)
  99   : header(""),
 100     species("")
 101 {
 102   set_filtered_sequence(seq);
 103 }
 104
 105 Sequence::Sequence(const std::string& seq)
 106   : header(""),
 107     species("")
 108 {
 109   set_filtered_sequence(seq);
 110 }
 111
 112 Sequence::Sequence(const Sequence& o)
 113   : std::string(o),
 114     header(o.header),
 115     species(o.species),
 116     annots(o.annots),
 117     motif_list(o.motif_list)
 118 {
 119 }
 120
 121 Sequence &Sequence::operator=(const Sequence& s)
 122 {
 123   if (this != &s) {
 124     //sequence = s.sequence;
 125     assign(s);
 126     header = s.header;
 127     species = s.species;
 128     annots = s.annots;
 129     motif_list = s.motif_list;
 130   }
 131   return *this;
 132 }
 133
 134 static void multiplatform_getline(std::istream& in, std::string& line)
 135 {
 136   line.clear();
 137   char c;
 138   in.get(c);
 139   while(in.good() and !(c == '\012' or c == '\015') ) {
 140     line.push_back(c);
 141     in.get(c);
 142   }
 143   // if we have cr-lf eat it
 144   c = in.peek();
 145   if (c=='\012' or c == '\015') {
 146     in.get();
 147   }
 148 }
 149
 150 //! load a fasta file into a sequence
 151 /*!
 152  * \param file_path the location of the fasta file in the filesystem
 153  * \param seq_num which sequence in the file to load
 154  * \param start_index starting position in the fasta sequence, 0 for beginning
 155  * \param end_index ending position in the fasta sequence, 0 for end
 156  * \return error message, empty string if no error. (gag!)
 157  */
 158 void Sequence::load_fasta(fs::path file_path, int seq_num,
 159                           int start_index, int end_index)
 160 {
 161   fs::fstream data_file;
 162   data_file.open(file_path, std::ios::in);
 163
 164   if (!data_file.good())
 165   {
 166     throw mussa_load_error("Sequence File: "+file_path.string()+" not found");
 167   } else {
 168     try {
 169       load_fasta(data_file, seq_num, start_index, end_index);
 170     } catch(sequence_empty_error e) {
 171       // there doesn't appear to be any sequence
 172       // catch and rethrow to include the filename
 173       std::stringstream msg;
 174       msg << "The selected sequence in "
 175           << file_path.native_file_string()
 176           << " appears to be empty";
 177       throw sequence_empty_error(msg.str());
 178     } catch(sequence_empty_file_error e) {
 179       std::stringstream errormsg;
 180       errormsg << file_path.native_file_string()
 181                << " did not have any fasta sequences" << std::endl;
 182       throw sequence_empty_file_error(errormsg.str());
 183     }
 184   }
 185 }
 186
 187 void
 188 Sequence::load_fasta(std::iostream& data_file, int seq_num,
 189                      int start_index, int end_index)
 190 {
 191   std::string file_data_line;
 192   int header_counter = 0;
 193   bool read_seq = true;
 194   std::string rev_comp;
 195   std::string sequence_raw;
 196   std::string seq_tmp;             // holds sequence during basic filtering
 197
 198   if (seq_num == 0) {
 199     throw mussa_load_error("fasta sequence number is 1 based (can't be 0)");
 200   }
 201
 202   // search for the header of the fasta sequence we want
 203   while ( (!data_file.eof()) && (header_counter < seq_num) )
 204   {
 205     multiplatform_getline(data_file, file_data_line);
 206     if (file_data_line.substr(0,1) == ">")
 207       header_counter++;
 208   }
 209
 210   if (header_counter > 0) {
 211     header = file_data_line.substr(1);
 212
 213     sequence_raw = "";
 214
 215     while ( !data_file.eof() && read_seq ) {
 216       multiplatform_getline(data_file,file_data_line);
 217       if (file_data_line.substr(0,1) == ">")
 218         read_seq = false;
 219       else sequence_raw += file_data_line;
 220     }
 221
 222     // Lastly, if subselection of the sequence was specified we keep cut out
 223     // and only keep that part
 224     // end_index = 0 means no end was specified, so cut to the end
 225     if (end_index == 0)
 226       end_index = sequence_raw.size();
 227
 228     // sequence filtering for upcasing agctn and convert non AGCTN to N
 229     if (end_index-start_index <= 0) {
 230       std::string msg("The selected sequence appears to be empty");
 231       throw sequence_empty_error(msg);
 232     }
 233     set_filtered_sequence(sequence_raw, start_index, end_index-start_index);
 234   } else {
 235     std::string errormsg("There were no fasta sequences");
 236     throw sequence_empty_file_error(errormsg);
 237   }
 238 }
 239
 240 void Sequence::set_filtered_sequence(const std::string &old_seq,
 241                                      std::string::size_type start,
 242                                      std::string::size_type count)
 243 {
 244   char conversionTable[257];
 245
 246   if ( count == 0)
 247     count = old_seq.size() - start;
 248   std::string::clear();
 249   reserve(count);
 250
 251   // Make a conversion table
 252
 253   // everything we don't specify below will become 'N'
 254   for(int table_i=0; table_i < 256; table_i++)
 255   {
 256     conversionTable[table_i] = 'N';
 257   }
 258   // add end of string character for printing out table for testing purposes
 259   conversionTable[256] = '\0';
 260
 261   // we want these to map to themselves - ie not to change
 262   conversionTable[(int)'A'] = 'A';
 263   conversionTable[(int)'T'] = 'T';
 264   conversionTable[(int)'G'] = 'G';
 265   conversionTable[(int)'C'] = 'C';
 266   // this is to upcase
 267   conversionTable[(int)'a'] = 'A';
 268   conversionTable[(int)'t'] = 'T';
 269   conversionTable[(int)'g'] = 'G';
 270   conversionTable[(int)'c'] = 'C';
 271
 272   // finally, the actual conversion loop
 273   for(std::string::size_type seq_index = 0; seq_index < count; seq_index++)
 274   {
 275     append(1, conversionTable[ (int)old_seq[seq_index+start]]);
 276   }
 277 }
 278
 279   // this doesn't work properly under gcc 3.x ... it can't recognize toupper
 280   //transform(sequence.begin(), sequence.end(), sequence.begin(), toupper);
 281
 282 void
 283 Sequence::load_annot(fs::path file_path, int start_index, int end_index)
 284 {
 285   fs::fstream data_stream(file_path, std::ios::in);
 286   if (!data_stream)
 287   {
 288     throw mussa_load_error("Sequence File: " + file_path.string() + " not found");
 289   }
 290
 291   // so i should probably be passing the parse function some iterators
 292   // but the annotations files are (currently) small, so i think i can
 293   // get away with loading the whole file into memory
 294   std::string data;
 295   char c;
 296   while(data_stream.good()) {
 297     data_stream.get(c);
 298     data.push_back(c);
 299   }
 300   data_stream.close();
 301
 302   parse_annot(data, start_index, end_index);
 303 }
 304
 305 /* If this works, yikes, this is some brain hurting code.
 306  *
 307  * what's going on is that when pb_annot is instantiated it stores references
 308  * to begin, end, name, type, declared in the parse function, then
 309  * when operator() is called it grabs values from those references
 310  * and uses that to instantiate an annot object and append that to our
 311  * annotation list.
 312  *
 313  * This weirdness is because the spirit library requires that actions
 314  * conform to a specific prototype operator()(IteratorT, IteratorT)
 315  * which doesn't provide any useful opportunity for me to actually
 316  * grab the results of our parsing.
 317  *
 318  * so I instantiate this structure in order to have a place to grab
 319  * my data from.
 320  */
 321
 322 struct push_back_annot {
 323   std::list<annot>& annot_list;
 324   int& begin;
 325   int& end;
 326   std::string& name;
 327   std::string& type;
 328
 329   push_back_annot(std::list<annot>& annot_list_,
 330                   int& begin_,
 331                   int& end_,
 332                   std::string& name_,
 333                   std::string& type_)
 334   : annot_list(annot_list_),
 335     begin(begin_),
 336     end(end_),
 337     name(name_),
 338     type(type_)
 339   {
 340   }
 341
 342   void operator()(std::string::const_iterator,
 343                   std::string::const_iterator) const
 344   {
 345     //std::cout << "adding annot: " << begin << "|" << end << "|" << name << "|" << type << std::endl;
 346     annot_list.push_back(annot(begin, end, name, type));
 347   };
 348 };
 349
 350 struct push_back_seq {
 351   std::list<Sequence>& seq_list;
 352   std::string& name;
 353   std::string& seq;
 354
 355   push_back_seq(std::list<Sequence>& seq_list_,
 356                 std::string& name_,
 357                 std::string& seq_)
 358   : seq_list(seq_list_),
 359     name(name_),
 360     seq(seq_)
 361   {
 362   }
 363
 364   void operator()(std::string::const_iterator,
 365                   std::string::const_iterator) const
 366   {
 367     // filter out newlines from our sequence
 368     std::string new_seq;
 369     for(std::string::const_iterator seq_i = seq.begin();
 370         seq_i != seq.end();
 371         ++seq_i)
 372     {
 373       if (*seq_i != '\015' && *seq_i != '\012') new_seq += *seq_i;
 374     }
 375     //std::cout << "adding seq: " << name << " " << new_seq << std::endl;
 376
 377     Sequence s(new_seq);
 378     s.set_header(name);
 379     seq_list.push_back(s);
 380   };
 381 };
 382
 383 void
 384 Sequence::parse_annot(std::string data, int start_index, int end_index)
 385 {
 386   int start=0;
 387   int end=0;
 388   std::string name;
 389   std::string type;
 390   std::string seq;
 391   std::list<Sequence> query_seqs;
 392
 393   bool status = spirit::parse(data.begin(), data.end(),
 394                 (
 395                  //begin grammar
 396                    !(
 397                       (
 398                         spirit::alpha_p >>
 399                         +(spirit::graph_p)
 400                       )[spirit::assign_a(species)] >>
 401                       +(spirit::space_p)
 402                     ) >>
 403                     *(
 404                       ( // parse an absolute location name
 405                        (spirit::uint_p[spirit::assign_a(start)] >>
 406                         +spirit::space_p >>
 407                         spirit::uint_p[spirit::assign_a(end)] >>
 408                         +spirit::space_p >>
 409                         (
 410                            spirit::alpha_p >>
 411                            *spirit::graph_p
 412                         )[spirit::assign_a(name)] >>
 413                         // optional type
 414                         !(
 415                             +spirit::space_p >>
 416                             (
 417                               spirit::alpha_p >>
 418                               *spirit::graph_p
 419                             )[spirit::assign_a(type)]
 420                         )
 421                         // to understand how this group gets set
 422                         // read the comment above struct push_back_annot
 423                        )[push_back_annot(annots, start, end, type, name)]
 424                      |
 425                       (spirit::ch_p('>') >>
 426                          (*(spirit::print_p))[spirit::assign_a(name)] >>
 427                          spirit::eol_p >>
 428                          (+(spirit::chset<>(iupac_alphabet)))[spirit::assign_a(seq)]
 429                        )[push_back_seq(query_seqs, name, seq)]
 430                       ) >>
 431                       *spirit::space_p
 432                      )
 433                 //end grammar
 434                 ) /*,
 435                 spirit::space_p*/).full;
 436
 437   // go seearch for query sequences
 438   find_sequences(query_seqs.begin(), query_seqs.end());
 439 }
 440
 441 void Sequence::set_species(const std::string& name)
 442 {
 443   species = name;
 444 }
 445
 446 const std::string& Sequence::get_species() const
 447 {
 448   return species;
 449 }
 450
 451 void Sequence::add_annotation(const annot& a)
 452 {
 453   annots.push_back(a);
 454 }
 455
 456 const std::list<annot>& Sequence::annotations() const
 457 {
 458   return annots;
 459 }
 460
 461 Sequence
 462 Sequence::subseq(int start, int count) const
 463 {
 464   // there might be an off by one error with start+count > size()
 465   if ( count == npos || start+count > size()) {
 466     count = size()-start;
 467   }
 468   Sequence new_seq(std::string::substr(start, count));
 469   new_seq.set_header(get_header());
 470   //new_seq.set_species(get_species());
 471
 472   new_seq.motif_list = motif_list;
 473   // attempt to copy & reannotate position based annotations
 474   int end = start+count;
 475
 476   for(std::list<annot>::const_iterator annot_i = annots.begin();
 477       annot_i != annots.end();
 478       ++annot_i)
 479   {
 480     int annot_start = annot_i->start;
 481     int annot_end = annot_i->end;
 482
 483     if (annot_start < end) {
 484       if (annot_start >=start) {
 485         annot_start -= start;
 486       } else {
 487         annot_start = 0;
 488       }
 489
 490       if (annot_end < end) {
 491         annot_end -= start;
 492       } else {
 493         annot_end = count;
 494       }
 495
 496       annot new_annot(annot_start, annot_end, annot_i->type, annot_i->name);
 497       new_seq.annots.push_back(new_annot);
 498     }
 499   }
 500
 501   return new_seq;
 502 }
 503
 504 std::string
 505 Sequence::rev_comp() const
 506 {
 507   std::string rev_comp;
 508   char conversionTable[257];
 509   int seq_i, table_i, len;
 510
 511   len = length();
 512   rev_comp.reserve(len);
 513   // make a conversion table
 514   // init all parts of conversion table to '~' character
 515   // '~' I doubt will ever appear in a sequence file (jeez, I hope)
 516   // and may the fleas of 1000 camels infest the genitals of any biologist (and
 517   // seven generations of their progeny) who decides to make it mean
 518   // something special!!!
 519   // PS - double the curse for any smartass non-biologist who tries it as well
 520   for(table_i=0; table_i < 256; table_i++)
 521   {
 522     conversionTable[table_i] = '~';
 523   }
 524   // add end of string character for printing out table for testing purposes
 525   conversionTable[256] = '\0';
 526
 527   // add in the characters for the bases we want to convert
 528   conversionTable[(int)'A'] = 'T';
 529   conversionTable[(int)'T'] = 'A';
 530   conversionTable[(int)'G'] = 'C';
 531   conversionTable[(int)'C'] = 'G';
 532   conversionTable[(int)'N'] = 'N';
 533
 534   // finally, the actual conversion loop
 535   for(seq_i = len - 1; seq_i >= 0; seq_i--)
 536   {
 537     table_i = (int) at(seq_i);
 538     rev_comp += conversionTable[table_i];
 539   }
 540
 541   return rev_comp;
 542 }
 543
 544 void Sequence::set_header(std::string header_)
 545 {
 546   header = header_;
 547 }
 548
 549 std::string
 550 Sequence::get_header() const
 551 {
 552   return header;
 553 }
 554
 555 /*
 556 std::string
 557 Sequence::species()
 558 {
 559   return species;
 560 }
 561 */
 562
 563 void
 564 Sequence::clear()
 565 {
 566   std::string::clear();
 567   header = "";
 568   species = "";
 569   annots.clear();
 570 }
 571
 572 void
 573 Sequence::save(fs::fstream &save_file)
 574                //std::string save_file_path)
 575 {
 576   //fstream save_file;
 577   std::list<annot>::iterator annots_i;
 578
 579   // not sure why, or if i'm doing something wrong, but can't seem to pass
 580   // file pointers down to this method from the mussa control class
 581   // so each call to save a sequence appends to the file started by mussa_class
 582   //save_file.open(save_file_path.c_str(), std::ios::app);
 583
 584   save_file << "<Sequence>" << std::endl;
 585   save_file << *this << std::endl;
 586   save_file << "</Sequence>" << std::endl;
 587
 588   save_file << "<Annotations>" << std::endl;
 589   save_file << species << std::endl;
 590   for (annots_i = annots.begin(); annots_i != annots.end(); ++annots_i)
 591   {
 592     save_file << annots_i->start << " " << annots_i->end << " " ;
 593     save_file << annots_i->name << " " << annots_i->type << std::endl;
 594   }
 595   save_file << "</Annotations>" << std::endl;
 596   //save_file.close();
 597 }
 598
 599 void
 600 Sequence::load_museq(fs::path load_file_path, int seq_num)
 601 {
 602   fs::fstream load_file;
 603   std::string file_data_line;
 604   int seq_counter;
 605   annot an_annot;
 606   std::string::size_type space_split_i;
 607   std::string annot_value;
 608
 609   annots.clear();
 610   load_file.open(load_file_path, std::ios::in);
 611
 612   seq_counter = 0;
 613   // search for the seq_num-th sequence
 614   while ( (!load_file.eof()) && (seq_counter < seq_num) )
 615   {
 616     getline(load_file,file_data_line);
 617     if (file_data_line == "<Sequence>")
 618       seq_counter++;
 619   }
 620   getline(load_file, file_data_line);
 621   assign(file_data_line);
 622   getline(load_file, file_data_line);
 623   getline(load_file, file_data_line);
 624   if (file_data_line == "<Annotations>")
 625   {
 626     getline(load_file, file_data_line);
 627     species = file_data_line;
 628     while ( (!load_file.eof())  && (file_data_line != "</Annotations>") )
 629     {
 630       getline(load_file,file_data_line);
 631       if ((file_data_line != "") && (file_data_line != "</Annotations>"))
 632       {
 633         // need to get 4 values...almost same code 4 times...
 634         // get annot start index
 635         space_split_i = file_data_line.find(" ");
 636         annot_value = file_data_line.substr(0,space_split_i);
 637         an_annot.start = atoi (annot_value.c_str());
 638         file_data_line = file_data_line.substr(space_split_i+1);
 639         // get annot end index
 640         space_split_i = file_data_line.find(" ");
 641         annot_value = file_data_line.substr(0,space_split_i);
 642         an_annot.end = atoi (annot_value.c_str());
 643
 644         if (space_split_i == std::string::npos)  // no entry for type or name
 645         {
 646           std::cout << "seq, annots - no type or name\n";
 647           an_annot.type = "";
 648           an_annot.name = "";
 649         }
 650         else   // else get annot type
 651         {
 652           file_data_line = file_data_line.substr(space_split_i+1);
 653           space_split_i = file_data_line.find(" ");
 654           annot_value = file_data_line.substr(0,space_split_i);
 655           an_annot.type = annot_value;
 656           if (space_split_i == std::string::npos)  // no entry for name
 657           {
 658             std::cout << "seq, annots - no name\n";
 659             an_annot.name = "";
 660           }
 661           else          // get annot name
 662           {
 663             file_data_line = file_data_line.substr(space_split_i+1);
 664             space_split_i = file_data_line.find(" ");
 665             annot_value = file_data_line.substr(0,space_split_i);
 666             an_annot.type = annot_value;
 667           }
 668         }
 669         annots.push_back(an_annot);  // don't forget to actually add the annot
 670       }
 671       //std::cout << "seq, annots: " << an_annot.start << ", " << an_annot.end
 672       //     << "-->" << an_annot.type << "::" << an_annot.name << std::endl;
 673     }
 674   }
 675   load_file.close();
 676 }
 677
 678
 679 std::string
 680 Sequence::rc_motif(std::string a_motif)
 681 {
 682   std::string rev_comp;
 683   char conversionTable[257];
 684   int seq_i, table_i, len;
 685
 686   len = a_motif.length();
 687   rev_comp.reserve(len);
 688
 689   for(table_i=0; table_i < 256; table_i++)
 690   {
 691     conversionTable[table_i] = '~';
 692   }
 693   // add end of std::string character for printing out table for testing purposes
 694   conversionTable[256] = '\0';
 695
 696   // add in the characters for the bases we want to convert (IUPAC)
 697   conversionTable[(int)'A'] = 'T';
 698   conversionTable[(int)'T'] = 'A';
 699   conversionTable[(int)'G'] = 'C';
 700   conversionTable[(int)'C'] = 'G';
 701   conversionTable[(int)'N'] = 'N';
 702   conversionTable[(int)'M'] = 'K';
 703   conversionTable[(int)'R'] = 'Y';
 704   conversionTable[(int)'W'] = 'W';
 705   conversionTable[(int)'S'] = 'S';
 706   conversionTable[(int)'Y'] = 'R';
 707   conversionTable[(int)'K'] = 'M';
 708   conversionTable[(int)'V'] = 'B';
 709   conversionTable[(int)'H'] = 'D';
 710   conversionTable[(int)'D'] = 'H';
 711   conversionTable[(int)'B'] = 'V';
 712
 713   // finally, the actual conversion loop
 714   for(seq_i = len - 1; seq_i >= 0; seq_i--)
 715   {
 716     //std::cout << "** i = " << seq_i << " bp = " <<
 717     table_i = (int) a_motif[seq_i];
 718     rev_comp += conversionTable[table_i];
 719   }
 720
 721   //std::cout << "seq: " << a_motif << std::endl;
 722   //std::cout << "rc:  " << rev_comp << std::endl;
 723
 724   return rev_comp;
 725 }
 726
 727 std::string
 728 Sequence::motif_normalize(std::string a_motif)
 729 {
 730   std::string valid_motif;
 731   int seq_i, len;
 732
 733   len = a_motif.length();
 734   valid_motif.reserve(len);
 735
 736   // this just upcases IUPAC symbols.  Eventually should return an error if non IUPAC is present.
 737   // current nonIUPAC symbols are omitted, which is not reported atm
 738   for(seq_i = 0; seq_i < len; seq_i++)
 739   {
 740     if ((a_motif[seq_i] == 'a') || (a_motif[seq_i] == 'A'))
 741       valid_motif += 'A';
 742     else if ((a_motif[seq_i] == 't') || (a_motif[seq_i] == 'T'))
 743       valid_motif += 'T';
 744     else if ((a_motif[seq_i] == 'g') || (a_motif[seq_i] == 'G'))
 745       valid_motif += 'G';
 746     else if ((a_motif[seq_i] == 'c') || (a_motif[seq_i] == 'C'))
 747       valid_motif += 'C';
 748     else if ((a_motif[seq_i] == 'n') || (a_motif[seq_i] == 'N'))
 749       valid_motif += 'N';
 750     else if ((a_motif[seq_i] == 'm') || (a_motif[seq_i] == 'M'))
 751       valid_motif += 'M';
 752     else if ((a_motif[seq_i] == 'r') || (a_motif[seq_i] == 'R'))
 753       valid_motif += 'R';
 754     else if ((a_motif[seq_i] == 'w') || (a_motif[seq_i] == 'W'))
 755       valid_motif += 'W';
 756     else if ((a_motif[seq_i] == 's') || (a_motif[seq_i] == 'S'))
 757       valid_motif += 'S';
 758     else if ((a_motif[seq_i] == 'y') || (a_motif[seq_i] == 'Y'))
 759       valid_motif += 'Y';
 760     else if ((a_motif[seq_i] == 'k') || (a_motif[seq_i] == 'K'))
 761       valid_motif += 'G';
 762     else if ((a_motif[seq_i] == 'v') || (a_motif[seq_i] == 'V'))
 763       valid_motif += 'V';
 764     else if ((a_motif[seq_i] == 'h') || (a_motif[seq_i] == 'H'))
 765       valid_motif += 'H';
 766     else if ((a_motif[seq_i] == 'd') || (a_motif[seq_i] == 'D'))
 767       valid_motif += 'D';
 768     else if ((a_motif[seq_i] == 'b') || (a_motif[seq_i] == 'B'))
 769       valid_motif += 'B';
 770     else {
 771       std::string msg = "Letter ";
 772       msg += a_motif[seq_i];
 773       msg += " is not a valid IUPAC symbol";
 774       throw motif_normalize_error(msg);
 775     }
 776   }
 777   //std::cout << "valid_motif is: " << valid_motif << std::endl;
 778   return valid_motif;
 779 }
 780
 781 void Sequence::add_motif(const Sequence& a_motif)
 782 {
 783   std::vector<int> motif_starts = find_motif(a_motif);
 784
 785   for(std::vector<int>::iterator motif_start_i = motif_starts.begin();
 786       motif_start_i != motif_starts.end();
 787       ++motif_start_i)
 788   {
 789     motif_list.push_back(motif(*motif_start_i, a_motif));
 790   }
 791 }
 792
 793 void Sequence::clear_motifs()
 794 {
 795   motif_list.clear();
 796 }
 797
 798 const std::list<motif>& Sequence::motifs() const
 799 {
 800   return motif_list;
 801 }
 802
 803 std::vector<int>
 804 Sequence::find_motif(std::string a_motif)
 805 {
 806   std::vector<int> motif_match_starts;
 807   std::string a_motif_rc;
 808
 809   motif_match_starts.clear();
 810
 811   //std::cout << "motif is: " << a_motif << std::endl;
 812   a_motif = motif_normalize(a_motif);
 813   //std::cout << "motif is: " << a_motif << std::endl;
 814
 815   if (a_motif.size() > 0)
 816   {
 817     //std::cout << "Sequence: none blank motif\n";
 818     motif_scan(a_motif, &motif_match_starts);
 819
 820     a_motif_rc = rc_motif(a_motif);
 821     // make sure not to do search again if it is a palindrome
 822     if (a_motif_rc != a_motif) {
 823       motif_scan(a_motif_rc, &motif_match_starts);
 824     }
 825   }
 826   return motif_match_starts;
 827 }
 828
 829 void
 830 Sequence::motif_scan(std::string a_motif, std::vector<int> * motif_match_starts)
 831 {
 832    const char * seq_c;
 833   std::string::size_type seq_i;
 834   int motif_i, motif_len;
 835
 836   // faster to loop thru the sequence as a old c std::string (ie char array)
 837   seq_c = c_str();
 838   //std::cout << "Sequence: motif, seq len = " << sequence.length() << std::endl;
 839   motif_len = a_motif.length();
 840
 841   //std::cout << "motif_length: " << motif_len << std::endl;
 842   //std::cout << "RAAARRRRR\n";
 843
 844   motif_i = 0;
 845
 846   //std::cout << "motif: " << a_motif << std::endl;
 847
 848   //std::cout << "Sequence: motif, length= " << length << std::endl;
 849   seq_i = 0;
 850   while (seq_i < length())
 851   {
 852     //std::cout << seq_c[seq_i];
 853     //std::cout << seq_c[seq_i] << "?" << a_motif[motif_i] << ":" << motif_i << " ";
 854     // this is pretty much a straight translation of Nora's python code
 855     // to match iupac letter codes
 856     if (a_motif[motif_i] =='N')
 857       motif_i++;
 858     else if (a_motif[motif_i] == seq_c[seq_i])
 859       motif_i++;
 860     else if ((a_motif[motif_i] =='M') &&
 861              ((seq_c[seq_i]=='A') || (seq_c[seq_i]=='C')))
 862       motif_i++;
 863     else if ((a_motif[motif_i] =='R') &&
 864              ((seq_c[seq_i]=='A') || (seq_c[seq_i]=='G')))
 865       motif_i++;
 866     else if ((a_motif[motif_i] =='W') &&
 867              ((seq_c[seq_i]=='A') || (seq_c[seq_i]=='T')))
 868       motif_i++;
 869     else if ((a_motif[motif_i] =='S') &&
 870              ((seq_c[seq_i]=='C') || (seq_c[seq_i]=='G')))
 871       motif_i++;
 872     else if ((a_motif[motif_i] =='Y') &&
 873              ((seq_c[seq_i]=='C') || (seq_c[seq_i]=='T')))
 874       motif_i++;
 875     else if ((a_motif[motif_i] =='K') &&
 876              ((seq_c[seq_i]=='G') || (seq_c[seq_i]=='T')))
 877       motif_i++;
 878     else if ((a_motif[motif_i] =='V') &&
 879              ((seq_c[seq_i]=='A') || (seq_c[seq_i]=='C') ||
 880               (seq_c[seq_i]=='G')))
 881       motif_i++;
 882     else if ((a_motif[seq_i] =='H') &&
 883              ((seq_c[seq_i]=='A') || (seq_c[seq_i]=='C') ||
 884               (seq_c[seq_i]=='T')))
 885       motif_i++;
 886     else if ((a_motif[motif_i] =='D') &&
 887              ((seq_c[seq_i]=='A') || (seq_c[seq_i]=='G') ||
 888               (seq_c[seq_i]=='T')))
 889       motif_i++;
 890     else if ((a_motif[motif_i] =='B') &&
 891              ((seq_c[seq_i]=='C') || (seq_c[seq_i]=='G') ||
 892               (seq_c[seq_i]=='T')))
 893       motif_i++;
 894
 895     else
 896     {
 897       seq_i -= motif_i;
 898       motif_i = 0;
 899     }
 900
 901     // end Nora stuff, now we see if a match is found this pass
 902     if (motif_i == motif_len)
 903     {
 904       //std::cout << "!!";
 905       annot new_motif;
 906       motif_match_starts->push_back(seq_i - motif_len + 1);
 907       motif_i = 0;
 908     }
 909
 910     seq_i++;
 911   }
 912   //std::cout << std::endl;
 913 }
 914
 915 void Sequence::add_string_annotation(std::string a_seq,
 916                                      std::string name)
 917 {
 918   std::vector<int> seq_starts = find_motif(a_seq);
 919
 920   //std::cout << "searching for " << a_seq << " found " << seq_starts.size() << std::endl;
 921
 922   for(std::vector<int>::iterator seq_start_i = seq_starts.begin();
 923       seq_start_i != seq_starts.end();
 924       ++seq_start_i)
 925   {
 926     annots.push_back(annot(*seq_start_i,
 927                            *seq_start_i+a_seq.size(),
 928                            "",
 929                            name));
 930   }
 931 }
 932
 933 void Sequence::find_sequences(std::list<Sequence>::iterator start,
 934                               std::list<Sequence>::iterator end)
 935 {
 936   while (start != end) {
 937     add_string_annotation(*start, start->get_header());
 938     ++start;
 939   }
 940 }
 941