org.bdgenomics.adam.models

# ReferenceRegion

###
Related Docs: object ReferenceRegion | package models

#### case class ReferenceRegion(referenceName: String, start: Long, end: Long, strand: Strand = Strand.INDEPENDENT) extends Comparable[ReferenceRegion] with Interval[ReferenceRegion] 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.

strand

  The strand of the genome that this region exists on.

Linear Supertypes
Serializable, Serializable, Product, Equals, Interval[ReferenceRegion], Comparable[ReferenceRegion], AnyRef, Any
Known Subclasses
ReferencePosition
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

Visibility

1. Public
2. All

### Instance Constructors

1. #### new ReferenceRegion(referenceName: String, start: Long, end: Long, strand: 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.

   strand

     The strand of the genome that this region exists on.

### 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

   Compares between two regions using the RegionOrdering.

   Compares between two regions using the RegionOrdering.

   that

     The region to compare against.

   returns

     An ordering depending on which region comes first.

   Definition Classes
     ReferenceRegion → Interval → Comparable

7. #### def contains(other: ReferenceRegion): Boolean

   Checks if another region is wholly within our region.

   Checks if another region is wholly within our region.

   other

     The region to compare against.

   returns

     True if the region is wholly contained within our region.

8. #### def contains(other: ReferencePosition): Boolean

   Checks if a position is wholly within our region.

   Checks if a position is wholly within our region.

   other

     The reference position to compare against.

   returns

     True if the position is within our region.

9. #### def covers(other: ReferenceRegion): Boolean

   Checks if our region overlaps (wholly or partially) another region, independent of strand.

   Checks if our region overlaps (wholly or partially) another region, independent of strand.

   other

     The region to compare against.

   returns

     True if any section of the two regions overlap.

   Definition Classes
     ReferenceRegion → Interval

10. #### def disorient: ReferenceRegion

    returns

      Returns a copy of this reference region that is on the independent strand.

11. #### 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.

    Definition Classes
      ReferenceRegion → Interval
    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.

12. #### 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.

    Definition Classes
      ReferenceRegion → Interval

13. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

14. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

15. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

16. #### def hashCode(): Int

    Definition Classes
      ReferenceRegion → AnyRef → Any

17. #### 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

18. #### 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.

19. #### 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.

20. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

21. #### def length(): Long

    returns

      The length of this region in bases.

22. #### 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

23. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

24. #### final def notify(): Unit

    Definition Classes
      AnyRef

25. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

26. #### def overlaps(other: ReferenceRegion): Boolean

    Checks if our region overlaps (wholly or partially) another region.

    Checks if our region overlaps (wholly or partially) another region.

    other

      The region to compare against.

    returns

      True if any section of the two regions overlap.

    Definition Classes
      ReferenceRegion → Interval

27. #### def pad(byStart: Long, byEnd: Long): ReferenceRegion

    Extends the current reference region at both the start and end, but by different numbers of bases.

    Extends the current reference region at both the start and end, but by different numbers of bases.

    byStart

      The number of bases to move the start position forward by.

    byEnd

      The number of bases to move the end position back by.

    returns

      Returns a new reference region where the start and/or end have been moved.

28. #### def pad(by: Long): ReferenceRegion

    Extends the current reference region at both the start and end.

    Extends the current reference region at both the start and end.

    by

      The number of bases to extend the region by from both the start and the end.

    returns

      Returns a new reference region where the start and end have been moved.

29. #### val referenceName: String

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

30. #### val start: Long

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

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

    Definition Classes
      ReferenceRegion → Interval

31. #### val strand: Strand

    The strand of the genome that this region exists on.

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

    Definition Classes
      AnyRef

33. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

34. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

35. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

36. #### def width: Long

    Definition Classes
      Interval

### Inherited from Serializable

### Inherited from Product

### Inherited from Equals

### Inherited from Interval[ReferenceRegion]

### Inherited from Comparable[ReferenceRegion]

### Inherited from AnyRef

### Inherited from Any

### Ungrouped