Package gov.nih.mipav.view.renderer.J3D.surfaceview.rfaview

Class TreatmentInformation

  • public class TreatmentInformation
extends java.lang.Object
    Information about a set of burns attempting to treat one of the target surfaces from the target list.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Vector<BurnAttributes> burns
      List of burn attributes.
      private float diffVolume
      The volume difference btw the tumor surface and the buring sphere packings.
      private float totalVolume
      The total volume of the burns in this treatment set (if it has been calculated and the number of burns hasn't changed).

    • Constructor Summary

      Constructors 
      Constructor Description
      TreatmentInformation()
      Create a new treatment set information object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addBurn​(BurnAttributes burn)
      Add a burn to the treatment list.
      BurnAttributes getBurn​(int index)
      Return one of the treatment's burns.
      javax.vecmath.Point3f getBurnCenter​(int index)
      Return the center point of a burn.
      java.util.Enumeration<BurnAttributes> getBurnEnum()
      Return the list of burns as an enumeration.
      java.lang.String getBurnName​(int index)
      Return the name of a burn.
      javax.vecmath.Point3f getBurnRadius​(int index)
      Return the diameter of a burn.
      float getBurnVolume​(int index)
      Return the volume of a burn.
      float getDiffVolume()
      Return the diff volume of the current treatment.
      int getNumBurns()
      Return the number of burns in this treatment's burn list.
      float getTotalVolume()
      Return the total volume of all this treatment set's burns.
      void removeAllBurns()
      Remove all the burns in the treatment list.
      void removeBurn​(int index)
      Remove a burn from the treatment list.
      void removeBurn​(java.lang.Object obj)
      Remove a burn from the treatment list.
      void setDiffVolume​(float vol)
      Set the diff volume of the current treatment.
      void setTotalVolume​(float vol)
      Set the total volume of all the burns.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • burns

        private java.util.Vector<BurnAttributes> burns
        List of burn attributes.

      • diffVolume

        private float diffVolume
        The volume difference btw the tumor surface and the buring sphere packings.

      • totalVolume

        private float totalVolume
        The total volume of the burns in this treatment set (if it has been calculated and the number of burns hasn't changed).

    • Constructor Detail

      • TreatmentInformation

        public TreatmentInformation()
        Create a new treatment set information object.

    • Method Detail

      • addBurn

        public void addBurn​(BurnAttributes burn)
        Add a burn to the treatment list.
        Parameters:
        burn - a new burn

      • getBurn

        public BurnAttributes getBurn​(int index)
        Return one of the treatment's burns.
        Parameters:
        index - index into the burn list
        Returns:
        the requested burn's attributes

      • getBurnCenter

        public javax.vecmath.Point3f getBurnCenter​(int index)
        Return the center point of a burn.
        Parameters:
        index - the index of the burn to get the center of
        Returns:
        the coordinates of the center of the requested burn

      • getBurnEnum

        public java.util.Enumeration<BurnAttributes> getBurnEnum()
        Return the list of burns as an enumeration.
        Returns:
        an enumeration of the treatment's burns

      • getBurnName

        public java.lang.String getBurnName​(int index)
        Return the name of a burn.
        Parameters:
        index - the index of the burn to get the name of
        Returns:
        the name of the requested burn

      • getBurnRadius

        public javax.vecmath.Point3f getBurnRadius​(int index)
        Return the diameter of a burn.
        Parameters:
        index - the index of the burn to get the diameter of
        Returns:
        the diameter of the requested burn

      • getBurnVolume

        public float getBurnVolume​(int index)
        Return the volume of a burn.
        Parameters:
        index - the index of the burn to get the volume of
        Returns:
        the volume of the requested burn

      • getDiffVolume

        public float getDiffVolume()
        Return the diff volume of the current treatment.
        Returns:
        the total volume

      • getNumBurns

        public int getNumBurns()
        Return the number of burns in this treatment's burn list.
        Returns:
        the number of burns

      • getTotalVolume

        public float getTotalVolume()
        Return the total volume of all this treatment set's burns.
        Returns:
        the total volume

      • removeAllBurns

        public void removeAllBurns()
        Remove all the burns in the treatment list.

      • removeBurn

        public void removeBurn​(int index)
        Remove a burn from the treatment list.
        Parameters:
        index - the index of the burn to remove

      • removeBurn

        public void removeBurn​(java.lang.Object obj)
        Remove a burn from the treatment list.
        Parameters:
        obj - the burn object to remove

      • setDiffVolume

        public void setDiffVolume​(float vol)
        Set the diff volume of the current treatment.
        Parameters:
        vol - the total volume

      • setTotalVolume

        public void setTotalVolume​(float vol)
        Set the total volume of all the burns.
        Parameters:
        vol - the total volume