Packages

class ZH extends SH

A vector of SH coefficients representing a function with rotational symmetry about the z axis. Only coefficients with m = 0 are non-zero.

Linear Supertypes
SH, Serializable, Serializable, Product, Equals, SphericalFunction[Double], (Vector3D) ⇒ Double, (Double, Double) ⇒ Double, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZH
  2. SH
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. SphericalFunction
  8. Function1
  9. Function2
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed case class RotatedSphericalFunction (rotation: DenseMatrix[Double], innerFunction: SphericalFunction[A]) extends SphericalFunction[A] with Product with Serializable

    A rotated version of another spherical function such that f_new(rotation * v) = f(v) or equivalently f_new(v) = f(inv(rotation) * v)

    A rotated version of another spherical function such that f_new(rotation * v) = f(v) or equivalently f_new(v) = f(inv(rotation) * v)

    Definition Classes
    SphericalFunction

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def andThen[A](g: (Double) ⇒ A): (Vector3D) ⇒ A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  5. def apply(v: Vector3D): Double

    Evaluates this SH expansion for the specified direction.

    Evaluates this SH expansion for the specified direction.

    Definition Classes
    SHSphericalFunction → Function1
  6. def apply(v: Vector[_3D]): Double

    Evaluates this SH expansion for the specified direction.

    Evaluates this SH expansion for the specified direction.

    Definition Classes
    SH
  7. def apply(theta: Double, phi: Double): Double
    Definition Classes
    SphericalFunction → Function2
  8. lazy val asConvolution: DenseVector[Double]

    Transforms this ZH vector into a vector that performs a convolution on a SH vector if multiplied element-wise.

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def average: Double

    The first SH coefficient referring to the unweighted average of the represented funciton.

    The first SH coefficient referring to the unweighted average of the represented funciton.

    Definition Classes
    SH
  11. def bands: Int

    The number of SH bands that this expansion uses.

    The number of SH bands that this expansion uses.

    Definition Classes
    SH
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def compose[A](g: (A) ⇒ Vector3D): (A) ⇒ Double
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  14. def curried: (Double) ⇒ (Double) ⇒ Double
    Definition Classes
    Function2
    Annotations
    @unspecialized()
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def getZonalHarmonics: ZH

    Returns the rotationally symmetric (m = 0) components of this SH expansion.

    Returns the rotationally symmetric (m = 0) components of this SH expansion.

    returns

    An instance of ZH.

    Definition Classes
    ZHSH
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def map[B](f: (Double) ⇒ B): SphericalFunction[B]

    Returns the composite of this spherical function with the function provided int

    Returns the composite of this spherical function with the function provided int

    Definition Classes
    SphericalFunction
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def normalized: DenseVector[Double]

    Returns a scaled version of this spherical harmonic such that its average value over the whole sphere is 1.

    Returns a scaled version of this spherical harmonic such that its average value over the whole sphere is 1.

    returns

    A DenseVector representing a scaled version of this function with an average value of 1.

    Definition Classes
    SH
  23. final def notify(): Unit
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  25. def rotate(direction: Vector3D): DenseVector[Double]

    Efficiently rotates a vector of ZH coefficients.

    Efficiently rotates a vector of ZH coefficients. The rotation is specified by the target direction of rotational symmetry.

    direction

    New direction of rotational symmetry

    returns

    Rotated SH coefficients

  26. def rotate(rotation: Rotation3D): RotatedSphericalFunction

    Returns a rotated version of this spherical function such that f_new(rotation * v) = f(v) or equivalently f_new(v) = f(inv(rotation) * v)

    Returns a rotated version of this spherical function such that f_new(rotation * v) = f(v) or equivalently f_new(v) = f(inv(rotation) * v)

    Definition Classes
    SphericalFunction
  27. def rotate(rotation: DenseMatrix[Double]): RotatedSphericalFunction

    Returns a rotated version of this spherical function such that f_new(rotation * v) = f(v) or equivalently f_new(v) = f(inv(rotation) * v)

    Returns a rotated version of this spherical function such that f_new(rotation * v) = f(v) or equivalently f_new(v) = f(inv(rotation) * v)

    Definition Classes
    SphericalFunction
  28. val sh: DenseVector[Double]
    Definition Classes
    SH
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  31. def tupled: ((Double, Double)) ⇒ Double
    Definition Classes
    Function2
    Annotations
    @unspecialized()
  32. def valueAt(v: Vector3D): Double

    Evaluates this SH expansion for the specified direction.

    Evaluates this SH expansion for the specified direction.

    Definition Classes
    SH
  33. def valueAt(v: Vector[_3D]): Double

    Evaluates this SH expansion for the specified direction.

    Evaluates this SH expansion for the specified direction.

    Definition Classes
    SH
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def windowed(implicit shWindow: SHWindow): DenseVector[Double]
    Definition Classes
    SH

Inherited from SH

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SphericalFunction[Double]

Inherited from (Vector3D) ⇒ Double

Inherited from (Double, Double) ⇒ Double

Inherited from AnyRef

Inherited from Any

Ungrouped