geotrellis

BitArrayRasterData

final case class BitArrayRasterData(array: Array[Byte], cols: Int, rows: Int) extends MutableRasterData with IntBasedArray with Product with Serializable

RasterData based on an Array[Byte] as a bitmask; values are 0 and 1. Thus, there are 8 boolean (0/1) values per byte in the array. For example, Array(11, 9) corresponds to (0 0 0 0 1 0 1 1), (0 0 0 0 1 0 0 1) which means that we have 5 cells set to 1 and 11 cells set to 0.

Note that unlike the other array-based raster data objects we need to be explicitly told our size, since length=7 and length=8 will both need to allocate an Array[Byte] with length=1.

Linear Supertypes
Product, Equals, IntBasedArray, MutableRasterData, StrictRasterData, Serializable, Serializable, ArrayRasterData, RasterData, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BitArrayRasterData
  2. Product
  3. Equals
  4. IntBasedArray
  5. MutableRasterData
  6. StrictRasterData
  7. Serializable
  8. Serializable
  9. ArrayRasterData
  10. RasterData
  11. AnyRef
  12. 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 BitArrayRasterData(array: Array[Byte], cols: Int, rows: 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 BitArrayRasterData to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (BitArrayRasterData, B)

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to ArrowAssoc[BitArrayRasterData] 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. def alloc(cols: Int, rows: Int): BitArrayRasterData

    Definition Classes
    BitArrayRasterData → RasterData

  9. def apply(i: Int): Int

    Definition Classes
    BitArrayRasterData → IntBasedArray → ArrayRasterData

  10. def applyDouble(i: Int): Double

    Definition Classes
    IntBasedArray

  11. val array: Array[Byte]

  12. def asArray: Option[ArrayRasterData]

    Return the current RasterData as an array.

    Return the current RasterData as an array.

    Definition Classes
    ArrayRasterData → RasterData

  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  14. def clone(): AnyRef

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

  15. val cols: Int

    Definition Classes
    BitArrayRasterData → RasterData

  16. def combine(rhs: RasterData)(f: (Int, Int) ⇒ Int): RasterData

    Combine two RasterData's cells into new cells using the given integer function.

    Combine two RasterData's cells into new cells using the given integer function. For every (x,y) cell coordinate, get each RasterData's integer value, map them to a new value, and assign it to the output's (x,y) cell.

    Definition Classes
    StrictRasterData → RasterData

  17. def combineDouble(rhs: RasterData)(f: (Double, Double) ⇒ Double): RasterData

    Combine two RasterData's cells into new cells using the given double function.

    Combine two RasterData's cells into new cells using the given double function. For every (x,y) cell coordinate, get each RasterData's double value, map them to a new value, and assign it to the output's (x,y) cell.

    Definition Classes
    StrictRasterData → RasterData

  18. def convert(typ: RasterType): ArrayRasterData

    Definition Classes
    ArrayRasterData → RasterData

  19. def copy: BitArrayRasterData

    Definition Classes
    BitArrayRasterData → RasterData

  20. def ensuring(cond: (BitArrayRasterData) ⇒ Boolean, msg: ⇒ Any): BitArrayRasterData

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to Ensuring[BitArrayRasterData] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  21. def ensuring(cond: (BitArrayRasterData) ⇒ Boolean): BitArrayRasterData

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to Ensuring[BitArrayRasterData] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  22. def ensuring(cond: Boolean, msg: ⇒ Any): BitArrayRasterData

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to Ensuring[BitArrayRasterData] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  23. def ensuring(cond: Boolean): BitArrayRasterData

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to Ensuring[BitArrayRasterData] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  25. def equals(other: Any): Boolean

    Definition Classes
    ArrayRasterData → AnyRef → Any

  26. def finalize(): Unit

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

  27. def force: Option[StrictRasterData]

    Return the current RasterData values as a strict (calculated) ArrayRasterData.

    Return the current RasterData values as a strict (calculated) ArrayRasterData.

    If your RasterData cannot be represented as an array, bad things will happen. If your RasterData is lazy, any deferred calculations will be executed.

    Definition Classes
    StrictRasterData → RasterData

  28. def foreach(f: (Int) ⇒ Unit): Unit

    For every cell in the given raster, run the given integer function.

    For every cell in the given raster, run the given integer function.

    The order of the traversal from the lowest to highest columns, across each row, but this should probably not be relied upon. In the future we'd like to be able to parallelize foreach.

    Definition Classes
    StrictRasterData → RasterData

  29. def foreachDouble(f: (Double) ⇒ Unit): Unit

    For every cell in the given raster, run the given double function.

    For every cell in the given raster, run the given double function.

    The order of the traversal from the lowest to highest columns, across each row, but this should probably not be relied upon. In the future we'd like to be able to parallelize foreach.

    Definition Classes
    StrictRasterData → RasterData

  30. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  31. def get(col: Int, row: Int): Int

    Get a particular (x, y) cell's integer value.

    Get a particular (x, y) cell's integer value.

    Definition Classes
    ArrayRasterData → RasterData

  32. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  33. def getDouble(col: Int, row: Int): Double

    Get a particular (x, y) cell's double value.

    Get a particular (x, y) cell's double value.

    Definition Classes
    ArrayRasterData → RasterData

  34. def getType: TypeBit.type

    Definition Classes
    BitArrayRasterData → RasterData

  35. def isFloat: Boolean

    Definition Classes
    RasterData

  36. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  37. def length: Int

    Definition Classes
    BitArrayRasterData → RasterData

  38. def lengthLong: Long

    Definition Classes
    ArrayRasterData → RasterData

  39. def map(f: (Int) ⇒ Int): BitArrayRasterData

    Map each cell in the given raster to a new one, using the given function.

    Map each cell in the given raster to a new one, using the given function.

    Definition Classes
    BitArrayRasterData → StrictRasterData → RasterData

  40. def mapDouble(f: (Double) ⇒ Double): BitArrayRasterData

    Map each cell in the given raster to a new one, using the given function.

    Map each cell in the given raster to a new one, using the given function.

    Definition Classes
    BitArrayRasterData → StrictRasterData → RasterData

  41. def mapIfSet(f: (Int) ⇒ Int): BitArrayRasterData

    Similar to map, except that this method passes through "nodata" cells without calling the provided function.

    Similar to map, except that this method passes through "nodata" cells without calling the provided function.

    Definition Classes
    BitArrayRasterData → StrictRasterData → RasterData

  42. def mapIfSetDouble(f: (Double) ⇒ Double): BitArrayRasterData

    Similar to map, except that this method passes through "nodata" cells without calling the provided function.

    Similar to map, except that this method passes through "nodata" cells without calling the provided function.

    Definition Classes
    BitArrayRasterData → StrictRasterData → RasterData

  43. def mutable: Option[MutableRasterData]

    Return a mutable version of the current raster.

    Return a mutable version of the current raster.

    Definition Classes
    MutableRasterData → RasterData

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

    Definition Classes
    AnyRef

  45. final def notify(): Unit

    Definition Classes
    AnyRef

  46. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  47. val rows: Int

    Definition Classes
    BitArrayRasterData → RasterData

  48. def set(col: Int, row: Int, value: Int): Unit

    Definition Classes
    MutableRasterData

  49. def setDouble(col: Int, row: Int, value: Double): Unit

    Definition Classes
    MutableRasterData

  50. val size: Int

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

    Definition Classes
    AnyRef

  52. def toArray: Array[Int]

    Definition Classes
    ArrayRasterData

  53. def toArrayDouble: Array[Double]

    Definition Classes
    ArrayRasterData

  54. def toList: List[Int]

    Definition Classes
    ArrayRasterData

  55. def toListDouble: List[Double]

    Definition Classes
    ArrayRasterData

  56. def update(i: Int, z: Int): Unit

    Definition Classes
    BitArrayRasterData → IntBasedArray → MutableRasterData

  57. def updateDouble(i: Int, z: Double): Unit

    Definition Classes
    IntBasedArray

  58. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  60. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  61. def →[B](y: B): (BitArrayRasterData, B)

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to ArrowAssoc[BitArrayRasterData] 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 BitArrayRasterData 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:
    (bitArrayRasterData: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData 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:
    (bitArrayRasterData: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: BitArrayRasterData

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to ArrowAssoc[BitArrayRasterData] 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:
    (bitArrayRasterData: ArrowAssoc[BitArrayRasterData]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: BitArrayRasterData

    Implicit information
    This member is added by an implicit conversion from BitArrayRasterData to Ensuring[BitArrayRasterData] 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:
    (bitArrayRasterData: Ensuring[BitArrayRasterData]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Product

Inherited from Equals

Inherited from IntBasedArray

Inherited from MutableRasterData

Inherited from StrictRasterData

Inherited from Serializable

Inherited from Serializable

Inherited from ArrayRasterData

Inherited from RasterData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BitArrayRasterData to StringAdd

Inherited by implicit conversion any2stringfmt from BitArrayRasterData to StringFormat

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

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

Ungrouped