Class TreatmentInformation
java.lang.Object
gov.nih.mipav.view.renderer.J3D.surfaceview.rfaview.TreatmentInformation
Information about a set of burns attempting to treat one of the target surfaces from the target list.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Vector<BurnAttributes> List of burn attributes.private floatThe volume difference btw the tumor surface and the buring sphere packings.private floatThe 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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBurn(BurnAttributes burn) Add a burn to the treatment list.getBurn(int index) Return one of the treatment's burns.javax.vecmath.Point3fgetBurnCenter(int index) Return the center point of a burn.Return the list of burns as an enumeration.getBurnName(int index) Return the name of a burn.javax.vecmath.Point3fgetBurnRadius(int index) Return the diameter of a burn.floatgetBurnVolume(int index) Return the volume of a burn.floatReturn the diff volume of the current treatment.intReturn the number of burns in this treatment's burn list.floatReturn the total volume of all this treatment set's burns.voidRemove all the burns in the treatment list.voidremoveBurn(int index) Remove a burn from the treatment list.voidremoveBurn(Object obj) Remove a burn from the treatment list.voidsetDiffVolume(float vol) Set the diff volume of the current treatment.voidsetTotalVolume(float vol) Set the total volume of all the burns.
-
Field Details
-
burns
List of burn attributes. -
diffVolume
private float diffVolumeThe volume difference btw the tumor surface and the buring sphere packings. -
totalVolume
private float totalVolumeThe total volume of the burns in this treatment set (if it has been calculated and the number of burns hasn't changed).
-
-
Constructor Details
-
TreatmentInformation
public TreatmentInformation()Create a new treatment set information object.
-
-
Method Details
-
addBurn
Add a burn to the treatment list.- Parameters:
burn- a new burn
-
getBurn
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
Return the list of burns as an enumeration.- Returns:
- an enumeration of the treatment's burns
-
getBurnName
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
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
-