yat/omic/BamReadIterator.h

Code
Comments
Other
Rev Date Author Line
2883 03 Dec 12 peter 1 #ifndef theplu_yat_omic_bam_read_iterator
2883 03 Dec 12 peter 2 #define theplu_yat_omic_bam_read_iterator
2883 03 Dec 12 peter 3
2883 03 Dec 12 peter 4 // $Id$
2883 03 Dec 12 peter 5
2993 03 Mar 13 peter 6 /*
4359 23 Aug 23 peter 7   Copyright (C) 2012, 2013, 2014, 2017, 2018, 2020, 2023 Peter Johansson
2993 03 Mar 13 peter 8
2993 03 Mar 13 peter 9   This file is part of the yat library, http://dev.thep.lu.se/yat
2993 03 Mar 13 peter 10
2993 03 Mar 13 peter 11   The yat library is free software; you can redistribute it and/or
2993 03 Mar 13 peter 12   modify it under the terms of the GNU General Public License as
2993 03 Mar 13 peter 13   published by the Free Software Foundation; either version 3 of the
2993 03 Mar 13 peter 14   License, or (at your option) any later version.
2993 03 Mar 13 peter 15
2993 03 Mar 13 peter 16   The yat library is distributed in the hope that it will be useful,
2993 03 Mar 13 peter 17   but WITHOUT ANY WARRANTY; without even the implied warranty of
2993 03 Mar 13 peter 18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2993 03 Mar 13 peter 19   General Public License for more details.
2993 03 Mar 13 peter 20
2993 03 Mar 13 peter 21   You should have received a copy of the GNU General Public License
3752 17 Oct 18 peter 22   along with yat. If not, see <http://www.gnu.org/licenses/>.
2993 03 Mar 13 peter 23 */
2993 03 Mar 13 peter 24
2883 03 Dec 12 peter 25 #include "BamFile.h"
2883 03 Dec 12 peter 26 #include "BamRead.h"
2883 03 Dec 12 peter 27
3883 24 Mar 20 peter 28 #include <htslib/sam.h>
2883 03 Dec 12 peter 29
2883 03 Dec 12 peter 30 #include <boost/iterator/iterator_facade.hpp>
2883 03 Dec 12 peter 31
2883 03 Dec 12 peter 32 #include <iterator>
4011 22 Oct 20 peter 33 #include <memory>
4272 24 Jan 23 peter 34 #include <vector>
2883 03 Dec 12 peter 35
2883 03 Dec 12 peter 36 namespace theplu {
2883 03 Dec 12 peter 37 namespace yat {
2883 03 Dec 12 peter 38 namespace omic {
2883 03 Dec 12 peter 39
2883 03 Dec 12 peter 40   // forward declaration
4272 24 Jan 23 peter 41   class BamRegion;
2883 03 Dec 12 peter 42   class InBamFile;
2883 03 Dec 12 peter 43
2883 03 Dec 12 peter 44   /**
2883 03 Dec 12 peter 45      \brief class to iterate through a InBamFile
2883 03 Dec 12 peter 46
2883 03 Dec 12 peter 47      Iterator is a single pass \input_iterator which means iterator
2986 18 Feb 13 peter 48      can only be used read bam file. If creating two iterators working
2986 18 Feb 13 peter 49      on the same InBamFile, the iterators are not independent of each
2986 18 Feb 13 peter 50      other. Incrementing one, the behaviour of the other is undefined.
2883 03 Dec 12 peter 51
2883 03 Dec 12 peter 52      Iterator can either be constructed to iterate over entire bam
2883 03 Dec 12 peter 53      file or if a region is specified only over that region. When no
2883 03 Dec 12 peter 54      more elements are available, iterator turns into a end-of-file
2883 03 Dec 12 peter 55      iterator and is no longer dereferencable.
2883 03 Dec 12 peter 56
2883 03 Dec 12 peter 57      \see InBamFile
2884 04 Dec 12 peter 58
2884 04 Dec 12 peter 59      \since New in yat 0.10
2883 03 Dec 12 peter 60    */
2883 03 Dec 12 peter 61   class BamReadIterator
2883 03 Dec 12 peter 62     : public boost::iterator_facade<
2883 03 Dec 12 peter 63     BamReadIterator, const BamRead, std::input_iterator_tag
2883 03 Dec 12 peter 64     >
2883 03 Dec 12 peter 65   {
2883 03 Dec 12 peter 66   public:
2883 03 Dec 12 peter 67     /**
2883 03 Dec 12 peter 68        \brief Contructs end of file iterator.
2883 03 Dec 12 peter 69      */
2883 03 Dec 12 peter 70     BamReadIterator(void);
2883 03 Dec 12 peter 71
2883 03 Dec 12 peter 72     /**
2883 03 Dec 12 peter 73        Creates an iterator pointing to first BamRead in
2883 03 Dec 12 peter 74        InBamFile.
2883 03 Dec 12 peter 75
2883 03 Dec 12 peter 76        \param in file to iterate over
2883 03 Dec 12 peter 77      */
2883 03 Dec 12 peter 78     explicit BamReadIterator(InBamFile& in);
2883 03 Dec 12 peter 79
2883 03 Dec 12 peter 80     /**
2883 03 Dec 12 peter 81        Iterator that walks over specified region. Iterator iterates
2883 03 Dec 12 peter 82        over all BamReads in file \a in that overlap with specified
2883 03 Dec 12 peter 83        region and then it turns into an end-of-region iterator.
2883 03 Dec 12 peter 84
2883 03 Dec 12 peter 85        This function requires an index file is available, see
2883 03 Dec 12 peter 86        InBamFile::index().
2883 03 Dec 12 peter 87
2896 10 Dec 12 peter 88        All reads iterated over overlap with defined region, in other
2896 10 Dec 12 peter 89        words, iter->tid == \a tid; iter->pos() < \a end and iter->end()
2896 10 Dec 12 peter 90        > start
2896 10 Dec 12 peter 91
2883 03 Dec 12 peter 92        \param in file to iterate over
2883 03 Dec 12 peter 93        \param tid segment (chromosome) to iterate over
2883 03 Dec 12 peter 94        \param start left most position of specified region
2883 03 Dec 12 peter 95        \param end right most position of specified region
4273 24 Jan 23 peter 96
4273 24 Jan 23 peter 97        \see For use with large chromosomes for with \c int32_t is not
4273 24 Jan 23 peter 98        sufficient, see BamReadIterator(InBamFile&, const BamRegion&);
2883 03 Dec 12 peter 99      */
2883 03 Dec 12 peter 100     BamReadIterator(InBamFile& in, int32_t tid, int32_t start, int32_t end);
3672 31 Jul 17 peter 101
3672 31 Jul 17 peter 102     /**
3672 31 Jul 17 peter 103        Iterator that walks from tid:start to end of chromosome and
3672 31 Jul 17 peter 104        then it turns into an end-of-region iterator.
3672 31 Jul 17 peter 105
3672 31 Jul 17 peter 106        This function requires an index file is available, see
3672 31 Jul 17 peter 107        InBamFile::index().
3672 31 Jul 17 peter 108
3672 31 Jul 17 peter 109        All reads iterated over overlap with defined region, in other
3672 31 Jul 17 peter 110        words, iter->tid == \a tid; iter->end() > start
3672 31 Jul 17 peter 111
3672 31 Jul 17 peter 112        \param in file to iterate over
3672 31 Jul 17 peter 113        \param tid segment (chromosome) to iterate over
3672 31 Jul 17 peter 114        \param start left most position of specified region
3672 31 Jul 17 peter 115
3672 31 Jul 17 peter 116        \since New in yat 0.15
4273 24 Jan 23 peter 117
4273 24 Jan 23 peter 118        \see For use with large chromosomes for with \c int32_t is not
4273 24 Jan 23 peter 119        sufficient, see BamReadIterator(InBamFile&, const BamRegion&);
3672 31 Jul 17 peter 120      */
3672 31 Jul 17 peter 121     BamReadIterator(InBamFile& in, int32_t tid, int32_t start=0);
4272 24 Jan 23 peter 122
4272 24 Jan 23 peter 123     /**
4273 24 Jan 23 peter 124        Iterator that walks over specified region. Iterator iterates
4273 24 Jan 23 peter 125        over all BamReads in file \a in that overlap with specified
4273 24 Jan 23 peter 126        region and then it turns into an end-of-region iterator.
4273 24 Jan 23 peter 127
4273 24 Jan 23 peter 128        This function requires an index file is available, see
4273 24 Jan 23 peter 129        InBamFile::index().
4273 24 Jan 23 peter 130
4273 24 Jan 23 peter 131        All reads iterated over overlap with defined region, in other
4273 24 Jan 23 peter 132        words, iter->tid == \a tid; iter->pos() < \a end and iter->end()
4273 24 Jan 23 peter 133        > start
4273 24 Jan 23 peter 134
4273 24 Jan 23 peter 135        \param in file to iterate over
4273 24 Jan 23 peter 136        \param region defining the genomic region
4273 24 Jan 23 peter 137
4273 24 Jan 23 peter 138        \since New in yat 0.21
4273 24 Jan 23 peter 139      */
4273 24 Jan 23 peter 140     BamReadIterator(InBamFile& in, const BamRegion& region);
4273 24 Jan 23 peter 141
4273 24 Jan 23 peter 142     /**
4272 24 Jan 23 peter 143        Create an iterator that can be used to iterate over reads from
4272 24 Jan 23 peter 144        multiple regions. The reads are iterated over in a sorted
4272 24 Jan 23 peter 145        fashion and reads are not multiple times even if \c regions is
4272 24 Jan 23 peter 146        sorted and/or have overlapping regions.
4272 24 Jan 23 peter 147
4272 24 Jan 23 peter 148        \since New in yat 0.21
4272 24 Jan 23 peter 149      */
4272 24 Jan 23 peter 150     BamReadIterator(InBamFile& in, const std::vector<BamRegion>& regions);
2883 03 Dec 12 peter 151   private:
2883 03 Dec 12 peter 152     friend class boost::iterator_core_access;
2883 03 Dec 12 peter 153     BamReadIterator::reference dereference(void) const;
2883 03 Dec 12 peter 154     bool equal(const BamReadIterator& other) const;
2883 03 Dec 12 peter 155     void increment(void);
2883 03 Dec 12 peter 156
4011 22 Oct 20 peter 157
2896 10 Dec 12 peter 158     /*
2883 03 Dec 12 peter 159        Interface class for the actor that handles difference between
2883 03 Dec 12 peter 160        an iterator that iterates the entire file and one that uses
2883 03 Dec 12 peter 161        index to iterate over a specific region.
2883 03 Dec 12 peter 162      */
2883 03 Dec 12 peter 163     class Actor
2883 03 Dec 12 peter 164     {
2883 03 Dec 12 peter 165     public:
2883 03 Dec 12 peter 166       explicit Actor(InBamFile*);
2883 03 Dec 12 peter 167       virtual ~Actor(void);
2883 03 Dec 12 peter 168       virtual void increment(void)=0;
2883 03 Dec 12 peter 169       InBamFile* in_;
2883 03 Dec 12 peter 170       BamRead read_;
2883 03 Dec 12 peter 171     };
2883 03 Dec 12 peter 172
2896 10 Dec 12 peter 173     // class used when region is entire file
2883 03 Dec 12 peter 174     class AllActor : public Actor
2883 03 Dec 12 peter 175     {
2883 03 Dec 12 peter 176     public:
2883 03 Dec 12 peter 177       AllActor(void);
2883 03 Dec 12 peter 178       explicit AllActor(InBamFile&);
2883 03 Dec 12 peter 179       void increment(void);
2883 03 Dec 12 peter 180     };
2883 03 Dec 12 peter 181
4011 22 Oct 20 peter 182     // functor calling bam_itr_destroy
4011 22 Oct 20 peter 183     struct IndexDestroyer
4011 22 Oct 20 peter 184     {
4011 22 Oct 20 peter 185       void operator()(hts_itr_t* i) const;
4011 22 Oct 20 peter 186     };
4011 22 Oct 20 peter 187
4272 24 Jan 23 peter 188     class RegListDestroyer
4272 24 Jan 23 peter 189     {
4272 24 Jan 23 peter 190     public:
4272 24 Jan 23 peter 191       RegListDestroyer(size_t n);
4272 24 Jan 23 peter 192       void operator()(hts_reglist_t* r) const;
4272 24 Jan 23 peter 193     private:
4272 24 Jan 23 peter 194       size_t n_;
4272 24 Jan 23 peter 195     };
4272 24 Jan 23 peter 196
2896 10 Dec 12 peter 197     // class used when iterating over a sub-region of the bam file
2883 03 Dec 12 peter 198     class IndexActor : public Actor
2883 03 Dec 12 peter 199     {
2883 03 Dec 12 peter 200     public:
4272 24 Jan 23 peter 201       IndexActor(InBamFile& in,
4272 24 Jan 23 peter 202                  std::unique_ptr<hts_itr_t, IndexDestroyer>&& iter);
2883 03 Dec 12 peter 203       void increment(void);
2883 03 Dec 12 peter 204     private:
4011 22 Oct 20 peter 205       std::unique_ptr<hts_itr_t, IndexDestroyer> iter_;
2883 03 Dec 12 peter 206     };
2883 03 Dec 12 peter 207
4011 22 Oct 20 peter 208     std::shared_ptr<Actor> actor_;
2883 03 Dec 12 peter 209
2883 03 Dec 12 peter 210   };
2883 03 Dec 12 peter 211 }}}
2883 03 Dec 12 peter 212 #endif

Generated on Sat Oct 14 02:22:43 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)