geotrellis.statistics

CompressedArrayHistogram

class CompressedArrayHistogram extends ArrayHistogram

Data object representing a histogram using an array for internal storage, which requires an initial minimum and maximum val and a specified number of 'breaks' which are used to group values together into ranges.

Note

CompressedArrayHistogram can currently only handle non-negative integers.

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CompressedArrayHistogram
  2. ArrayHistogram
  3. Histogram
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CompressedArrayHistogram(counts: Array[Int], total: Int, vmin: Int, vmax: Int)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (CompressedArrayHistogram, B)

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to ArrowAssoc[CompressedArrayHistogram] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. final def compress(i: Int): Int

  11. def copy(): CompressedArrayHistogram

    Return a copy of this histogram.

    Return a copy of this histogram.

    Definition Classes
    CompressedArrayHistogramArrayHistogramHistogram
  12. def countItem(i: Int, count: Int = 1): Unit

    Note the occurance of 'item.

    Note the occurance of 'item.

    The optional parameter 'count' allows histograms to be built more efficiently. Negative counts can be used to remove a particular number of occurances of 'item'.

    Definition Classes
    CompressedArrayHistogramArrayHistogramHistogram
  13. final def decompress(i: Int): Int

  14. val divisor: Int

  15. def ensuring(cond: (CompressedArrayHistogram) ⇒ Boolean, msg: ⇒ Any): CompressedArrayHistogram

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to Ensuring[CompressedArrayHistogram] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (CompressedArrayHistogram) ⇒ Boolean): CompressedArrayHistogram

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to Ensuring[CompressedArrayHistogram] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): CompressedArrayHistogram

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to Ensuring[CompressedArrayHistogram] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): CompressedArrayHistogram

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to Ensuring[CompressedArrayHistogram] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  22. def foreach(f: (Int, Int) ⇒ Unit): Unit

    Definition Classes
    Histogram
  23. def foreachValue(f: (Int) ⇒ Unit): Unit

  24. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. def generateStatistics(): Statistics

    Definition Classes
    Histogram
  26. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  27. def getEvenQuantiles(num: Int): Array[Double]

    Return 'num' evenly spaced Doubles from 0.

    Return 'num' evenly spaced Doubles from 0.0 to 1.0.

    Definition Classes
    Histogram
  28. def getItemCount(i: Int): Int

    Return the number of occurances for 'item'.

    Return the number of occurances for 'item'.

    Definition Classes
    CompressedArrayHistogramArrayHistogramHistogram
  29. def getMaxValue(): Int

    Return the largest item seen.

    Return the largest item seen.

    Definition Classes
    CompressedArrayHistogramArrayHistogramHistogram
  30. def getMean(): Double

    Definition Classes
    Histogram
  31. def getMedian(): Int

    Definition Classes
    Histogram
  32. def getMinMaxValues(): (Int, Int)

    Return the smallest and largest items seen as a tuple.

    Return the smallest and largest items seen as a tuple.

    Definition Classes
    Histogram
  33. def getMinValue(): Int

    Return the smallest item seen.

    Return the smallest item seen.

    Definition Classes
    CompressedArrayHistogramArrayHistogramHistogram
  34. def getMode(): Int

    Definition Classes
    Histogram
  35. def getQuantileBreaks(num: Int): Array[Int]

    Definition Classes
    Histogram
  36. def getTotalCount(): Int

    Return the total number of occurances for all items.

    Return the total number of occurances for all items.

    Definition Classes
    ArrayHistogramHistogram
  37. def getValues(): Array[Int]

  38. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  39. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  40. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  41. def normalizeExtremeValues(num: Int, cutoff: Int): Histogram

    This is a heuristic used by getQuantileBreaks, which mutates the histogram.

    This is a heuristic used by getQuantileBreaks, which mutates the histogram.

    Definition Classes
    Histogram
  42. final def notify(): Unit

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

    Definition Classes
    AnyRef
  44. def rawValues(): Array[Int]

  45. def setItem(i: Int, count: Int): Unit

  46. def size: Int

    Definition Classes
    ArrayHistogram
  47. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  48. def toJSON: String

    Definition Classes
    Histogram
  49. def toString(): String

    Definition Classes
    AnyRef → Any
  50. def uncountItem(i: Int): Unit

    Forget all occurances of 'item'.

    Forget all occurances of 'item'.

    Definition Classes
    CompressedArrayHistogramArrayHistogramHistogram
  51. def update(other: Histogram): Unit

    Definition Classes
    Histogram
  52. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  55. def [B](y: B): (CompressedArrayHistogram, B)

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to ArrowAssoc[CompressedArrayHistogram] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (compressedArrayHistogram: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (compressedArrayHistogram: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: CompressedArrayHistogram

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to ArrowAssoc[CompressedArrayHistogram] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (compressedArrayHistogram: ArrowAssoc[CompressedArrayHistogram]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: CompressedArrayHistogram

    Implicit information
    This member is added by an implicit conversion from CompressedArrayHistogram to Ensuring[CompressedArrayHistogram] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (compressedArrayHistogram: Ensuring[CompressedArrayHistogram]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from ArrayHistogram

Inherited from Histogram

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CompressedArrayHistogram to StringAdd

Inherited by implicit conversion any2stringfmt from CompressedArrayHistogram to StringFormat

Inherited by implicit conversion any2ArrowAssoc from CompressedArrayHistogram to ArrowAssoc[CompressedArrayHistogram]

Inherited by implicit conversion any2Ensuring from CompressedArrayHistogram to Ensuring[CompressedArrayHistogram]

Ungrouped