geotrellis.raster.op.focal

FocalOperation1

abstract class FocalOperation1[A, T] extends Operation[T] with FocalOperationBase

Base class for a focal operation that takes a raster, a neighborhood, and one other argument.

T

Return type of the Operation.

Linear Supertypes
FocalOperationBase, Operation[T], Product, Equals, AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FocalOperation1
  2. FocalOperationBase
  3. Operation
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by implicitLiteral
  2. by any2stringadd
  3. by any2stringfmt
  4. by any2ArrowAssoc
  5. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FocalOperation1(r: Op[Raster], n: Op[Neighborhood], a: Op[A], analysisArea: Op[Option[RasterExtent]] = ...)

    r

    Raster the focal operation will run against.

    n

    Neighborhood to use with this focal operation.

    a

    Argument of type A.

Type Members

  1. type Args = List[Any]

    Definition Classes
    Operation
  2. type Steps = PartialFunction[Any, StepOutput[T]]

    Definition Classes
    Operation

Abstract Value Members

  1. abstract def getCalculation(r: Raster, n: Neighborhood): FocalCalculation[T] with Initialization1[A]

    Gets a calculation to be used with this focal operation for the given raster neighborhood.

    Gets a calculation to be used with this focal operation for the given raster neighborhood.

    Choosing the calculation based on on the raster and neighborhood allows flexibility in what calculation to use; if some calculations are faster for some neighborhoods (e.g., using a CellwiseCalculation for Square neighborhoods and a CursorCalculation for all other neighborhoods), or if you want to change the calculation based on the raster's data type, you can do so by returning the correct FocalCalculation from this function.

    r

    Raster that the focal calculation will run against.

    n

    Neighborhood that will be used in the focal operation.

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

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to ArrowAssoc[FocalOperation1[A, T]] 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 _run(context: Context): StepOutput[T]

    Definition Classes
    FocalOperation1Operation
  9. var analysisAreaOp: Operation[Option[RasterExtent]]

    Definition Classes
    FocalOperation1FocalOperationBase
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def canEqual(other: Any): Boolean

    Definition Classes
    FocalOperation1 → Equals
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. val debug: Boolean

    Definition Classes
    Operation
  14. def dispatch(dispatcher: ActorRef): DispatchedOperation[T]

    Definition Classes
    Operation
  15. def ensuring(cond: (FocalOperation1[A, T]) ⇒ Boolean, msg: ⇒ Any): FocalOperation1[A, T]

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

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

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

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Ensuring[FocalOperation1[A, T]] 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 filter(f: (T) ⇒ Boolean): Operation[T]

    Definition Classes
    Operation
  22. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  23. def flatMap[U](f: (T) ⇒ Operation[U]): Operation[U]

    Create a new operation with a function that takes the result of this operation and returns a new operation.

    Create a new operation with a function that takes the result of this operation and returns a new operation.

    Definition Classes
    Operation
  24. def foreach[U](f: (T) ⇒ U): Unit

    Create an operation that applies the function f to the result of this operation, but returns nothing.

    Create an operation that applies the function f to the result of this operation, but returns nothing.

    Definition Classes
    Operation
  25. def formatted(fmtstr: String): String

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

    Definition Classes
    AnyRef → Any
  27. def hashCode(): Int

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

    Definition Classes
    Any
  29. def map[U](f: (T) ⇒ U): Operation[U]

    Create a new operation that returns the result of the provided function that takes this operation's result as its argument.

    Create a new operation that returns the result of the provided function that takes this operation's result as its argument.

    Definition Classes
    Operation
  30. def name: String

    Return operation identified (class simple name).

    Return operation identified (class simple name).

    Definition Classes
    Operation
  31. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  32. val nextSteps: PartialFunction[Any, StepOutput[T]]

    Definition Classes
    FocalOperation1Operation
  33. final def notify(): Unit

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

    Definition Classes
    AnyRef
  35. def processNextSteps(args: Args): StepOutput[T]

    Definition Classes
    Operation
  36. def productArity: Int

    Definition Classes
    FocalOperation1 → Product
  37. def productElement(n: Int): Any

    Definition Classes
    FocalOperation1 → Product
  38. def productIterator: Iterator[Any]

    Definition Classes
    Product
  39. def productPrefix: String

    Definition Classes
    Product
  40. def run(context: Context): StepOutput[T]

    Execute this operation and return the result.

    Execute this operation and return the result.

    Definition Classes
    Operation
  41. def runAsync(args: Args): StepOutput[T]

    Definition Classes
    Operation
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  43. def toString(): String

    Definition Classes
    AnyRef → Any
  44. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  47. def withResult[U](f: (T) ⇒ Operation[U]): Operation[U]

    Create a new operation with a function that takes the result of this operation and returns a new operation.

    Create a new operation with a function that takes the result of this operation and returns a new operation.

    Same as flatMap.

    Definition Classes
    Operation
  48. def [B](y: B): (FocalOperation1[A, T], B)

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

Shadowed Implict Value Members

  1. def canEqual(that: Any): Boolean

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).canEqual(that)
    Definition Classes
    Equals
  2. val debug: Boolean

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).debug
    Definition Classes
    Operation
  3. def dispatch(dispatcher: ActorRef): DispatchedOperation[FocalOperation1[A, T]]

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).dispatch(dispatcher)
    Definition Classes
    Operation
  4. def filter(f: (FocalOperation1[A, T]) ⇒ Boolean): Operation[FocalOperation1[A, T]]

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).filter(f)
    Definition Classes
    Operation
  5. def flatMap[U](f: (FocalOperation1[A, T]) ⇒ Operation[U]): Operation[U]

    Create a new operation with a function that takes the result of this operation and returns a new operation.

    Create a new operation with a function that takes the result of this operation and returns a new operation.

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).flatMap(f)
    Definition Classes
    Operation
  6. def foreach[U](f: (FocalOperation1[A, T]) ⇒ U): Unit

    Create an operation that applies the function f to the result of this operation, but returns nothing.

    Create an operation that applies the function f to the result of this operation, but returns nothing.

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).foreach(f)
    Definition Classes
    Operation
  7. def map[U](f: (FocalOperation1[A, T]) ⇒ U): Operation[U]

    Create a new operation that returns the result of the provided function that takes this operation's result as its argument.

    Create a new operation that returns the result of the provided function that takes this operation's result as its argument.

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).map(f)
    Definition Classes
    Operation
  8. def name: String

    Return operation identified (class simple name).

    Return operation identified (class simple name).

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).name
    Definition Classes
    Operation
  9. val nextSteps: PartialFunction[Any, StepOutput[FocalOperation1[A, T]]]

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).nextSteps
    Definition Classes
    Operation
  10. def processNextSteps(args: List[Any]): StepOutput[FocalOperation1[A, T]]

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).processNextSteps(args)
    Definition Classes
    Operation
  11. def productArity: Int

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).productArity
    Definition Classes
    Product
  12. def productElement(n: Int): Any

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).productElement(n)
    Definition Classes
    Product
  13. def productIterator: Iterator[Any]

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).productIterator
    Definition Classes
    Product
  14. def productPrefix: String

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).productPrefix
    Definition Classes
    Product
  15. def run(context: Context): StepOutput[FocalOperation1[A, T]]

    Execute this operation and return the result.

    Execute this operation and return the result.

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).run(context)
    Definition Classes
    Operation
  16. def runAsync(args: List[Any]): StepOutput[FocalOperation1[A, T]]

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).runAsync(args)
    Definition Classes
    Operation
  17. val self: Any

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] 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:
    (focalOperation1: StringAdd).self
    Definition Classes
    StringAdd
  18. val self: Any

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] 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:
    (focalOperation1: StringFormat).self
    Definition Classes
    StringFormat
  19. def withResult[U](f: (FocalOperation1[A, T]) ⇒ Operation[U]): Operation[U]

    Create a new operation with a function that takes the result of this operation and returns a new operation.

    Create a new operation with a function that takes the result of this operation and returns a new operation.

    Same as flatMap.

    Implicit information
    This member is added by an implicit conversion from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]] performed by method implicitLiteral in geotrellis.Operation. This conversion will take place only if an implicit value of type Manifest[FocalOperation1[A, T]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (focalOperation1: Operation[FocalOperation1[A, T]]).withResult(f)
    Definition Classes
    Operation

Deprecated Value Members

  1. def x: FocalOperation1[A, T]

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: FocalOperation1[A, T]

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from FocalOperationBase

Inherited from Operation[T]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion implicitLiteral from FocalOperation1[A, T] to Operation[FocalOperation1[A, T]]

Inherited by implicit conversion any2stringadd from FocalOperation1[A, T] to StringAdd

Inherited by implicit conversion any2stringfmt from FocalOperation1[A, T] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from FocalOperation1[A, T] to ArrowAssoc[FocalOperation1[A, T]]

Inherited by implicit conversion any2Ensuring from FocalOperation1[A, T] to Ensuring[FocalOperation1[A, T]]

Ungrouped