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

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

public class CylinderBasedVolumeOfInterest
extends VolumeOfInterest

Describes a VOI consisting of a cylinder with one cone on top and one cone on the bottom. This is a typical VOI for a C-arm CT acquisition.

Author:
akmaier
See Also:
Serialized Form

Constructor Summary
CylinderBasedVolumeOfInterest()
           
 
Method Summary
 boolean contains(double x, double y, double z)
          Tests whether a given coordinate in world coordinates is within the VOI.
 boolean getSuccess()
          is true if the reading was successful.
 void readConfigFile(java.lang.String filename)
          Reads the configuration from the file denoted by filename
 
Methods inherited from class edu.stanford.rsl.konrad.reconstruction.voi.VolumeOfInterest
getVolumes, openAsVolume
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CylinderBasedVolumeOfInterest

public CylinderBasedVolumeOfInterest()
Method Detail

contains

public boolean contains(double x,
                        double y,
                        double z)
Description copied from class: VolumeOfInterest
Tests whether a given coordinate in world coordinates is within the VOI.

Specified by:
contains in class VolumeOfInterest
Parameters:
x - world coordinate x
y - world coordinate y
z - world coordinate z
Returns:
true, if the coordinate is insider the VOI.

readConfigFile

public void readConfigFile(java.lang.String filename)
                    throws java.io.IOException
Description copied from interface: ConfigFileParser
Reads the configuration from the file denoted by filename

Parameters:
filename - the file name
Throws:
java.io.IOException - may happen during reading

getSuccess

public boolean getSuccess()
Description copied from interface: ConfigFileParser
is true if the reading was successful.

Returns:
reading success?