Packages

case class SH(sh: DenseVector[Double]) extends SphericalFunction[Double] with Product with Serializable

SH expansion of a spherical function.

sh

The SH coefficients for the expansion. Must contain n² (n > 0) elements.

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

Instance Constructors

  1. new SH(sh: DenseVector[Double])

    sh

    The SH coefficients for the expansion. Must contain n² (n > 0) elements.

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.

  7. def apply(theta: Double, phi: Double): Double
    Definition Classes
    SphericalFunction → Function2
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def average: Double

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

  10. def bands: Int

    The number of SH bands that this expansion uses.

  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def compose[A](g: (A) ⇒ Vector3D): (A) ⇒ Double
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  13. def curried: (Double) ⇒ (Double) ⇒ Double
    Definition Classes
    Function2
    Annotations
    @unspecialized()
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. 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.

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. 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.

  22. final def notify(): Unit
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  24. 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
  25. 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
  26. val sh: DenseVector[Double]
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  29. def tupled: ((Double, Double)) ⇒ Double
    Definition Classes
    Function2
    Annotations
    @unspecialized()
  30. def valueAt(v: Vector3D): Double

    Evaluates this SH expansion for the specified direction.

  31. def valueAt(v: Vector[_3D]): Double

    Evaluates this SH expansion for the specified direction.

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

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