alg/mussa.hpp

   1 #ifndef _MUSSA_CLASS_H_
   2 #define _MUSSA_CLASS_H_
   3 //  This file is part of the Mussa source distribution.
   4 //  http://mussa.caltech.edu/
   5 //  Contact author: Tristan  De Buysscher, tristan@caltech.edu
   6
   7 // This program and all associated source code files are Copyright (C) 2005
   8 // the California Institute of Technology, Pasadena, CA, 91125 USA.  It is
   9 // under the GNU Public License; please see the included LICENSE.txt
  10 // file for more information, or contact Tristan directly.
  11
  12
  13 //                        ----------------------------------------
  14 //                          ---------- mussa_class.hh -----------
  15 //                        ----------------------------------------
  16 #include <QObject>
  17
  18 #include <boost/filesystem/path.hpp>
  19 #include <boost/shared_ptr.hpp>
  20
  21 #include <list>
  22 #include <string>
  23 #include <vector>
  24 #include <set>
  25 #include <istream>
  26
  27 #include "alg/annotation_colors.hpp"
  28 #include "alg/mussa_callback.hpp"
  29 #include "alg/nway_paths.hpp"
  30 #include "alg/sequence.hpp"
  31
  32 std::string int_to_str(int an_int);
  33
  34 class Mussa : public QObject
  35 {
  36     Q_OBJECT
  37
  38 signals:
  39     //! call whatever signaling system we want
  40     void progress(const std::string& description, int cur, int max);
  41
  42 public:
  43     enum analysis_modes { TransitiveNway, RadialNway, EntropyNway,
  44                           RecursiveNway };
  45
  46     Mussa();
  47     Mussa(const Mussa &);
  48
  49     void save();
  50     //! save the nway comparison
  51     void save_muway(boost::filesystem::path save_path);
  52     //! load a saved analysis directory
  53     void load(boost::filesystem::path ana_path);
  54
  55     //! clear parameters and initialize data lists
  56     void clear();
  57
  58     //! set parameters from a file - 'mupa' ~ mussa parameters
  59     void load_mupa_file(std::string para_file_path) { load_mupa_file(boost::filesystem::path(para_file_path));}
  60     void load_mupa_file(boost::filesystem::path para_file_path);
  61
  62     // set parameters individually (eg from user input into gui classes)
  63     //! set analysis name
  64     void set_name(std::string a_name);
  65     //! return name for this analysis
  66     std::string get_name();
  67
  68     //! return number of sequences in this analyzis
  69     /*! this returns either the_seqs.size() or seq_files.size()
  70      *  depending on which has data loaded in
  71      *  (silly delayed loading of sequence data)
  72      */
  73     int size() const;
  74
  75     //! set number of bases for this window size
  76     void set_window(int a_window);
  77     //! get number of bases for the sliding window
  78     int get_window() const;
  79     //! set number of bases that must match for a window to be saved
  80     //! if threshold > soft_threshold this also sets soft_threshold
  81     void set_threshold(int a_threshold);
  82     //! get number of bases that must match for a window to be saved
  83     int get_threshold() const;
  84     //! sets the threshold used for computing the nway paths
  85     //! must be in range [threshold..window size]
  86     void set_soft_threshold(int sft_thres);
  87     int get_soft_threshold() const;
  88
  89     void set_analysis_mode(enum analysis_modes new_ana_mode);
  90     enum analysis_modes get_analysis_mode() const;
  91     //! return a string name for an analysis mode
  92     std::string get_analysis_mode_name() const;
  93
  94     //! return the refined paths found by the nway analysis.
  95     const NwayPaths& paths() const;
  96
  97     //! given selected_paths, and view_paths, compute per base pair matches
  98     //template <class IteratorT>
  99     void createLocalAlignment(std::list<ConservedPath>::iterator begin,
 100                               std::list<ConservedPath>::iterator end,
 101                               std::list<ConservedPath::path_type>& result,
 102                               std::list<std::vector<bool> >& reversed);
 103
 104     //! run seqcomp and the nway filtering algorithm.
 105     /*!analyze will run seqcomp and then the nway algorithm
 106      * on whatever sequences have been loaded into this mussa instance.
 107      * \throws mussa_analysis_error
 108      */
 109     void analyze();
 110     /*! Run the nway filtering algorithm,
 111      *  this might be used when changing the soft threshhold?
 112      */
 113     void nway();
 114
 115     //! appends a string sequence to the list of the_seqs
 116     // void append_sequence(std::string a_seq);
 117     //! appends a sequence to the list of the_seqs (makes copy)
 118     void append_sequence(const Sequence& a_seq);
 119     //! append a sequence to the list of seqs (shared)
 120     void append_sequence(boost::shared_ptr<Sequence> a_seq);
 121
 122     //! Load a sequence from a fasta file and any annotations
 123     /*! \param[in] seq_file the full path to the fasta file
 124      *  \param[in] annot_file the full path to an annotation file,
 125      *             if is an empty string, we won't bother loading anything
 126      *  \param[in] fasta_index specify which sequence in a multisequence fasta
 127      *             file
 128      *  \param[in] sub_seq_start starting slice index to select a subsequence
 129      *             use 0 start from the beginning.
 130      *  \param[in] sub_seq_end ending slice index to select a subsequence
 131      *             use 0 to go to the end.
 132      */
 133     void load_sequence(boost::filesystem::path seq_file,
 134                        boost::filesystem::path annot_file,
 135                        int fasta_index, int sub_seq_start=0, int sub_seq_end=0);
 136     //! allow examining the sequences we have loaded
 137     typedef std::vector<boost::shared_ptr<Sequence> > vector_sequence_type;
 138     const vector_sequence_type& sequences() const;
 139
 140     // deprecated - support bridge for python version of mussa
 141     // these save & load from the old file format
 142     void save_old();
 143     void load_old(char * load_file_path, int s_num);
 144
 145     // manage motif lists
 146     void add_motif(const std::string& motifs,
 147                    const Color& colors);
 148     //! add vector of motifs and colors to our motif collection
 149     /*! this depends on sets and color maps being unique
 150      *  (aka if you add the same item more than once it doesn't
 151      *  increase the size of the data structure
 152      */
 153     void add_motifs(const std::vector<std::string>& motifs,
 154                     const std::vector<Color>& colors);
 155     //! load motifs from an ifstream
 156     /*! The file should look something like
 157      *  <sequence> <red> <green> <blue>
 158      *  where sequence is a string of IUPAC symbols
 159      *  and red,green,blue are a white space separated list of floats
 160      *  in the range [0.0, 1.0]
 161      */
 162     void load_motifs(std::istream &);
 163     //! load a list of motifs from a file named filename
 164     void load_motifs(boost::filesystem::path filename);
 165     //! return our motifs;
 166     const std::set<std::string>& motifs() const;
 167
 168     //! return color mapper
 169     boost::shared_ptr<AnnotationColors> colorMapper();
 170
 171   private:
 172     //! push motifs to our attached sequences
 173     void update_sequences_motifs();
 174
 175     // Private variables
 176     // parameters needed for a mussa analysis
 177     //! name of this analysis. (will also be used when saving an analysis)
 178     std::string analysis_name;
 179     //! how many base pairs to include in a sliding window
 180     int window;
 181     //! how many base pairs need to match order to record a window as conserved
 182     int threshold;
 183     int soft_thres;
 184     //! which nway comparison algorithm to use.
 185     enum analysis_modes ana_mode;
 186     double ent_thres;
 187     //! should we append _w<window_size> to the saved analysis
 188     bool win_append;
 189     //! should we append _t<threshold> to the saved analysis
 190     bool thres_append;
 191
 192     //! sequence data
 193     vector_sequence_type the_seqs;
 194     //! the seqcomp data
 195     std::vector<std::vector<FLPs> > all_comps;
 196     //! N-way data, ie the mussa results
 197     NwayPaths the_paths;
 198
 199     //! motif list
 200     std::set<std::string> motif_sequences;
 201     //! color manager
 202     boost::shared_ptr<AnnotationColors> color_mapper;
 203
 204     // Private methods
 205     //! runs all the seqcomps needed to support the nway comparison
 206     void seqcomp();
 207
 208 };
 209 #endif