class HTS::Bam::Pileup

• HTS::Bam::Pileup
• Reference
• Object

Overview

High-level pileup iterator over a single BAM/CRAM input. Yields Column objects with tid, pos, and alignments at each position.

Included Modules

• Enumerable(HTS::Bam::Pileup::Column)

Defined in:

hts/bam/pileup.cr

Constructors

• .new(bam : Bam, region : String | Nil = nil, maxcnt : Int32 | Nil = nil)

  Create a Pileup iterator @param bam [HTS::Bam] @param region [String, nil] Optional region string (e.g., "chr1:1000-2000", requires index) @param maxcnt [Int32, nil] Max per-position depth (capped)

Class Method Summary

• .open(bam : Bam, region : String | Nil = nil, maxcnt : Int32 | Nil = nil, &)

  Open a Pileup iterator with block (RAII style)

Instance Method Summary

• #close : Nil

  Release native resources

• #each(&block : Column -> ) : Nil

  Iterate over pileup columns

• #finalize
• #reset : Nil

  Reset internal state, if needed by the caller

Constructor Detail

Class Method Detail

Instance Method Detail