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