geotrellis.raster.op.focal

Circle

case class Circle(radius: Double) extends Neighborhood with Product with Serializable

A circle neighborhood.

radius

Radius of the circle that defines which cells inside the bounding box will be considered part of the neighborhood.

Note

Cells who's distance from the center is exactly the radius are included in the neighborhood.

Linear Supertypes
Serializable, Serializable, Product, Equals, Neighborhood, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Circle
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Neighborhood
  7. AnyRef
  8. 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 Circle(radius: Double)

    radius

    Radius of the circle that defines which cells inside the bounding box will be considered part of the neighborhood.

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 Circle to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Circle, B)

    Implicit information
    This member is added by an implicit conversion from Circle to ArrowAssoc[Circle] 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. def ensuring(cond: (Circle) ⇒ Boolean, msg: ⇒ Any): Circle

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

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

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

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

    Definition Classes
    AnyRef
  15. val extent: Int

    How many cells past the focus the bounding box goes.

    How many cells past the focus the bounding box goes. (e.g., 1 for 9x9 square)

    Definition Classes
    CircleNeighborhood
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Circle to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. val hasMask: Boolean

    Whether or not this neighborhood has a mask the cursor of it's bounding box

    Whether or not this neighborhood has a mask the cursor of it's bounding box

    Definition Classes
    CircleNeighborhood
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def mask(x: Int, y: Int): Boolean

    Overridden to define the mask of Neighborhoods that have one

    Overridden to define the mask of Neighborhoods that have one

    Definition Classes
    CircleNeighborhood
  22. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  25. val radius: Double

    Radius of the circle that defines which cells inside the bounding box will be considered part of the neighborhood.

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

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

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

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

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

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

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

Deprecated Value Members

  1. def x: Circle

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Circle

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Neighborhood

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Circle to StringAdd

Inherited by implicit conversion any2stringfmt from Circle to StringFormat

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

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

Ungrouped