API Reference#
This page provides a full API overview of the BandHiC module, including the core band_hic_matrix class and its utilities.
The bandhic module defines data structures and utilities for efficiently storing and manipulating Hi-C contact matrices in a banded form. It enables NumPy-compatible operations, matrix masking, diagonal reduction, file I/O, and domain-level interaction analysis.
Core components:
band_hic_matrix: A memory-efficient matrix class supporting banded Hi-C data.
Utility functions: loaders (cooler_chr) and constructors (ones, zeros, etc.).
- band_hic_matrix Class
- Creation Functions
- Input/Output Functions
- Vectorized operations for BandHiC matrices
- bandhic.absolute
- bandhic.add
- bandhic.arccos
- bandhic.arccosh
- bandhic.arcsin
- bandhic.arcsinh
- bandhic.arctan
- bandhic.arctan2
- bandhic.arctanh
- bandhic.bitwise_and
- bandhic.bitwise_or
- bandhic.bitwise_xor
- bandhic.cbrt
- bandhic.conj
- bandhic.conjugate
- bandhic.cos
- bandhic.cosh
- bandhic.deg2rad
- bandhic.degrees
- bandhic.divide
- bandhic.divmod
- bandhic.equal
- bandhic.exp
- bandhic.exp2
- bandhic.expm1
- bandhic.fabs
- bandhic.float_power
- bandhic.floor_divide
- bandhic.fmod
- bandhic.gcd
- bandhic.greater
- bandhic.greater_equal
- bandhic.heaviside
- bandhic.hypot
- bandhic.invert
- bandhic.lcm
- bandhic.left_shift
- bandhic.less
- bandhic.less_equal
- bandhic.log
- bandhic.log1p
- bandhic.log2
- bandhic.log10
- bandhic.logaddexp
- bandhic.logaddexp2
- bandhic.logical_and
- bandhic.logical_or
- bandhic.logical_xor
- bandhic.maximum
- bandhic.minimum
- bandhic.mod
- bandhic.multiply
- bandhic.negative
- bandhic.not_equal
- bandhic.positive
- bandhic.power
- bandhic.rad2deg
- bandhic.radians
- bandhic.reciprocal
- bandhic.remainder
- bandhic.right_shift
- bandhic.rint
- bandhic.sign
- bandhic.sin
- bandhic.sinh
- bandhic.sqrt
- bandhic.square
- bandhic.subtract
- bandhic.tan
- bandhic.tanh
- bandhic.true_divide
- Data Reduction and Normalization
- Other Functions