org.bdgenomics.adam.models

ReferenceRegion

case class ReferenceRegion(referenceName: String, start: Long, end: Long, orientation: Strand = Strand.Independent) extends Comparable[ReferenceRegion] with Interval with Product with Serializable

Represents a contiguous region of the reference genome.

referenceName

The name of the sequence (chromosome) in the reference genome

start

The 0-based residue-coordinate for the start of the region

end

The 0-based residue-coordinate for the first residue after the start which is not in the region -- i.e. [start, end) define a 0-based half-open interval.

Linear Supertypes
Serializable, Serializable, Product, Equals, Interval, Comparable[ReferenceRegion], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ReferenceRegion
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Interval
  7. Comparable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ReferenceRegion(referenceName: String, start: Long, end: Long, orientation: Strand = Strand.Independent)

    referenceName

    The name of the sequence (chromosome) in the reference genome

    start

    The 0-based residue-coordinate for the start of the region

    end

    The 0-based residue-coordinate for the first residue after the start which is not in the region -- i.e. [start, end) define a 0-based half-open interval.

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def compareTo(that: ReferenceRegion): Int

    Definition Classes
    ReferenceRegion → Comparable
  7. def contains(other: ReferenceRegion): Boolean

  8. def contains(other: ReferencePosition): Boolean

  9. def disorient: ReferenceRegion

  10. def distance(other: ReferenceRegion): Option[Long]

    Returns the distance between this reference region and another region in the reference space.

    Returns the distance between this reference region and another region in the reference space.

    other

    Region to compare against.

    returns

    Returns an option containing the distance between two points. If the point is not in our reference space, we return an empty option (None).

    Note

    Distance here is defined as the minimum distance between any point within this region, and any point within the other region we are measuring against. If the two sets overlap, the distance will be 0. If the sets abut, the distance will be 1. Else, the distance will be greater.

  11. val end: Long

    The 0-based residue-coordinate for the first residue after the start which is not in the region -- i.e.

    The 0-based residue-coordinate for the first residue after the start which is not in the region -- i.e. [start, end) define a 0-based half-open interval.

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  15. def hull(region: ReferenceRegion): ReferenceRegion

    Creates a region corresponding to the convex hull of two regions.

    Creates a region corresponding to the convex hull of two regions. Has no preconditions about the adjacency or overlap of two regions. However, regions must be in the same reference space.

    region

    Other region to compute hull of with this region.

    returns

    The convex hull of both unions.

    Exceptions thrown
    AssertionError

    Thrown if regions are in different reference spaces.

    See also

    merge

  16. def intersection(region: ReferenceRegion): ReferenceRegion

    Calculates the intersection of two reference regions.

    Calculates the intersection of two reference regions.

    region

    Region to intersect with.

    returns

    A smaller reference region.

  17. def isAdjacent(region: ReferenceRegion): Boolean

    Returns whether two regions are adjacent.

    Returns whether two regions are adjacent. Adjacent regions do not overlap, but have no separation between start/end.

    region

    Region to compare against.

    returns

    True if regions are adjacent.

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. def length(): Long

  20. def merge(region: ReferenceRegion): ReferenceRegion

    Merges two reference regions that are contiguous.

    Merges two reference regions that are contiguous.

    region

    Other region to merge with this region.

    returns

    The merger of both unions.

    Exceptions thrown
    AssertionError

    Thrown if regions are not overlapping or adjacent.

    See also

    hull

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. val orientation: Strand

  25. def overlaps(other: ReferenceRegion): Boolean

  26. val referenceName: String

    The name of the sequence (chromosome) in the reference genome

  27. val start: Long

    The 0-based residue-coordinate for the start of the region

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def width: Long

    A width is the key property of an interval, which can represent a genomic region, a transcript, a gene, etc.

    A width is the key property of an interval, which can represent a genomic region, a transcript, a gene, etc.

    returns

    The width of this interval.

    Definition Classes
    ReferenceRegionInterval

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Interval

Inherited from Comparable[ReferenceRegion]

Inherited from AnyRef

Inherited from Any

Ungrouped