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

Class BurnBase

java.lang.Object
gov.nih.mipav.view.renderer.J3D.surfaceview.rfaview.BurnBase
public class BurnBase extends Object

Title: BurnBase

Description: This class defined the basic bunring point image sence graph structure.

Author:
Ruida Cheng

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    burnIndex
    Current burning point index.
    private javax.media.j3d.BranchGroup
    burnRootParentBG
    The root branch group of the burning point.
    private int
    burnType
    Burning type flag, default to the default burning point type.
    private BurnCoolTipView
    coolTipBurn
    CoolTip burning point reference that represents the CoolTip probe ablation type.
    static int
    COOLTIPBURN
    Define the CoolTip burn type value.
    private BurnBaseView
    defaultBurn
    Default burning point reference that represents the default probe ablation type.
    static int
    DEFAULTBURN
    Define the default burn type value.
    (package private) int
    extentX
    image extents.
    (package private) int
    extentY
    image extents.
    (package private) int
    extentZ
    image extents.
    private BurnHeatView
    heatBurn
    Heat burning point reference that represents the thermal probe ablation type.
    static int
    HEATBURN
    Define the heat burn type value.
    private Vector
    maskBurnVector
    Mask burning center attribute.
    private BurnRegularView
    regularBurn
    Regular burning point reference that represents the regular probe ablation type.
    static int
    REGULARBURN
    Define the regular burn type value.
    private SurfaceRender
    surfaceRender
    Surface renderer reference.
    private BitSet
    volumeMask
    burning point volume mask.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BurnBase(SurfaceRender _surfaceRender, JPanelProbe _probePanel)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    activeBurn(int type)
    Active the current burning point type.
    float
    calcVolume(SurfaceAttributes surface, TreatmentInformation treatment)
    Calculate the current burning point volume.
    private void
    createImageSceneGraph()
    Build the root of the burning point branch group, and attached the root to the parent scene root transform group.
    void
    dispose()
    Dispose memory.
    void
    enableBurnLabels(boolean flag)
    Attach or detach burn labels.
    int
    findBurnPoint(javax.media.j3d.Shape3D pickedShape)
    Check whether the burning sphere is picked or not.
    javax.media.j3d.BranchGroup
    getBurnRootParentBG()
    Get the root of the burning point.
    javax.vecmath.Color4f
    getColor()
    Get the current burning point color.
    float
    getDiffVolume()
    Get the volume difference btw the tumor surface and burning sphere packings.
    BitSet
    getMask()
    Get the burning sphere or ellipsoid mask.
    javax.vecmath.Point3f
    getRadius()
    Get the burning sphere radius as a point format ( semiX, Y, Z ).
    javax.media.j3d.Shape3D
    getShape(javax.media.j3d.BranchGroup root)
    Get the shape of the burning point surface.
    javax.media.j3d.BranchGroup
    getSphereBG()
    The the burning point geometry sphere branch group.
    javax.vecmath.Vector3f
    getTranslate()
    Get the burning point center coordinates.
    float
    getVolume()
    Get the burning point volume.
    private void
    init()
    Setup the initial image scene graph structure.
    void
    removeAllBurnCenters()
    Remove all the burning point centers.
    void
    removeBurnCenter(int index)
    Remove the burning center element.
    void
    startBurn(float tipLen, float time)
    Show the the burning procedure.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULTBURN

      public static int DEFAULTBURN
      Define the default burn type value.

    • HEATBURN

      public static int HEATBURN
      Define the heat burn type value.

    • REGULARBURN

      public static int REGULARBURN
      Define the regular burn type value.

    • COOLTIPBURN

      public static int COOLTIPBURN
      Define the CoolTip burn type value.

    • burnIndex

      protected int burnIndex
      Current burning point index.

    • extentX

      int extentX
      image extents.

    • extentY

      int extentY
      image extents.

    • extentZ

      int extentZ
      image extents.

    • burnRootParentBG

      private javax.media.j3d.BranchGroup burnRootParentBG
      The root branch group of the burning point.

    • burnType

      private int burnType
      Burning type flag, default to the default burning point type.

    • coolTipBurn

      private BurnCoolTipView coolTipBurn
      CoolTip burning point reference that represents the CoolTip probe ablation type.

    • defaultBurn

      private BurnBaseView defaultBurn
      Default burning point reference that represents the default probe ablation type.

    • heatBurn

      private BurnHeatView heatBurn
      Heat burning point reference that represents the thermal probe ablation type.

    • maskBurnVector

      private Vector maskBurnVector
      Mask burning center attribute.

    • regularBurn

      private BurnRegularView regularBurn
      Regular burning point reference that represents the regular probe ablation type.

    • surfaceRender

      private SurfaceRender surfaceRender
      Surface renderer reference.

    • volumeMask

      private BitSet volumeMask
      burning point volume mask.

  • Constructor Details

    • BurnBase

      public BurnBase(SurfaceRender _surfaceRender, JPanelProbe _probePanel)
      Constructor. Initializes the burning point image scene graph structure and builds three types of burning point.
      Parameters:
      _surfaceRender - Surface Renderer reference.
      _probePanel - JPanelProbe reference.

  • Method Details

    • activeBurn

      public void activeBurn(int type)
      Active the current burning point type.
      Parameters:
      type - burning point type value.

    • calcVolume

      public float calcVolume(SurfaceAttributes surface, TreatmentInformation treatment)
      Calculate the current burning point volume.
      Parameters:
      surface - DOCUMENT ME!
      treatment - DOCUMENT ME!
      Returns:
      float burning point volume in voxels.

    • dispose

      public void dispose()
      Dispose memory.

    • enableBurnLabels

      public void enableBurnLabels(boolean flag)
      Attach or detach burn labels.
      Parameters:
      flag - true attach burn label, false not attach burn label.

    • findBurnPoint

      public int findBurnPoint(javax.media.j3d.Shape3D pickedShape)
      Check whether the burning sphere is picked or not.
      Parameters:
      pickedShape - sphere burning shape.
      Returns:
      int burning point index

    • getBurnRootParentBG

      public javax.media.j3d.BranchGroup getBurnRootParentBG()
      Get the root of the burning point.
      Returns:
      BranchGroup The root burning point branch group.

    • getColor

      public javax.vecmath.Color4f getColor()
      Get the current burning point color.
      Returns:
      Color4f burning point surface color appearance.

    • getDiffVolume

      public float getDiffVolume()
      Get the volume difference btw the tumor surface and burning sphere packings.
      Returns:
      volume volume difference in mm^3.

    • getMask

      public BitSet getMask()
      Get the burning sphere or ellipsoid mask.
      Returns:
      BitSet mask burning point mask.

    • getRadius

      public javax.vecmath.Point3f getRadius()
      Get the burning sphere radius as a point format ( semiX, Y, Z ).
      Returns:
      Point3f sphere radius.

    • getShape

      public javax.media.j3d.Shape3D getShape(javax.media.j3d.BranchGroup root)
      Get the shape of the burning point surface.
      Parameters:
      root - BranchGroup
      Returns:
      Shape3D

    • getSphereBG

      public javax.media.j3d.BranchGroup getSphereBG()
      The the burning point geometry sphere branch group.
      Returns:
      BranchGroup branch group of the sphere.

    • getTranslate

      public javax.vecmath.Vector3f getTranslate()
      Get the burning point center coordinates. Called by the probe control panel to show the current burning point center.
      Returns:
      Vector3f burning point center coordinate.

    • getVolume

      public float getVolume()
      Get the burning point volume.
      Returns:
      volume burning point volume.

    • removeAllBurnCenters

      public void removeAllBurnCenters()
      Remove all the burning point centers.

    • removeBurnCenter

      public void removeBurnCenter(int index)
      Remove the burning center element.
      Parameters:
      index - removed burning center index

    • startBurn

      public void startBurn(float tipLen, float time)
      Show the the burning procedure.
      Parameters:
      tipLen - the length of the probe tip in cm
      time - burning procedure time duration.

    • createImageSceneGraph

      private void createImageSceneGraph()
      Build the root of the burning point branch group, and attached the root to the parent scene root transform group.

    • init

      private void init()
      Setup the initial image scene graph structure.