/usr/include/Bpp/Seq/Io/Maf/MafSequence.h is in libbpp-seq-omics-dev 2.4.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | //
// File: MafSequence.h
// Authors: Julien Dutheil
// Created: Tue Sep 07 2010
//
/*
Copyright or © or Copr. Bio++ Development Team, (2010)
This software is a computer program whose purpose is to provide classes
for sequences analysis.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _MAFSEQUENCE_H_
#define _MAFSEQUENCE_H_
#include "../../Feature/SequenceFeature.h"
#include <Bpp/Seq/SequenceWithAnnotation.h>
#include <Bpp/Seq/Alphabet/AlphabetTools.h>
#include <Bpp/Seq/SequenceTools.h>
namespace bpp {
/**
* @brief A sequence class which is used to store data from MAF files.
*
* It extends the SequenceWithAnnotation class to store MAF-specific features,
* like the chromosome position. The sequence is its own listener,
* and recomputes its "genomic" site by using the SequenceTools::getNumberOfSites
* function when a content modification is performed.
* Tags like begin and stop, hovever, have to be set by hand.
*
* A MAF sequence is necessarily a DNA sequence.
*/
class MafSequence:
public SequenceWithAnnotation
{
private:
bool hasCoordinates_;
size_t begin_;
std::string species_;
std::string chromosome_;
char strand_;
size_t size_;
size_t srcSize_;
public:
MafSequence(const Alphabet* alphabet = &AlphabetTools::DNA_ALPHABET):
SequenceWithAnnotation(alphabet), hasCoordinates_(false), begin_(0), species_(""), chromosome_(""), strand_(0), size_(0), srcSize_(0)
{}
MafSequence(const std::string& name, const std::string& sequence, bool parseName = true, const Alphabet* alphabet = &AlphabetTools::DNA_ALPHABET):
SequenceWithAnnotation(name, sequence, alphabet), hasCoordinates_(false), begin_(0), species_(""), chromosome_(""), strand_(0), size_(0), srcSize_(0)
{
size_ = SequenceTools::getNumberOfSites(*this);
if (parseName)
splitNameIntoSpeciesAndChromosome(name, species_, chromosome_);
}
MafSequence(const std::string& name, const std::string& sequence, size_t begin, char strand, size_t srcSize, bool parseName = true, const Alphabet* alphabet = &AlphabetTools::DNA_ALPHABET) :
SequenceWithAnnotation(name, sequence, alphabet), hasCoordinates_(true), begin_(begin), species_(""), chromosome_(""), strand_(strand), size_(0), srcSize_(srcSize)
{
size_ = SequenceTools::getNumberOfSites(*this);
if (parseName)
splitNameIntoSpeciesAndChromosome(name, species_, chromosome_);
}
MafSequence* clone() const {
return new MafSequence(*this);
}
MafSequence* cloneMeta() const {
return new MafSequence(getName(), std::string(), begin_, strand_, srcSize_, true);
}
~MafSequence() {}
public:
bool hasCoordinates() const { return hasCoordinates_; }
void removeCoordinates() { hasCoordinates_ = false; begin_ = 0; }
size_t start() const {
if (hasCoordinates_) return begin_;
else throw Exception("MafSequence::start(). Sequence " + getName() + " does not have coordinates.");
}
size_t stop() const {
if (hasCoordinates_) return begin_ + size_;
else throw Exception("MafSequence::stop(). Sequence " + getName() + " does not have coordinates.");
}
/**
* @return A range with coordinates from this sequence.
* @param origin Tell if coordinates according to original sequence should be used.
* If 'yes' and the sequence is on the negative strand, the returned range will be computed as [SrcSize-Stop, SrcSize-Start[
*/
Range<size_t> getRange(bool origin = true) const {
if (hasCoordinates_) {
if (origin && strand_ == '-') {
return Range<size_t>(srcSize_ - stop(), srcSize_ - start());
} else {
return Range<size_t>(start(), stop());
}
}
else throw Exception("MafSequence::getRange(). Sequence " + getName() + " does not have coordinates.");
}
void setName(const std::string& name) {
try {
splitNameIntoSpeciesAndChromosome(name, species_, chromosome_);
} catch (Exception& e) {
species_ = "";
chromosome_ = "";
}
SequenceWithAnnotation::setName(name);
}
static void splitNameIntoSpeciesAndChromosome(const std::string& name, std::string& species, std::string& chr) {
size_t pos = name.find(".");
if (pos != std::string::npos) {
chr = name.substr(pos + 1);
species = name.substr(0, pos);
} else {
throw Exception("MafSequence::splitNameIntospeciesAndChromosome(). Invalid sequence name: " + name);
}
}
const std::string& getSpecies() const { return species_; }
const std::string& getChromosome() const { return chromosome_; }
char getStrand() const { return strand_; }
size_t getGenomicSize() const { return size_; }
size_t getSrcSize() const { return srcSize_; }
void setStart(size_t begin) { begin_ = begin; hasCoordinates_ = true; }
void setChromosome(const std::string& chr) {
chromosome_ = chr;
SequenceWithAnnotation::setName(species_ + "." + chromosome_);
}
void setSpecies(const std::string& species) {
species_ = species;
SequenceWithAnnotation::setName(species_ + "." + chromosome_);
}
void setStrand(char s) { strand_ = s; }
void setSrcSize(size_t srcSize) { srcSize_ = srcSize; }
std::string getDescription() const { return getName() + strand_ + ":" + (hasCoordinates_ ? TextTools::toString(start()) + "-" + TextTools::toString(stop()) : "?-?"); }
/**
* @brief Extract a sub-sequence.
*
* @return A subsequence.
* @param startAt Begining of sub-sequence.
* @param length the length of the sub-sequence.
*/
MafSequence* subSequence(size_t startAt, size_t length) const;
private:
void beforeSequenceChanged(const SymbolListEditionEvent& event) {}
void afterSequenceChanged(const SymbolListEditionEvent& event) { size_ = SequenceTools::getNumberOfSites(*this); }
void beforeSequenceInserted(const SymbolListInsertionEvent& event) {}
void afterSequenceInserted(const SymbolListInsertionEvent& event) { size_ = SequenceTools::getNumberOfSites(*this); }
void beforeSequenceDeleted(const SymbolListDeletionEvent& event) {}
void afterSequenceDeleted(const SymbolListDeletionEvent& event) { size_ = SequenceTools::getNumberOfSites(*this); }
void beforeSequenceSubstituted(const SymbolListSubstitutionEvent& event) {}
void afterSequenceSubstituted(const SymbolListSubstitutionEvent& event) {}
};
} // end of namespace bpp.
#endif //_MAFSEQUENCE_H_
|