edu.stanford.rsl.konrad.reconstruction.voi
Class VolumeOfInterest

java.lang.Object
  extended by edu.stanford.rsl.konrad.reconstruction.voi.VolumeOfInterest
All Implemented Interfaces:
ConfigFileParser, java.io.Serializable
Direct Known Subclasses:
CylinderBasedVolumeOfInterest, PolygonBasedVolumeOfInterest

public abstract class VolumeOfInterest
extends java.lang.Object
implements ConfigFileParser, java.io.Serializable

An abstract description of an arbitrary volume-of-interest (VOI).

Author:
akmaier
See Also:
Serialized Form

Constructor Summary
VolumeOfInterest()
           
 
Method Summary
abstract  boolean contains(double x, double y, double z)
          Tests whether a given coordinate in world coordinates is within the VOI.
static VolumeOfInterest[] getVolumes()
          Reports a list of all known implementations of VolumeOfInterest.
static VolumeOfInterest openAsVolume(java.lang.String filename)
          Constructor from filename
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface edu.stanford.rsl.konrad.io.ConfigFileParser
getSuccess, readConfigFile
 

Constructor Detail

VolumeOfInterest

public VolumeOfInterest()
Method Detail

contains

public abstract boolean contains(double x,
                                 double y,
                                 double z)
Tests whether a given coordinate in world coordinates is within the VOI.

Parameters:
x - world coordinate x
y - world coordinate y
z - world coordinate z
Returns:
true, if the coordinate is insider the VOI.

getVolumes

public static VolumeOfInterest[] getVolumes()
Reports a list of all known implementations of VolumeOfInterest.

Returns:
the list of implementations.

openAsVolume

public static VolumeOfInterest openAsVolume(java.lang.String filename)
Constructor from filename

Parameters:
filename - the filename
Returns:
the volume of interest.