geotrellis.raster.op.focal

DirectHillshade

case class DirectHillshade(r: Op[Raster], azimuth: Op[Double], altitude: Op[Double], zFactor: Op[Double]) extends FocalOp3[Double, Double, Double, Raster] with HasAnalysisArea[DirectHillshade] with Product with Serializable

Direct calculation of hill shading of a raster. Construct through the Hillshade object.

See also

Hillshade

Linear Supertypes
Serializable, Serializable, HasAnalysisArea[DirectHillshade], Cloneable, Cloneable, FocalOp3[Double, Double, Double, Raster], FocalOperation3[Double, Double, Double, Raster], FocalOperationBase, Operation[Raster], Product, Equals, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DirectHillshade
  2. Serializable
  3. Serializable
  4. HasAnalysisArea
  5. Cloneable
  6. Cloneable
  7. FocalOp3
  8. FocalOperation3
  9. FocalOperationBase
  10. Operation
  11. Product
  12. Equals
  13. AnyRef
  14. 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 DirectHillshade(r: Op[Raster], azimuth: Op[Double], altitude: Op[Double], zFactor: Op[Double])

Type Members

  1. type Args = List[Any]

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

    Definition Classes
    Operation

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

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to ArrowAssoc[DirectHillshade] 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[Raster]

    Definition Classes
    FocalOperation3Operation
  9. val altitude: Op[Double]

  10. var analysisAreaOp: Operation[Option[RasterExtent]]

    Definition Classes
    FocalOperation3FocalOperationBase
  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. val azimuth: Op[Double]

  13. def canEqual(other: Any): Boolean

    Definition Classes
    FocalOperation3 → Equals
  14. def clone(): AnyRef

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

    Definition Classes
    Operation
  16. def dispatch(dispatcher: ActorRef): DispatchedOperation[Raster]

    Definition Classes
    Operation
  17. def ensuring(cond: (DirectHillshade) ⇒ Boolean, msg: ⇒ Any): DirectHillshade

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

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

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

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

    Definition Classes
    AnyRef
  22. def filter(f: (Raster) ⇒ Boolean): Operation[Raster]

    Definition Classes
    Operation
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  24. def flatMap[U](f: (Raster) ⇒ 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
  25. def foreach[U](f: (Raster) ⇒ 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
  26. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  27. def getCalculation(r: Raster, n: Neighborhood): FocalCalculation[Raster] with Initialization3[Double, Double, Double]

    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.

    Definition Classes
    FocalOp3FocalOperation3
  28. final def getClass(): Class[_]

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

    Definition Classes
    Any
  30. def makeClone(): DirectHillshade

    Definition Classes
    HasAnalysisArea
  31. def map[U](f: (Raster) ⇒ 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
  32. def name: String

    Return operation identified (class simple name).

    Return operation identified (class simple name).

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

    Definition Classes
    AnyRef
  34. val nextSteps: PartialFunction[Any, StepOutput[Raster]]

    Definition Classes
    FocalOperation3Operation
  35. final def notify(): Unit

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

    Definition Classes
    AnyRef
  37. def processNextSteps(args: Args): StepOutput[Raster]

    Definition Classes
    Operation
  38. def productArity: Int

    Definition Classes
    FocalOperation3 → Product
  39. def productElement(n: Int): Any

    Definition Classes
    FocalOperation3 → Product
  40. def productIterator: Iterator[Any]

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    Definition Classes
    Product
  41. def productPrefix: String

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    Definition Classes
    Product
  42. val r: Op[Raster]

  43. def run(context: Context): StepOutput[Raster]

    Execute this operation and return the result.

    Execute this operation and return the result.

    Definition Classes
    Operation
  44. def runAsync(args: Args): StepOutput[Raster]

    Definition Classes
    Operation
  45. def setAnalysisArea(op: Operation[Option[RasterExtent]]): DirectHillshade

    Definition Classes
    HasAnalysisArea
  46. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  50. def withResult[U](f: (Raster) ⇒ 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
  51. val zFactor: Op[Double]

  52. def [B](y: B): (DirectHillshade, B)

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to ArrowAssoc[DirectHillshade] 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 DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).canEqual(that)
    Definition Classes
    Equals
  2. val debug: Boolean

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).debug
    Definition Classes
    Operation
  3. def dispatch(dispatcher: ActorRef): DispatchedOperation[DirectHillshade]

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).dispatch(dispatcher)
    Definition Classes
    Operation
  4. def filter(f: (DirectHillshade) ⇒ Boolean): Operation[DirectHillshade]

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).filter(f)
    Definition Classes
    Operation
  5. def flatMap[U](f: (DirectHillshade) ⇒ 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 DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).flatMap(f)
    Definition Classes
    Operation
  6. def foreach[U](f: (DirectHillshade) ⇒ 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 DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).foreach(f)
    Definition Classes
    Operation
  7. def map[U](f: (DirectHillshade) ⇒ 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 DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).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 DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).name
    Definition Classes
    Operation
  9. val nextSteps: PartialFunction[Any, StepOutput[DirectHillshade]]

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).nextSteps
    Definition Classes
    Operation
  10. def processNextSteps(args: List[Any]): StepOutput[DirectHillshade]

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).processNextSteps(args)
    Definition Classes
    Operation
  11. def productArity: Int

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).productArity
    Definition Classes
    Product
  12. def productElement(n: Int): Any

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).productElement(n)
    Definition Classes
    Product
  13. def run(context: Context): StepOutput[DirectHillshade]

    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 DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).run(context)
    Definition Classes
    Operation
  14. def runAsync(args: List[Any]): StepOutput[DirectHillshade]

    Implicit information
    This member is added by an implicit conversion from DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).runAsync(args)
    Definition Classes
    Operation
  15. val self: Any

    Implicit information
    This member is added by an implicit conversion from DirectHillshade 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:
    (directHillshade: StringAdd).self
    Definition Classes
    StringAdd
  16. val self: Any

    Implicit information
    This member is added by an implicit conversion from DirectHillshade 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:
    (directHillshade: StringFormat).self
    Definition Classes
    StringFormat
  17. def withResult[U](f: (DirectHillshade) ⇒ 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 DirectHillshade to Operation[DirectHillshade] performed by method implicitLiteral in geotrellis.Operation.
    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:
    (directHillshade: Operation[DirectHillshade]).withResult(f)
    Definition Classes
    Operation

Deprecated Value Members

  1. def x: DirectHillshade

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: DirectHillshade

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Cloneable

Inherited from Cloneable

Inherited from FocalOp3[Double, Double, Double, Raster]

Inherited from FocalOperation3[Double, Double, Double, Raster]

Inherited from FocalOperationBase

Inherited from Operation[Raster]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion implicitLiteral from DirectHillshade to Operation[DirectHillshade]

Inherited by implicit conversion any2stringadd from DirectHillshade to StringAdd

Inherited by implicit conversion any2stringfmt from DirectHillshade to StringFormat

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

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

Ungrouped