DistanceFromEllipsoidSurfaceOp (BoneJ Javadocs 0-SNAPSHOT API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- net.imagej.ops.AbstractOp
- - net.imagej.ops.special.AbstractUnaryOp<I1,O>
  - - net.imagej.ops.special.AbstractBinaryOp<I1,I2,O>
    - - net.imagej.ops.special.function.AbstractBinaryFunctionOp<Ellipsoid,org.joml.Vector3dc,DoubleType>
      - org.bonej.ops.ellipsoid.DistanceFromEllipsoidSurfaceOp

All Implemented Interfaces:

Runnable, Environmental, Initializable, Op, BinaryInput<Ellipsoid,org.joml.Vector3dc>, BinaryOp<Ellipsoid,org.joml.Vector3dc,DoubleType>, BinaryFunctionOp<Ellipsoid,org.joml.Vector3dc,DoubleType>, NullaryFunctionOp<DoubleType>, UnaryFunctionOp<Ellipsoid,DoubleType>, NullaryOp<DoubleType>, Output<DoubleType>, SpecialOp, UnaryInput<Ellipsoid>, UnaryOp<Ellipsoid,DoubleType>, Threadable, Command, SciJavaPlugin
```
public class DistanceFromEllipsoidSurfaceOp
extends AbstractBinaryFunctionOp<Ellipsoid,org.joml.Vector3dc,DoubleType>
```
An Op that calculates the distance between a point and an ellipsoid surface
Uses a hard-coded bivariate Newton-Raphson solver to efficiently find values of theta and phi that solve the orthogonality condition F(theta,phi)=0 for the vector between the surface and the point. Then converts into Cartesian coordinates to calculate the distance. Derivation of required terms courtesy of Robert Nürnberg, Imperial College London (See https://wwwf.imperial.ac.uk/~rn/distance2ellipse.pdf). Works for three-dimensional case only.

Author:

Alessandro Felder

Nested Class Summary
- Nested classes/interfaces inherited from interface net.imagej.ops.special.SpecialOp
  SpecialOp.Flavor

Constructor Summary

Constructors
Constructor and Description

DistanceFromEllipsoidSurfaceOp()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DoubleType`	`calculate(Ellipsoid ellipsoid, org.joml.Vector3dc point)` Calculates the shortest distance between a point and the surface of an ellipsoid

Methods inherited from class net.imagej.ops.special.function.AbstractBinaryFunctionOp
in1, in2, out, run, setInput1, setInput2

Methods inherited from class net.imagej.ops.AbstractOp
ops, setEnvironment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imagej.ops.special.function.BinaryFunctionOp
calculate, getIndependentInstance, run

Methods inherited from interface net.imagej.ops.special.BinaryOp
getArity

Methods inherited from interface net.imagej.ops.special.BinaryInput
in, setInput

Methods inherited from interface net.imagej.ops.special.function.UnaryFunctionOp
calculate, run

Methods inherited from interface net.imagej.ops.special.function.NullaryFunctionOp
run

Methods inherited from interface net.imagej.ops.special.SpecialOp
candidates, filterArity, op

Methods inherited from interface net.imagej.ops.Environmental
ops, setEnvironment

Methods inherited from interface net.imagej.ops.Initializable
initialize

- Constructor Detail
  - DistanceFromEllipsoidSurfaceOp
```
public DistanceFromEllipsoidSurfaceOp()
```
- Method Detail
  - calculate
```
public DoubleType calculate(Ellipsoid ellipsoid,
                            org.joml.Vector3dc point)
                     throws IllegalArgumentException
```
    Calculates the shortest distance between a point and the surface of an ellipsoid
    
    Parameters:
    
    ellipsoid - the ellipsoid in question
    
    point - the point in question
    
    Returns:
    
    shortest distance
    
    Throws:
    
    IllegalArgumentException - if tolerance is negative, or maxIterations is not positive.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2018–2022 BoneJ. All rights reserved.