artisynth.core.renderables

Class DicomPlaneViewer

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.mechmodels.DynamicComponentBase

artisynth.core.mechmodels.Frame

artisynth.core.renderables.TexturePlaneBase

artisynth.core.renderables.DicomPlaneViewer

All Implemented Interfaces:

CollidableDynamicComponent, ContactMaster, DynamicAgent, DynamicComponent, ForceEffector, FrameAttachable, HasSurfaceMesh, IsMarkable, MotionTargetComponent, PointAttachable, ComponentChangeListener, CompositeComponent, CopyableComponent, HasCoordinateFrame, HasNumericState, IndexedComponentList, ModelComponent, PostScannable, RenderableComponent, Traceable, TransformableGeometry, ScalableUnits, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

public class DicomPlaneViewer
extends TexturePlaneBase

Nested Class Summary

Nested classes/interfaces inherited from interface artisynth.core.modelbase.CompositeComponent

CompositeComponent.NavpanelDisplay

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DICOM_VISIBLE
static PropertyList	myProps

Fields inherited from class artisynth.core.mechmodels.Frame

dynamicVelInWorldCoords, myRenderFrame

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface artisynth.core.modelbase.TransformableGeometry

TG_ARTICULATED, TG_DRAGGER, TG_PRESERVE_ORIENTATION, TG_SIMULATING

Fields inherited from interface artisynth.core.modelbase.CopyableComponent

COPY_REFERENCES, REST_POSITION

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
DicomPlaneViewer() Creates an empty image-plane viewer widget.
DicomPlaneViewer(java.lang.String name, DicomViewer dviewer, PolygonalMesh templateMesh, RigidTransform3d TPW, RigidTransform3d TVI) Creates a new image-plane viewer widget, with supplied name and DICOM image
DicomPlaneViewer(java.lang.String name, DicomViewer dviewer, Vector2d widths, RigidTransform3d TPW) Creates a new image-plane viewer widget, with supplied name and DICOM image
DicomPlaneViewer(java.lang.String name, DicomViewer dviewer, Vector2d widths, RigidTransform3d TPW, RigidTransform3d TVI) Creates a new image-plane viewer widget, with supplied name and DICOM image

Method Summary

Modifier and Type	Method and Description
static RenderProps	createDefaultRenderProps()
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
boolean	getDicomVisible()
DicomImage	getImage()
PolygonalMesh	getImageMesh()
DicomPixelInterpolator	getPixelInterpolator()
Vector2d	getSize() Returns the size of the plane
void	getSoftReferences(java.util.List<ModelComponent> refs) Appends all soft references for this component to a list.
boolean	getSpatialInterpolation() Checks if spatial interpolation between voxels is enabled
int	getTimeIndex()
IntegerInterval	getTimeIndexRange()
java.lang.String[]	getWindowNames()
StringRange	getWindowRange()
boolean	isSelectable() Returns true if this object is in fact selectable.
int	numWindows()
void	prerender(RenderList list) Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
void	scaleMesh(double s)
void	setDicomVisible(boolean enable)
void	setImageFromViewer(DicomViewer dviewer, RigidTransform3d TPW) Sets the texture image from a dicom viewer.
void	setSize(Vector2d widths) Sets the widths of the plane
void	setSpatialInterpolation(boolean set) Sets whether to use spatial interpolation (tri-linear) or nearest neighbour when computing voxels.
void	setTimeIndex(int idx) Sets the current time index.
void	setWindow(java.lang.String presetName) Sets the current interpolation window to use, based on a preset name.
void	transformGeometry(GeometryTransformer gtr, TransformGeometryContext context, int flags) Transforms the geometry of this component, using the geometry transformer gtr to transform its individual attributes.
void	updateReferences(boolean undo, java.util.Deque<java.lang.Object> undoInfo) May be called by the system if any of the soft references for this component are removed from the the component hierarchy.
void	updateRenderProps()

Methods inherited from class artisynth.core.renderables.TexturePlaneBase

addMarker, canAddMarker, componentChanged, copy, createMarker, createMarker, createMarker, findComponent, get, get, getByNumber, getChildren, getMarkers, getNavpanelDisplay, getNumberLimit, getSurfaceMesh, getSurfaceMeshes, hasChildren, hasState, hierarchyContainsReferences, indexOf, iterator, numComponents, numSurfaceMeshes, postscan, render, scaleDistance, scan, setDisplayMode, transformGeometry, updateBounds, updateNameMap

Methods inherited from class artisynth.core.mechmodels.Frame

add1DConstraintBlocks, add2DConstraintBlocks, addEffectiveFrameMass, addEffectivePointMass, addExternalForce, addForce, addForce, addFrameForce, addPointForce, addPointForce, addPosImpulse, addPosJacobian, addRelativeVelocity, addScaledExternalForce, addSolveBlock, addSolveBlocks, addTargetJacobian, addToPointVelocity, addTransformableDependencies, addVelJacobian, applyExternalForces, applyForces, applyGravity, collectMasterComponents, computeAppliedWrench, computeForceOnMasters, computeFrameLocation, computeFramePosition, computeFramePosVel, computeFrameVelocity, computePointCoriolis, computePointLocation, computePointPosition, computePointPosVel, computePointVelocity, createFrameAttachment, createMassBlock, createPointAttachment, getAxisDrawStyle, getAxisLength, getBodyForce, getBodyVelocity, getBodyVelState, getCopyReferences, getEffectiveMass, getEffectiveMass, getEffectiveMassForces, getExternalForce, getForce, getForce, getForce, getFrameDamping, getFrameDampingMode, getFrameMarkers, getJacobianType, getMass, getMass, getMoment, getOrientation, getOrientation, getPosDerivative, getPose, getPose, getPosition, getPosState, getPosStateSize, getRenderFrame, getRotaryDamping, getRotaryDampingMode, getRotation, getSelection, getState, getTargetActivity, getTargetOrientation, getTargetPos, getTargetPose, getTargetPosition, getTargetVel, getTargetVelocity, getTraceablePositionProperty, getTraceables, getTransForce, getVelocity, getVelocity, getVelState, getVelStateSize, getWorldVelState, hasForce, isDuplicatable, isMassConstant, mulInverseEffectiveMass, resetEffectiveMass, resetTargets, scaleMass, setAxisDrawStyle, setAxisLength, setBodyVelocity, setContactConstraint, setExternalForce, setForce, setForce, setFrameDamping, setFrameDampingMode, setOrientation, setPose, setPosition, setPosState, setRandomForce, setRandomPosState, setRandomVelState, setRotaryDamping, setRotaryDampingMode, setRotation, setState, setState, setTargetActivity, setTargetOrientation, setTargetPos, setTargetPose, setTargetPosition, setTargetVel, setTargetVelocity, setVelocity, setVelocity, setVelState, transformPose, updateAttachmentPosStates, velocityLimitExceeded, zeroExternalForces, zeroForces

Methods inherited from class artisynth.core.mechmodels.DynamicComponentBase

addAttachmentRequest, addConstrainer, addMasterAttachment, connectToHierarchy, disconnectFromHierarchy, getAttachment, getConstrainers, getInverseMass, getMasterAttachments, getSolveIndex, isActive, isAttached, isControllable, isDynamic, isParametric, removeAttachmentRequest, removeConstrainer, removeMasterAttachment, setAttached, setSolveIndex

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

defaultRenderPropsAreNull, getRenderHints, getRenderProps, isVisible, numSelectionQueriesNeeded, setRenderProps, setVisible, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, createTempFlag, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.CompositeComponent

recursivelyFind

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, isFixed, isMarked, isSelected, notifyParentOfChange, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.util.Scannable

isWritable, write

Methods inherited from interface artisynth.core.modelbase.TransformableGeometry

addTransformableDependencies, transformPriority

Methods inherited from interface artisynth.core.mechmodels.DynamicComponent

addAttachmentRequest, removeAttachmentRequest

Methods inherited from interface artisynth.core.mechmodels.DynamicAgent

addConstrainer, addMasterAttachment, getAttachment, getConstrainers, getInverseMass, getMasterAttachments, getSolveIndex, isActive, isAttached, isControllable, isDynamic, isParametric, removeConstrainer, removeMasterAttachment, setAttached, setSolveIndex

Methods inherited from interface artisynth.core.modelbase.HasNumericState

advanceState, getAuxVarDerivative, getAuxVarState, getStateVersion, numAuxVars, requiresAdvance, setAuxVarState

Methods inherited from interface artisynth.core.mechmodels.ContactMaster

isControllable

Field Detail

DEFAULT_DICOM_VISIBLE

public static boolean DEFAULT_DICOM_VISIBLE

myProps

public static PropertyList myProps

Constructor Detail

DicomPlaneViewer

public DicomPlaneViewer()

Creates an empty image-plane viewer widget. Used by scan methods.

DicomPlaneViewer

public DicomPlaneViewer(java.lang.String name,
                        DicomViewer dviewer,
                        PolygonalMesh templateMesh,
                        RigidTransform3d TPW,
                        RigidTransform3d TVI)

Creates a new image-plane viewer widget, with supplied name and DICOM image

Parameters:

name - widget name

dviewer - DicomViewer providing the DICOM image data

templateMesh - defines the topology of the mesh onto which the image will be mapped

TPW - location/orientation of image plane center (world coordinates)

TVI - if non-null, gives transform from image to viewer

DicomPlaneViewer

public DicomPlaneViewer(java.lang.String name,
                        DicomViewer dviewer,
                        Vector2d widths,
                        RigidTransform3d TPW,
                        RigidTransform3d TVI)

Creates a new image-plane viewer widget, with supplied name and DICOM image

Parameters:

name - widget name

dviewer - DicomViewer providing the DICOM image data

widths - widths of image plane

TPW - location/orientation of image plane center (world coordinates)

TVI - if non-null, gives transform from image to viewer

DicomPlaneViewer

public DicomPlaneViewer(java.lang.String name,
                        DicomViewer dviewer,
                        Vector2d widths,
                        RigidTransform3d TPW)

Creates a new image-plane viewer widget, with supplied name and DICOM image

Parameters:

name - widget name

dviewer - DicomViewer providing the DICOM image data

widths - widths of image plane

TPW - location/orientation of image plane center (world coordinates)

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Overrides:

getAllPropertyInfo in class Frame

Returns:

static information for all exported properties

createDefaultRenderProps

public static RenderProps createDefaultRenderProps()

getDicomVisible

public boolean getDicomVisible()

setDicomVisible

public void setDicomVisible(boolean enable)

scaleMesh

public void scaleMesh(double s)

setImageFromViewer

public void setImageFromViewer(DicomViewer dviewer,
                               RigidTransform3d TPW)

Sets the texture image from a dicom viewer. Warning: don't call this unless you know what you're doing.

createRenderProps

public RenderProps createRenderProps()

Description copied from interface: HasRenderProps

Factory method to create render properties appropriate to this object.

Specified by:

createRenderProps in interface HasRenderProps

Overrides:

createRenderProps in class Frame

Returns:

new render properties for this object

updateRenderProps

public void updateRenderProps()

getImage

public DicomImage getImage()

Returns:

the DICOM image being displayed

getImageMesh

public PolygonalMesh getImageMesh()

numWindows

public int numWindows()

Returns:

the number of interpolation windows available in the DICOM image, or 0 if there is no dicom image.

getWindowNames

public java.lang.String[] getWindowNames()

Returns:

the names of all possible interpolation windows available in the DICOM image. Returns a zero-length array if there is no texture image.

setWindow

public void setWindow(java.lang.String presetName)

Sets the current interpolation window to use, based on a preset name. Does nothing if there is no DICOM image.

Parameters:

presetName - name of the interpolation window

prerender

public void prerender(RenderList list)

Description copied from interface: IsRenderable

Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling

list.addIfVisible (obj);

for each of the objects in question.

Specified by:

prerender in interface IsRenderable

Overrides:

prerender in class TexturePlaneBase

Parameters:

list - list of objects to be rendered

getPixelInterpolator

public DicomPixelInterpolator getPixelInterpolator()

Returns:

the current pixel interpolator, or null if there is no DICOM image

getWindowRange

public StringRange getWindowRange()

Returns:

range of valid window names, or null if there is no DICOM image

isSelectable

public boolean isSelectable()

Description copied from class: RenderableComponentBase

Returns true if this object is in fact selectable.

Specified by:

isSelectable in interface IsSelectable

Overrides:

isSelectable in class RenderableComponentBase

Returns:

true if this object is selectable

setSize

public void setSize(Vector2d widths)

Sets the widths of the plane

Parameters:

widths - plane widths

getSize

public Vector2d getSize()

Returns the size of the plane

Returns:

size of plane (width/height)

getSpatialInterpolation

public boolean getSpatialInterpolation()

Checks if spatial interpolation between voxels is enabled

Returns:

true if interpolating, false if using nearest neighbour or if there is no DICOM image

setSpatialInterpolation

public void setSpatialInterpolation(boolean set)

Sets whether to use spatial interpolation (tri-linear) or nearest neighbour when computing voxels. Does nothing if there is no dicom image.

Parameters:

set - enable/disable spatial interpolation

getTimeIndex

public int getTimeIndex()

Returns:

the current time index, or -1 if there s no dicom image

setTimeIndex

public void setTimeIndex(int idx)

Sets the current time index. Does nothing if there is no dicom image.

Parameters:

idx - time index

getTimeIndexRange

public IntegerInterval getTimeIndexRange()

Returns:

the number of time indices available in the DICOM image

transformGeometry

public void transformGeometry(GeometryTransformer gtr,
                              TransformGeometryContext context,
                              int flags)

Description copied from interface: TransformableGeometry

Transforms the geometry of this component, using the geometry transformer gtr to transform its individual attributes. The context argument supplies information about what other components are currently being transformed, and also allows the requesting of update actions to be performed after all transform called have completed. The context is also the usual entity that calls this method, from within its TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method. The argument flags provides flags to specify various conditions associated with the the transformation. At present, the available flags are TransformableGeometry.TG_SIMULATING and TransformableGeometry.TG_ARTICULATED.

This method is not usually called directly by applications. Instead, it is typically called from within the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of the context, which takes care of the various operations needed for a complete transform operation, including calling TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int) to collect other components that should be transformed, calling TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) for each component, notifying component parents that the geometry has changed, and calling any requested TransformGeometryActions. More details are given in the documentation for TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int).

TransformGeometryContext provides a number of static convenience transform methods which take care of building the context and calling apply() for a specified set of components.

This method should not generally call transformGeometry() for its descendant components. Instead, descendants needing transformation should be specified by adding them to the context in the method TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int).

Specified by:

transformGeometry in interface TransformableGeometry

Overrides:

transformGeometry in class TexturePlaneBase

Parameters:

gtr - transformer implementing the transform

context - context information, including what other components are being transformed

flags - specifies conditions associated with the transformation

getSoftReferences

public void getSoftReferences(java.util.List<ModelComponent> refs)

Appends all soft references for this component to a list. References are other components, outside of this component's immediate ancestry, on which this component depends. For example, an ExcitationComponent may refer to one or more other ExcitationComponents to act as excitation sources. A soft reference is one which can be removed from the referring component. In particular, if any soft references for a component are deleted, then that component's updateReferences() method will be called to update its internal reference information.

Specified by:

getSoftReferences in interface ModelComponent

Overrides:

getSoftReferences in class ModelComponentBase

Parameters:

refs - list to which soft references are appended

updateReferences

public void updateReferences(boolean undo,
                             java.util.Deque<java.lang.Object> undoInfo)

Description copied from class: ModelComponentBase

May be called by the system if any of the soft references for this component are removed from the the component hierarchy. If called with undo equal to false, this component should then examine its soft references and use ComponentUtils.areConnected() to determine which of them have been disconnected from the hierarchy. Disconnected references should be removed, and sufficient information should be appended to undoInfo to allow this update to be undone if this method is called later with undo equal to true. When undoing an update, the undo information should be removed from the front of undoInfo.

Specified by:

updateReferences in interface ModelComponent

Overrides:

updateReferences in class ModelComponentBase

Parameters:

undo - if true, indicates that the most recent reference update should be undone, using the supplied undo information.

undoInfo - if undo is false, should be used to store information allowing the reference update to be undone. Otherwise, if undo is true, then this supplied information to undo the most recent update.