Class J2Ci.jDVPresentationState
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class J2Ci.jDVPresentationState

Object
   |
   +----J2Ci.jDVPresentationState

public class jDVPresentationState
extends Object
A jDVPresentationState is the Java-sided class for the C++-Class DVPresentationState. The Constructor is disabled !.

Author:
Andreas Schröter

Constructor Index

 o J2Ci.jDVPresentationState()
Constructor is disabled !!!
 o J2Ci.jDVPresentationState(long)
Constructor for attaching an existing C++-Object.

Method Index

 o activateOverlayAsBitmapShutter(int)
Activates an overlay as bitmap shutter.
 o activateOverlayInImage(int, int)
Activates the given overlay from the attached image on the given graphic layer.
 o activateOverlayInPresentationState(int, int)
Activates the given overlay from the presentation state on the given graphic layer.
 o activeOverlayIsROI(int, int)
Checks whether the given activated overlay is a ROI (region of interest) overlay.
 o addCurve(int, int)
Activates curve in presentation state.
 o addGraphicLayer(String, String)
Creates a new graphic layer with the given name and optional description.
 o addGraphicObject(int)
Creates a new graphic object on the given layer.
 o addImageReference(String, String, String, String, String)
Adds a reference to an image to this presentation state.
 o addImageReferenceAttached()
adds a reference to the currently attached image to this presentation state.
 o addPolyShutterVertex(int, int)
Sets polygonal display shutter point.
 o addTextObject(int)
Creates a new text object on the given layer.
 o changeOverlayGroupInPresentationState(int, int)
Changes the repeating group used for an overlay in the presentation state.
 o clear()
Resets the object to initial state.
 o convertPValueToDDL(int)
Converts a 16-bit P-Value to an 8-bit DDL value for on-sceen display.
 o createInstanceUID()
Generates a new SOP Instance UID which is used when writing the Presentation State to file.
 o deactivateOverlay(int, int)
Removes activation for an overlay which may be embedded in the attached image or part of the presentation state.
 o deactivateVOI()
Deactivates the current VOI transformation.
 o detachImage()
Detaches and frees the image attached to the presentation state.
 o exchangeGraphicLayers(int, int)
Exchanges the layer order of the two graphic layers with the given indices.
 o getActiveOverlayDescription(int, int)
Gets the overlay description of the given activated overlay.
 o getActiveOverlayGroup(int, int)
Gets the repeating group number of the given activated overlay.
 o getActiveOverlayLabel(int, int)
Gets the overlay label of the given activated overlay.
 o getBartenTransform()
Checks whether Barten correction is switched on or off.
 o getCenterOfCircularShutter_x()
Gets circular shutter center x component.
 o getCenterOfCircularShutter_y()
Gets circular shutter center y component.
 o getCharset()
Gets the specific character set for this presentation state.
 o getCharsetString()
Gets the specific character set string for this presentation state.
 o getCurrentPresentationLUTExplanation()
Gets a description of the current presentation LUT.
 o getCurrentVOIDescription()
Returns a description string for a currently active VOI transform.
 o getCurrentWindowCenter(jDoubleByRef)
Get the center of the current VOI window.
 o getCurrentWindowWidth(jDoubleByRef)
Gets the width of the current VOI window.
 o getCurve(int, int)
Gets the curve with the given index on the given layer.
 o getCurveInImage(int)
Gets the curve with the given index from the attached image.
 o getDescriptionOfVOILUTsInImage(int)
Returns a description string for the given VOI LUT in the attached image.
 o getDescriptionOfVOIWindowsInImage(int)
Returns a description string for the given VOI Window in the attached image.
 o getDisplayedAreaBRHC_x()
Returns the X component of the displayed area bottom right hand corner.
 o getDisplayedAreaBRHC_y()
Returns the Y component of the displayed area bottom right hand corner.
 o getDisplayedAreaTLHC_x()
Returns the X component of the displayed area top left hand corner.
 o getDisplayedAreaTLHC_y()
Returns the Y component of the displayed area top left hand corner.
 o getFlip()
Gets the current horizontal flip status of the presentation state.
 o getGraphicLayerDescription(int)
Gets a description string for the graphic layer with the given index.
 o getGraphicLayerIndex(String)
Gets the index of the graphic layer with the given unique name.
 o getGraphicLayerName(int)
Gets the unique name of the graphic layer with the given index.
 o getGraphicLayerRecommendedDisplayValueGray(int, jIntByRef)
Gets the recommended display value for the given graphic layer (monochrome).
 o getGraphicLayerRecommendedDisplayValueRGB(int, jIntByRef, jIntByRef, jIntByRef)
Gets the recommended display value for the given graphic layer (color).
 o getGraphicObject(int, int)
Gets the graphic object with the given index.
 o getImageAspectRatio(jDoubleByRef)
Gets the pixel aspect ratio of the attached image.
 o getImageHeight(jIntByRef)
Gets the height of the attached image.
 o getImageMinMaxPixelRange(jDoubleByRef, jDoubleByRef)
Gets smallest and biggest possible pixel value in the attached image.
 o getImageMinMaxPixelValue(jDoubleByRef, jDoubleByRef)
Gets smallest and biggest occuring pixel value in the attached image.
 o getImageReference(int, jDVPrStateParam_GetImageReference)
UNTESTED - Gets an image reference with the given index.
 o getImageWidth(jIntByRef)
Gets the width of the attached image.
 o getNumberOfActiveOverlays(int)
Gets the number of overlays that are currently activated on the given graphic layer.
 o getNumberOfCurves(int)
Returns the number of curve activations for the given graphic layer.
 o getNumberOfCurvesInImage()
Returns the number of curves in the attached image that could be activated in the presentation state.
 o getNumberOfGraphicLayers()
Returns the number of graphic layers.
 o getNumberOfGraphicObjects(int)
Returns the number of graphic objects for the given graphic layer.
 o getNumberOfOverlaysInImage()
Gets the number of overlays which are embedded in the image currently attached to the presentation state.
 o getNumberOfOverlaysInPresentationState()
Gets the number of overlays which are embedded in the presentation state.
 o getNumberOfPolyShutterVertices()
Gets polygonal shutter number of points.
 o getNumberOfTextObjects(int)
Returns the number of text objects for the given graphic layer.
 o getNumberOfVOILUTsInImage()
Gets the number of VOI LUTs available in the attached image.
 o getNumberOfVOIWindowsInImage()
Gets the number of VOI Windows available in the attached image.
 o getOverlayData(jDVPrStateParam_GetOverlayData)
Gets one overlay bitmap.
 o getOverlayInImageActivationLayer(int)
Gets the index of the activation layer on which the given overlay from the attached image is activated.
 o getOverlayInImageDescription(int)
Gets the overlay description of the given overlay in the attached image.
 o getOverlayInImageGroup(int)
Gets the repeating group number of the given overlay in the attached image.
 o getOverlayInImageLabel(int)
Gets the overlay label of the given overlay in the attached image.
 o getOverlayInPresentationStateActivationLayer(int)
Gets the index of the activation layer on which the given overlay from the presentation state is activated.
 o getOverlayInPresentationStateDescription(int)
Gets the overlay description of the given overlay in the presentation state.
 o getOverlayInPresentationStateGroup(int)
Gets the repeating group number of the given overlay in the presentation state.
 o getOverlayInPresentationStateLabel(int)
Gets the overlay label of the given overlay in the presentation state.
 o getPixelData(jDVPrStateParam_GetPixelData)
Apply presentation state to attached image and return image bitmap.
 o getPixelData(byte[], long)
Same as method above apart from the fact that the storage area is handled externally.
 o getPolyShutterVertex(int, Point)
Get polygonal shutter point.
 o getPresentationCreatorsName()
Returns the creator's name for the presentation state.
 o getPresentationDescription()
Returns a description for the presentation state.
 o getPresentationLUT()
Gets the current Presentation LUT type.
 o getPresentationLUTExplanation()
Returns the LUT explanation of the presentation LUT if it exists and is non-empty.
 o getPresentationLabel()
Returns a label for the presentation state.
 o getRadiusOfCircularShutter()
Gets circular shutter radius.
 o getRectShutterLH()
Gets rectangular shutter lower horiztonal edge.
 o getRectShutterLV()
Gets rectangular shutter left vertical edge.
 o getRectShutterRV()
Gets rectangular shutter right vertical edge.
 o getRectShutterUH()
Gets rectangular shutter upper horitontal edge.
 o getRotation()
Gets the current rotation status of the presentation state.
 o getScreenData(jDVPrStateParam_GetScreenData)
Gets the pixel data and perfom zooming and scaling with all existing layers.
 o getShutterPresentationValue()
Gets the shutter presentation value.
 o getTextObject(int, int)
Gets the text object with the given index on the given layer.
 o haveActiveVOILUT()
Check if a VOI LUT is currently active.
 o haveActiveVOIWindow()
Check if a VOI window is currently active.
 o haveGraphicLayerRecommendedDisplayValue(int)
Checks whether a recommended display value for the given graphic layer exists.
 o havePresentationLookupTable()
Checks if a real Presentation LUT (not shape) is available in the presentation state.
 o haveShutter(int)
Checks if a display shutter of given type is active.
 o invertImage()
Inverts image by changing presentation state LUT or presentation state LUT shape.
 o isGrayGraphicLayerRecommendedDisplayValue(int)
Checks whether a recommended display value for the given graphic layer exists and is monochrome.
 o isInverse()
Checks whether image is inverse (shape, plut or mono1).
 o moveCurve(int, int, int)
Moves the curve activation with the given index on the given layer to a different layer.
 o moveGraphicObject(int, int, int)
Moves the graphic object with the given index on the given layer to a different layer.
 o moveOverlay(int, int, int)
Moves the overlay activation with the given index on the given layer to a different layer.
 o moveTextObject(int, int, int)
Moves the text object with the given index on the given layer to a different layer.
 o numberOfImageReferences()
Gets the number of image references in all series managed by this list.
 o overlayInImageIsROI(int)
Checks whether the given overlay in the attached image is a ROI (region of interest) overlay.
 o overlayInPresentationStateIsROI(int)
Checks whether the given overlay in the presentation state is a ROI (region of interest) overlay.
 o overlayIsBitmapShutter(int)
Checks if the given overlay in the presentation state is currently activated as a bitmap shutter.
 o overlayIsSuitableAsBitmapShutter(int)
Checks if an overlay from the presentation state is suitable for use as a bitmap shutter.
 o removeCurve(int, int)
Deletes the curve activation with the given index on the given layer.
 o removeGraphicLayer(int)
Removes and deletes a graphic layer.
 o removeGraphicObject(int, int)
Deletes the graphic object with the given index on the given layer.
 o removeImageReference(String, String, String)
Removes a reference to an image from this presentation state.
 o removeImageReferenceAttached()
Removes a reference to the currently attached image from this presentation state.
 o removeOverlayFromPresentationState(int)
Removes an overlay from the presentation state.
 o removeShutter(int)
Deactivates display shutter of given type.
 o removeTextObject(int, int)
Deletes the text object with the given index on the given layer.
 o setBartenTransform(boolean)
Activates or deactivates Barten correction.
 o setCharset(int)
Sets the specific character set for this presentation state.
 o setCircularShutter(int, int, int)
Sets and activates circular display shutter.
 o setCurrentPresentationLUT(int)
Sets the current Presentation LUT type.
 o setDisplayedAreaBRHC(int, int)
Sets the displayed area bottom right hand corner.
 o setDisplayedAreaTLHC(int, int)
Sets the displayed area top left hand corner.
 o setFlip(boolean)
Sets horizontal flip status of the presentation state.
 o setGraphicLayerDescription(int, String)
Sets a new description to the given graphic layer.
 o setGraphicLayerName(int, String)
Assigns a new unique name to the given graphic layer.
 o setGraphicLayerRecommendedDisplayValueGray(int, int)
Sets the recommended display value for the given graphic layer.
 o setGraphicLayerRecommendedDisplayValueRGB(int, int, int, int)
Sets the recommended display value for the given graphic layer.
 o setPolyShutterOrigin(int, int)
Sets polygonal display shutter origin.
 o setPresentationCreatorsName(String)
Sets the presentation state creator's name.
 o setPresentationDescription(String)
Sets the presentation state description.
 o setPresentationLabel(String)
Sets the presentation state label.
 o setRectShutter(int, int, int, int)
Sets and activates rectangular display shutter.
 o setRotation(int)
Sets rotation status of the presentation state.
 o setShutterPresentationValue(int)
Sets the shutter presentation value to the given P-value.
 o setVOILUTFromImage(int)
Activates one of the VOI LUTs from the attached image.
 o setVOIWindow(double, double, String)
Sets a user defined VOI window center and width.
 o setVOIWindowFromImage(int)
Activates one of the VOI Windows from the attached image.
 o sortGraphicLayers()
Sorts the graphic layers according to the graphic layer order.
 o toBackGraphicLayer(int)
Makes a graphic layer the lowest layer for display.
 o toFrontGraphicLayer(int)
Makes a graphic layer the highest layer for display.

Constructors

 o jDVPresentationState
protected jDVPresentationState()
Constructor is disabled !!!

 o jDVPresentationState
public jDVPresentationState(long attachAdr)
Constructor for attaching an existing C++-Object. FOR INTERNAL USE ONLY!

Parameters:
attachAdr - Address of C++-Object

Methods

 o activateOverlayAsBitmapShutter
public native int activateOverlayAsBitmapShutter(int idx)
Activates an overlay as bitmap shutter. The overlay must not be activated on a graphic layer (i.e. getOverlayInPresentationStateActivationLayer(idx) != DVPS_IDX_NONE, otherwise this method fails.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o activateOverlayInImage
public native int activateOverlayInImage(int layer,
                                         int idx)
Activates the given overlay from the attached image on the given graphic layer. If the overlay is already activated (i.e. getOverlayInImageActivationLayer(idx) != DVPS_IDX_NONE) this method fails.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the overlay, must be < getNumberOfOverlaysInImage().
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o activateOverlayInPresentationState
public native int activateOverlayInPresentationState(int layer,
                                                     int idx)
Activates the given overlay from the presentation state on the given graphic layer. If the overlay is already activated or used as a bitmap overlay (i.e. getOverlayInPresentationStateActivationLayer(idx) != DVPS_IDX_NONE or overlayIsBitmapShutter(idx) == OFTrue) this method fails.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o activeOverlayIsROI
public native boolean activeOverlayIsROI(int layer,
                                         int idx)
Checks whether the given activated overlay is a ROI (region of interest) overlay.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the overlay, must be < getNumberOfActiveOverlays().
Returns:
true if overlay exists and is ROI, false otherwise.
 o addCurve
public native int addCurve(int layer,
                           int curveidxinimage)
Activates curve in presentation state. This method adds an activation for the given curve from the attached image to the given graphic layer in the presentation state.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
curveidxinimage - index of the curve in the attached image, must be < getNumberOfCurvesInImage()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o addGraphicLayer
public native int addGraphicLayer(String gLayer,
                                  String gLayerDescription)
Creates a new graphic layer with the given name and optional description. The new name must be unique, otherwise an error code is returned. The toFrontGraphicLayer() method is implicitly called for the new layer.

Parameters:
gLayer - the name of the graphic layer. Must be a valid DICOM Code String.
gLayerDescription - the optional description of the graphic layer. Must be a valid DICOM Long String.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o addGraphicObject
public J2Ci.jDVPSGraphicObject addGraphicObject(int layer)
Creates a new graphic object on the given layer. Returns a pointer to the new graphic object. If the graphic layer does not exist or if the creation of the graphic object fails, NULL is returned.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
a pointer to the new graphic object
 o addImageReference
public native int addImageReference(String studyUID,
                                    String seriesUID,
                                    String sopClassUID,
                                    String instanceUID,
                                    String frames)
Adds a reference to an image to this presentation state. This method checks if the given SOP class and Study UID match for this presentation state and returns an error code otherwise.

Parameters:
studyUID - the Study Instance UID of the image reference to be added.
seriesUID - the Series Instance UID of the image reference to be added.
sopclassUID - the SOP class UID of the image reference to be added.
instanceUID - the SOP instance UID of the image reference to be added.
frames - a list of frame numbers in DICOM IS format (integer numbers separated by '\' characters). Default: frame numbers absent. The frame numbers are required if the referenced image is a multiframe image.
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o addImageReferenceAttached
public native int addImageReferenceAttached()
adds a reference to the currently attached image to this presentation state. This method checks if the given image is not yet referenced and if its Study UID and SOP class match for this presentation state and returns an error code otherwise.

Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o addPolyShutterVertex
public native int addPolyShutterVertex(int x,
                                       int y)
Sets polygonal display shutter point. This method adds a point to the polygonal display shutter, which must already have at least an origin. If the point set with this method is identical to the origin of the shutter, the shutter is activated and a possible bitmap shutter is deactivated. If no shutter display value exists, a default of 0 (black) is set.

Parameters:
x - the x component of the shutter origin
y - the x component of the shutter origin
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o addTextObject
public J2Ci.jDVPSTextObject addTextObject(int layer)
Creates a new text object on the given layer. returns a pointer to the new text object. If the graphic layer does not exist or if the creation of the text object fails, NULL is returned.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
a pointer to the new text object
 o changeOverlayGroupInPresentationState
public native int changeOverlayGroupInPresentationState(int idx,
                                                        int newGroup)
Changes the repeating group used for an overlay in the presentation state. Since overlays in the presentation state can shadow overlays in the attached image, execution of this method may change the number of overlays reported in the attached image.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
newGroup - new repeating group number 0x6000-0x601F (even). If this optional parameter is omitted, the method attemps to automatically determine a new group number so that no overlay in the attached image is shadowed any more. If this is impossible, the method fails and leaves the overlay repeating group unchanged.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o clear
public native void clear()
Resets the object to initial state. After this call, the object is in the same state as after creation with the default constructor.

 o convertPValueToDDL
public native byte convertPValueToDDL(int pvalue)
Converts a 16-bit P-Value to an 8-bit DDL value for on-sceen display. If a display function is set and enabled (see setBartenTransform()), the DDL is corrected for the nonlinearity of the display, otherwise a simple linear mapping is performed.

Parameters:
pvalue - P-Value 0..0xFFFF
Returns:
display driving level (DDL), 0..0xFF
 o createInstanceUID
public native java.lang.String createInstanceUID()
Generates a new SOP Instance UID which is used when writing the Presentation State to file.

Returns:
new SOP Instance UID if successfully set
 o deactivateOverlay
public native int deactivateOverlay(int layer,
                                    int idx)
Removes activation for an overlay which may be embedded in the attached image or part of the presentation state.

Parameters:
layer - index of the graphic layer on which this overlay is activated, must be < getNumberOfGraphicLayers().
idx - index of the overlay activation on the given layer, must be < getNumberOfActiveOverlays(layer).
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o deactivateVOI
public native void deactivateVOI()
Deactivates the current VOI transformation. After a call to this method, no VOI transform is active.

 o detachImage
public native void detachImage()
Detaches and frees the image attached to the presentation state.

 o exchangeGraphicLayers
public native int exchangeGraphicLayers(int idx1,
                                        int idx2)
Exchanges the layer order of the two graphic layers with the given indices. This method does not sort or renumber the graphic layers.

Parameters:
idx1 - index of the first graphic layer, must be < getNumberOfGraphicLayers()
idx2 - index of the second graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Confition).
 o getActiveOverlayDescription
public native java.lang.String getActiveOverlayDescription(int layer,
                                                           int idx)
Gets the overlay description of the given activated overlay.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the overlay, must be < getNumberOfActiveOverlays().
Returns:
description string if it exists, NULL otherwise.
 o getActiveOverlayGroup
public native int getActiveOverlayGroup(int layer,
                                        int idx)
Gets the repeating group number of the given activated overlay.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the overlay, must be < getNumberOfActiveOverlays().
Returns:
repeating group number if found, 0 otherwise.
 o getActiveOverlayLabel
public native java.lang.String getActiveOverlayLabel(int layer,
                                                     int idx)
Gets the overlay label of the given activated overlay.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the overlay, must be < getNumberOfActiveOverlays().
Returns:
label string if it exists, NULL otherwise.
 o getBartenTransform
public native boolean getBartenTransform()
Checks whether Barten correction is switched on or off. Barten transform will only be performed if switched on _and_ a valid monitor character description exists. Default is on.

Returns:
true if Barten transform is on.
 o getCenterOfCircularShutter_x
public native int getCenterOfCircularShutter_x()
Gets circular shutter center x component. May only be called if a circular shutter is active.

Returns:
the circ shutter center x component
 o getCenterOfCircularShutter_y
public native int getCenterOfCircularShutter_y()
Gets circular shutter center y component. May only be called if a circular shutter is active.

Returns:
the circ shutter center y component
 o getCharset
public native int getCharset()
Gets the specific character set for this presentation state.

Returns:
character set identifier (from jDVPScharacterSet).
 o getCharsetString
public native java.lang.String getCharsetString()
Gets the specific character set string for this presentation state.

Returns:
character set if present, NULL otherwise
 o getCurrentPresentationLUTExplanation
public native java.lang.String getCurrentPresentationLUTExplanation()
Gets a description of the current presentation LUT. For well-known presentation LUT shapes, a standard text is returned. For presentation LUTs, the LUT explanation is returned if it exists and a standard text otherwise. This method never returns (null).

Returns:
A string describing the current presentation LUT.
 o getCurrentVOIDescription
public native java.lang.String getCurrentVOIDescription()
Returns a description string for a currently active VOI transform. If no description is available, NULL is returned.

Returns:
a pointer to a string or NULL.
 o getCurrentWindowCenter
public native int getCurrentWindowCenter(jDoubleByRef c)
Get the center of the current VOI window. May only be called if haveActiveVOIWindow() is OFTrue.

Parameters:
c - the window center is returned in this parameter
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getCurrentWindowWidth
public native int getCurrentWindowWidth(jDoubleByRef w)
Gets the width of the current VOI window. May only be called if haveActiveVOIWindow() is OFTrue.

Parameters:
w - the window width is returned in this parameter
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getCurve
public J2Ci.jDVPSCurve getCurve(int layer,
                                int idx)
Gets the curve with the given index on the given layer. If the curve or the graphic layer does not exist, NULL is returned.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the curve, must be < getNumberOfCurves(layer)
Returns:
a pointer to the curve
 o getCurveInImage
public J2Ci.jDVPSCurve getCurveInImage(int idx)
Gets the curve with the given index from the attached image. If the curve does not exist, NULL is returned.

Parameters:
idx - index of the curve, must be < getNumberOfCurvesInImage()
Returns:
the curve
 o getDescriptionOfVOILUTsInImage
public native java.lang.String getDescriptionOfVOILUTsInImage(int idx)
Returns a description string for the given VOI LUT in the attached image. If no description for the given index is available, NULL is returned.

Parameters:
idx - index, must be < getNumberOfVOILUTsInImage()
Returns:
a pointer to a string or NULL.
 o getDescriptionOfVOIWindowsInImage
public native java.lang.String getDescriptionOfVOIWindowsInImage(int idx)
Returns a description string for the given VOI Window in the attached image. If no description for the given index is available, NULL is returned.

Parameters:
idx - index, must be < getNumberOfVOIWindowsInImage()
Returns:
a pointer to a string or NULL.
 o getDisplayedAreaBRHC_x
public native int getDisplayedAreaBRHC_x()
Returns the X component of the displayed area bottom right hand corner.

Returns:
BRHC X component.
 o getDisplayedAreaBRHC_y
public native int getDisplayedAreaBRHC_y()
Returns the Y component of the displayed area bottom right hand corner.

Returns:
BRHC Y component.
 o getDisplayedAreaTLHC_x
public native int getDisplayedAreaTLHC_x()
Returns the X component of the displayed area top left hand corner.

Returns:
TLHC X component.
 o getDisplayedAreaTLHC_y
public native int getDisplayedAreaTLHC_y()
Returns the Y component of the displayed area top left hand corner.

Returns:
TLHC Y component.
 o getFlip
public native boolean getFlip()
Gets the current horizontal flip status of the presentation state.

Returns:
true if flip is on, false if flip is off.
 o getGraphicLayerDescription
public native java.lang.String getGraphicLayerDescription(int idx)
Gets a description string for the graphic layer with the given index. If no layer for the given index exists, or if the description is empty, NULL is returned.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
description of the graphic layer
 o getGraphicLayerIndex
public native int getGraphicLayerIndex(String name)
Gets the index of the graphic layer with the given unique name. If no matching layer is found, (-1) is returned.

Parameters:
name - name of the graphic layer
Returns:
index of the graphic layer
 o getGraphicLayerName
public native java.lang.String getGraphicLayerName(int idx)
Gets the unique name of the graphic layer with the given index. If no layer for the given index exists, NULL is returned.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
name of the graphic layer
 o getGraphicLayerRecommendedDisplayValueGray
public native int getGraphicLayerRecommendedDisplayValueGray(int idx,
                                                             jIntByRef gray)
Gets the recommended display value for the given graphic layer (monochrome). If the recommended display value is a color, it is implicitly converted to grayscale. Param gray must be created before passing to this method!

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
gray - the recommended display value as an unsigned 16-bit P-value is returned in this parameter. gray must be created before passing to this method!
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getGraphicLayerRecommendedDisplayValueRGB
public native int getGraphicLayerRecommendedDisplayValueRGB(int idx,
                                                            jIntByRef r,
                                                            jIntByRef g,
                                                            jIntByRef b)
Gets the recommended display value for the given graphic layer (color). If the recommended display value is monochrome, identical R, G and B components are passed back. The objects r, g, b must be created before passing to this method!

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
r - returns the R component of the recommended display value as unsigned 16-bit P-value. Must be created before passing to this method!
g - returns the G component of the recommended display value as unsigned 16-bit P-value Must be created before passing to this method!
b - returns the B component of the recommended display value as unsigned 16-bit P-value Must be created before passing to this method!
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getGraphicObject
public J2Ci.jDVPSGraphicObject getGraphicObject(int layer,
                                                int idx)
Gets the graphic object with the given index. on the given layer. If the graphic object or the graphic layer does not exist, NULL is returned.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the graphic object, must be < getNumberOfGraphicObjects(layer)
Returns:
the graphic object.
 o getImageAspectRatio
public native int getImageAspectRatio(jDoubleByRef ratio)
Gets the pixel aspect ratio of the attached image. Pixel aspect ratio is defined here as the width of a pixel divided by the height of a pixel (x/y). This method may only be called when an image is attached to the presentation state.

Parameters:
ratio - upon success, the pixel aspect ratio is returned in this parameter.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getImageHeight
public native int getImageHeight(jIntByRef height)
Gets the height of the attached image. The rotation status of the presentation state is not taken into account, i.e. the height of an unrotated image is returned. This method may only be called when an image is attached to the presentation state. Param height must be created before passing to this method.

Parameters:
height - upon success, the image height (pixels) is returned in this parameter.
Returns:
EC_Normal upon success, an error code otherwise
 o getImageMinMaxPixelRange
public native int getImageMinMaxPixelRange(jDoubleByRef minValue,
                                           jDoubleByRef maxValue)
Gets smallest and biggest possible pixel value in the attached image. These values are defined as the smallest and biggest number that could possibly be contained in the image after application of the Modality transform, but before any VOI, Presentation or Barten transform. This method may only be called when an image is attached to the presentation state.

Parameters:
minValue - upon success, the smallest value is returned in this parameter.
maxValue - upon success, the biggest value is returned in this parameter.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getImageMinMaxPixelValue
public native int getImageMinMaxPixelValue(jDoubleByRef minValue,
                                           jDoubleByRef maxValue)
Gets smallest and biggest occuring pixel value in the attached image. These values are defined as the smallest and biggest number that are actually contained in the image after application of the Modality transform, but before any VOI, Presentation or Barten transform. This method may only be called when an image is attached to the presentation state.

Parameters:
minValue - upon success, the smallest value is returned in this parameter.
maxValue - upon success, the biggest value is returned in this parameter.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getImageReference
public native int getImageReference(int idx,
                                    jDVPrStateParam_GetImageReference param)
UNTESTED - Gets an image reference with the given index.

Parameters:
idx - index, must be < numberOfImageReferences().
param.studyUID - the Study Instance UID is returned in this string
param.seriesUID - the Series Instance UID is returned in this string
param.sopclassUID - the SOP Class UID is returned in this string
param.instanceUID - the SOP Instance UID is returned in this string
param.frames - the list of frames is returned in this string
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o getImageWidth
public native int getImageWidth(jIntByRef width)
Gets the width of the attached image. The rotation status of the presentation state is not taken into account, i.e. the width of an unrotated image is returned. This method may only be called when an image is attached to the presentation state. Param width must be created before passing to this method.

Parameters:
width - upon success, the image width (pixels) is returned in this parameter.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getNumberOfActiveOverlays
public native int getNumberOfActiveOverlays(int layer)
Gets the number of overlays that are currently activated on the given graphic layer.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
number of active overlays
 o getNumberOfCurves
public native int getNumberOfCurves(int layer)
Returns the number of curve activations for the given graphic layer.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
number of curves
 o getNumberOfCurvesInImage
public native int getNumberOfCurvesInImage()
Returns the number of curves in the attached image that could be activated in the presentation state.

Returns:
number of available curves
 o getNumberOfGraphicLayers
public native int getNumberOfGraphicLayers()
Returns the number of graphic layers.

Returns:
number of graphic layers
 o getNumberOfGraphicObjects
public native int getNumberOfGraphicObjects(int layer)
Returns the number of graphic objects for the given graphic layer.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
number of graphic objects
 o getNumberOfOverlaysInImage
public native int getNumberOfOverlaysInImage()
Gets the number of overlays which are embedded in the image currently attached to the presentation state. Overlays in the image are counted only if they are not shadowed by overlays that are embedded in the presentation state and use the same repeating group number.

Returns:
number of overlays in attached image
 o getNumberOfOverlaysInPresentationState
public native int getNumberOfOverlaysInPresentationState()
Gets the number of overlays which are embedded in the presentation state.

Returns:
number of overlays in presentation state
 o getNumberOfPolyShutterVertices
public native int getNumberOfPolyShutterVertices()
Gets polygonal shutter number of points. May only be called if a polygonal shutter is active.

Returns:
the number of points describing the poly shutter
 o getNumberOfTextObjects
public native int getNumberOfTextObjects(int layer)
Returns the number of text objects for the given graphic layer.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
number of text objects
 o getNumberOfVOILUTsInImage
public native int getNumberOfVOILUTsInImage()
Gets the number of VOI LUTs available in the attached image.

Returns:
number of VOI LUTs.
 o getNumberOfVOIWindowsInImage
public native int getNumberOfVOIWindowsInImage()
Gets the number of VOI Windows available in the attached image.

Returns:
number of VOI Windows.
 o getOverlayData
public native int getOverlayData(jDVPrStateParam_GetOverlayData od)
Gets one overlay bitmap. This method may only be called if has beed called before for the current presentation state settings. The parameter is an object from class jDVPrStateParam_GetOverlayData. It must be created and set with the IN-params before passing to this method! OUT-params will be set by this method.

Parameters:
od.layer - index of the graphic layer on which this overlay is activated, must be < getNumberOfGraphicLayers().
od.idx - index of the overlay activation on the given layer, must be < getNumberOfActiveOverlays(layer).
od.overlayData - upon success a pointer to the overlay plane is passed back in this parameter. The overlay plane is organized as one byte per pixel. The byte values are already transformed from pvalues to DDLs.
od.width - upon success the width of the overlay bitmap in pixels is returned in this parameter.
od.height - upon success the height of the overlay bitmap in pixels is returned in this parameter.
od.left - upon success the horizontal position of the overlay relative to the image is returned. 0 means that the overlay is left aligned with the image. Since the overlay is cropped at the borders of the image, values < 0 are impossible.
od.top - upon success the vertical position of the overlay relative to the image is returned.
od.isROI - returns OFTrue if the overlay is ROI, OFFalse if the overlay is Graphic.
od.frame - frame number of the image. Since overlays can differ for different image frames, the image frame also selects the overlays. Default: first frame.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getOverlayInImageActivationLayer
public native int getOverlayInImageActivationLayer(int idx)
Gets the index of the activation layer on which the given overlay from the attached image is activated.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInImage().
Returns:
layer index (which is < getNumberOfGraphicLayers()) if overlay exists and is activated, (-1) otherwise.
 o getOverlayInImageDescription
public native java.lang.String getOverlayInImageDescription(int idx)
Gets the overlay description of the given overlay in the attached image.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInImage().
Returns:
description string if it exists, NULL otherwise.
 o getOverlayInImageGroup
public native int getOverlayInImageGroup(int idx)
Gets the repeating group number of the given overlay in the attached image.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInImage().
Returns:
repeating group number if found, 0 otherwise.
 o getOverlayInImageLabel
public native java.lang.String getOverlayInImageLabel(int idx)
Gets the overlay label of the given overlay in the attached image.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInImage().
Returns:
label string if it exists, NULL otherwise.
 o getOverlayInPresentationStateActivationLayer
public native int getOverlayInPresentationStateActivationLayer(int idx)
Gets the index of the activation layer on which the given overlay from the presentation state is activated. If an overlay is used as a bitmap shutter, it is reported as being not activated by this method.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
layer index (which is < getNumberOfGraphicLayers()) if overlay exists and is activated, DVPS_IDX_NONE otherwise.
 o getOverlayInPresentationStateDescription
public native java.lang.String getOverlayInPresentationStateDescription(int idx)
Gets the overlay description of the given overlay in the presentation state.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
description string if it exists, NULL otherwise.
 o getOverlayInPresentationStateGroup
public native int getOverlayInPresentationStateGroup(int idx)
Gets the repeating group number of the given overlay in the presentation state.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
repeating group number if found, 0 otherwise.
 o getOverlayInPresentationStateLabel
public native java.lang.String getOverlayInPresentationStateLabel(int idx)
Gets the overlay label of the given overlay in the presentation state.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
label string if it exists, NULL otherwise.
 o getPixelData
public native int getPixelData(jDVPrStateParam_GetPixelData pixel)
Apply presentation state to attached image and return image bitmap. This method sets all parameter required to correctly render the pixel data in the image attached to the presentation state and then creates the required pixel data which contains all grayscale transformations but none of the none-grayscale transformations of the presentation state "burned in" into the pixel data. The pixel data returned is already corrected by a Barten transform for the current display device and can be mapped directly to digital driving levels of the graphics board. The pointer to the pixel data remains valid until the next call to this function, or until the image is detached or the presentation state is deleted.

Parameters:
pixel - this object contains a reference to the pixeldata and the height and width of the image. This object must be created before passed as param.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getPixelData
public native int getPixelData(byte pixelData,
                               long size)
Same as method above apart from the fact that the storage area is handled externally.

Parameters:
pixelData - pointer to storage area where the pixel data is copied to. The storage area must be allocated and deleted from the calling method.
size - specifies size of the storage area in bytes.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getPolyShutterVertex
public native int getPolyShutterVertex(int idx,
                                       Point xy)
Get polygonal shutter point. May only be called if a polygonal shutter is active. Shutter points are relative to the origin 1\1 which is the left upper edge of the image. Param xy must be an existing object before passing it to this method!

Parameters:
idx - the index of the shutter point, must be < getNumberOfPolyShutterVertices()
xy - returns the x and y component of the point. xy must be created before passing to this method!
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o getPresentationCreatorsName
public native java.lang.String getPresentationCreatorsName()
Returns the creator's name for the presentation state. If no name is available, NULL is returned.

Returns:
a pointer to a string or NULL.
 o getPresentationDescription
public native java.lang.String getPresentationDescription()
Returns a description for the presentation state. If no description is available, NULL is returned.

Returns:
a pointer to a string or NULL.
 o getPresentationLUT
public native int getPresentationLUT()
Gets the current Presentation LUT type.

Returns:
the current presentation LUT type (from jDVPSPresentationLUTType).
 o getPresentationLUTExplanation
public native java.lang.String getPresentationLUTExplanation()
Returns the LUT explanation of the presentation LUT if it exists and is non-empty. Otherwise returns (null).

Returns:
A string with the explanation.
 o getPresentationLabel
public native java.lang.String getPresentationLabel()
Returns a label for the presentation state. If no label is available, null is returned.

Returns:
a pointer to a string or null.
 o getRadiusOfCircularShutter
public native int getRadiusOfCircularShutter()
Gets circular shutter radius. May only be called if a circular shutter is active. Note: In DICOM, a circular shutter must be rendered with consideration of the image pixel aspect ratio. The radius returned by this method is the number of pixels describing a horizontal line from the center of the circle to its border. See sample figures in NEMA PS3.3:1998.

Returns:
the circ shutter radius
 o getRectShutterLH
public native int getRectShutterLH()
Gets rectangular shutter lower horiztonal edge. May only be called if a rectangular shutter is active.

Returns:
the rect shutter LH edge.
 o getRectShutterLV
public native int getRectShutterLV()
Gets rectangular shutter left vertical edge. May only be called if a rectangular shutter is active.

Returns:
the rect shutter LV edge.
 o getRectShutterRV
public native int getRectShutterRV()
Gets rectangular shutter right vertical edge. May only be called if a rectangular shutter is active.

Returns:
the rect shutter RV edge.
 o getRectShutterUH
public native int getRectShutterUH()
Gets rectangular shutter upper horitontal edge. May only be called if a rectangular shutter is active.

Returns:
the rect shutter UH edge.
 o getRotation
public native int getRotation()
Gets the current rotation status of the presentation state.

Returns:
the current rotation status (from jDVPSRotationType).
 o getScreenData
public native boolean getScreenData(jDVPrStateParam_GetScreenData info)
Gets the pixel data and perfom zooming and scaling with all existing layers. A part of the original data is chosen by point TLHC, a zoom factor and a scaling for x and y. The output size is defined by the array size passed to this method.

Returns:
true on success, false otherwise.
 o getShutterPresentationValue
public native int getShutterPresentationValue()
Gets the shutter presentation value. If no shutter display value exists, a default of 0 (black) is set.

Returns:
the shutter presentation value as 16bit unsigned P-value
 o getTextObject
public J2Ci.jDVPSTextObject getTextObject(int layer,
                                          int idx)
Gets the text object with the given index on the given layer. If the text object or the graphic layer does not exist, NULL is returned.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the text object, must be < getNumberOfTextObjects(layer)
Returns:
the text object.
 o haveActiveVOILUT
public native boolean haveActiveVOILUT()
Check if a VOI LUT is currently active.

Returns:
OFTrue if a VOI LUT is active
 o haveActiveVOIWindow
public native boolean haveActiveVOIWindow()
Check if a VOI window is currently active.

Returns:
true if a VOI window is active
 o haveGraphicLayerRecommendedDisplayValue
public native boolean haveGraphicLayerRecommendedDisplayValue(int idx)
Checks whether a recommended display value for the given graphic layer exists.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
true if a recommended display value exists
 o havePresentationLookupTable
public native boolean havePresentationLookupTable()
Checks if a real Presentation LUT (not shape) is available in the presentation state.

Returns:
OFTrue if the presentation state contains a presentation LUT, no matter if it is activated or not. Returns OFFalse otherwise.
 o haveShutter
public native boolean haveShutter(int type)
Checks if a display shutter of given type is active.

Parameters:
type - the shutter type (from jDVPSShutterType)
Returns:
true if this type of shutter is currently active.
 o invertImage
public native int invertImage()
Inverts image by changing presentation state LUT or presentation state LUT shape. Pixel data has to be re-get after this transformation.

Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o isGrayGraphicLayerRecommendedDisplayValue
public native boolean isGrayGraphicLayerRecommendedDisplayValue(int idx)
Checks whether a recommended display value for the given graphic layer exists and is monochrome.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
true if a recommended display value exists and is monochrome
 o isInverse
public native boolean isInverse()
Checks whether image is inverse (shape, plut or mono1).

Returns:
OFTrue if image is inverse, OFFalse otherwise.
 o moveCurve
public native int moveCurve(int old_layer,
                            int idx,
                            int new_layer)
Moves the curve activation with the given index on the given layer to a different layer.

Parameters:
old_layer - index of the graphic layer on which the curve is, must be < getNumberOfGraphicLayers()
idx - index of the curve activation, must be < getNumberOfCurves(layer)
new_layer - index of the graphic layer to which the curve is moved, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o moveGraphicObject
public native int moveGraphicObject(int old_layer,
                                    int idx,
                                    int new_layer)
Moves the graphic object with the given index on the given layer to a different layer.

Parameters:
old_layer - index of the graphic layer on which the graphic object is, must be < getNumberOfGraphicLayers()
idx - index of the graphic object, must be < getNumberOfGraphicObjects(layer)
new_layer - index of the graphic layer to which the graphic object is moved, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o moveOverlay
public native int moveOverlay(int old_layer,
                              int idx,
                              int new_layer)
Moves the overlay activation with the given index on the given layer to a different layer.

Parameters:
old_layer - index of the graphic layer on which the curve is, must be < getNumberOfGraphicLayers()
idx - index of the overlay activation, must be < getNumberOfActiveOverlays(layer)
new_layer - index of the graphic layer to which the curve is moved, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o moveTextObject
public native int moveTextObject(int old_layer,
                                 int idx,
                                 int new_layer)
Moves the text object with the given index on the given layer to a different layer.

Parameters:
old_layer - index of the graphic layer on which the text object is, must be < getNumberOfGraphicLayers()
idx - index of the text object, must be < getNumberOfTextObjects(layer)
new_layer - index of the graphic layer to which the text object is moved, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o numberOfImageReferences
public native int numberOfImageReferences()
Gets the number of image references in all series managed by this list.

Returns:
number of image references
 o overlayInImageIsROI
public native boolean overlayInImageIsROI(int idx)
Checks whether the given overlay in the attached image is a ROI (region of interest) overlay.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInImage().
Returns:
true if overlay exists and is ROI, false otherwise.
 o overlayInPresentationStateIsROI
public native boolean overlayInPresentationStateIsROI(int idx)
Checks whether the given overlay in the presentation state is a ROI (region of interest) overlay.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
true if overlay exists and is ROI, false otherwise.
 o overlayIsBitmapShutter
public native boolean overlayIsBitmapShutter(int idx)
Checks if the given overlay in the presentation state is currently activated as a bitmap shutter.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
true if overlay exists and is activated as bitmap shutter, false otherwise.
 o overlayIsSuitableAsBitmapShutter
public native boolean overlayIsSuitableAsBitmapShutter(int idx)
Checks if an overlay from the presentation state is suitable for use as a bitmap shutter. An overlay is suitable if it is a graphic overlay with the same size as the attached image and with the origin 1\1. This method does not check wether the overlay is already activated as overlay or bitmap shutter.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
true if overlay can be used as display shutter.
 o removeCurve
public native int removeCurve(int layer,
                              int idx)
Deletes the curve activation with the given index on the given layer.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the curve activation, must be < getNumberOfCurves(layer)
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o removeGraphicLayer
public native int removeGraphicLayer(int idx)
Removes and deletes a graphic layer. All text, graphic, curve and overlay objects on this graphic layer are also deleted or deactivated, respectively.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o removeGraphicObject
public native int removeGraphicObject(int layer,
                                      int idx)
Deletes the graphic object with the given index on the given layer.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the graphic object, must be < getNumberOfGraphicObjects(layer)
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o removeImageReference
public native int removeImageReference(String studyUID,
                                       String seriesUID,
                                       String instanceUID)
Removes a reference to an image from this presentation state.

Parameters:
studyUID - the Study Instance UID of the image reference to be removed.
seriesUID - the Series Instance UID of the image reference to be removed.
instanceUID - the SOP instance UID of the image reference to be removed.
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o removeImageReferenceAttached
public native int removeImageReferenceAttached()
Removes a reference to the currently attached image from this presentation state.

Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o removeOverlayFromPresentationState
public native int removeOverlayFromPresentationState(int idx)
Removes an overlay from the presentation state. If the overlay is activated, the activation is also removed. Since overlays in the presentation state can shadow overlays in the attached image, execution of this method may change the number of overlays reported in the attached image.

Parameters:
idx - index of the overlay, must be < getNumberOfOverlaysInPresentationState().
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o removeShutter
public native void removeShutter(int type)
Deactivates display shutter of given type. After a call to this method haveShutter(type) will return OFFalse.

Parameters:
type - the shutter type (from jDVPSShutterType).
 o removeTextObject
public native int removeTextObject(int layer,
                                   int idx)
Deletes the text object with the given index on the given layer.

Parameters:
layer - index of the graphic layer, must be < getNumberOfGraphicLayers()
idx - index of the text object, must be < getNumberOfTextObjects(layer)
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setBartenTransform
public native void setBartenTransform(boolean flag)
Activates or deactivates Barten correction. Barten transform will only be performed if switched on _and_ a valid monitor character description exists. Default is on.

Parameters:
flag - true to switch on, false to switch off.
 o setCharset
public native int setCharset(int charset)
Sets the specific character set for this presentation state.

Parameters:
charset - the new character set for this text object (from jDVPScharacterSet).
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o setCircularShutter
public native int setCircularShutter(int centerX,
                                     int centerY,
                                     int radius)
Sets and activates circular display shutter. If a bitmap shutter is exists, it is deactivated if this method returns successfully. If no shutter display value exists, a default of 0 (black) is set.

Parameters:
centerX - the X component of the shutter center
centerY - the Y component of the shutter center
radius - the (horizontal) radius of the shutter
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setCurrentPresentationLUT
public native int setCurrentPresentationLUT(int type)
Sets the current Presentation LUT type. DVPSP_table can only be used if the presentation state contains a lookup table, i.e. if havePresentationLookupTable() returns OFTrue.

Parameters:
newType - the new presentation LUT type (from jDVPSPresentationLUTType).
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o setDisplayedAreaBRHC
public native int setDisplayedAreaBRHC(int x,
                                       int y)
Sets the displayed area bottom right hand corner.

Parameters:
x - BRHC X component
y - BRHC Y component
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setDisplayedAreaTLHC
public native int setDisplayedAreaTLHC(int x,
                                       int y)
Sets the displayed area top left hand corner.

Parameters:
x - TLHC X component
y - TLHC Y component
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setFlip
public native int setFlip(boolean isFlipped)
Sets horizontal flip status of the presentation state.

Parameters:
isFlipped - the flip status, true for on, false for off.
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o setGraphicLayerDescription
public native int setGraphicLayerDescription(int idx,
                                             String descr)
Sets a new description to the given graphic layer.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
descr - description of the graphic layer. Must be a valid DICOM Long String.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setGraphicLayerName
public native int setGraphicLayerName(int idx,
                                      String name)
Assigns a new unique name to the given graphic layer. The new name must be unique, otherwise an error code is returned. Upon success, all references (for graphic annotations, curves and overlays) to the given graphic layer are also renamed so that the presentation state remains consistent.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
name - the new name of the graphic layer. Must be a valid DICOM Code String.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setGraphicLayerRecommendedDisplayValueGray
public native int setGraphicLayerRecommendedDisplayValueGray(int idx,
                                                             int gray)
Sets the recommended display value for the given graphic layer.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
gray - the recommended display value as an unsigned 16-bit P-value
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setGraphicLayerRecommendedDisplayValueRGB
public native int setGraphicLayerRecommendedDisplayValueRGB(int idx,
                                                            int r,
                                                            int g,
                                                            int b)
Sets the recommended display value for the given graphic layer.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
r - the R component of the recommended display value as unsigned 16-bit P-value
g - the G component of the recommended display value as unsigned 16-bit P-value
b - the B component of the recommended display value as unsigned 16-bit P-value
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setPolyShutterOrigin
public native int setPolyShutterOrigin(int x,
                                       int y)
Sets polygonal display shutter origin. This method creates a polygonal shutter consisting only of a single point. The polygonal display shutter is deactivated after this method.

Parameters:
x - the x component of the shutter origin
y - the x component of the shutter origin
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setPresentationCreatorsName
public native int setPresentationCreatorsName(String newName)
Sets the presentation state creator's name. The passed string must be a valid DICOM Person Name String (see NEMA PS3.5:1998).

Parameters:
name - the new creator's name
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setPresentationDescription
public native int setPresentationDescription(String descr)
Sets the presentation state description. The passed string must be a valid DICOM Long String (i.e. max 64 characters, no backslash or control chars).

Parameters:
descr - the new presentation state description
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setPresentationLabel
public native int setPresentationLabel(String newLabel)
Sets the presentation state label. The passed string must be a valid DICOM Code String (i.e. max 16 characters, only uppercase and numbers).

Parameters:
label - the new presentation state label
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setRectShutter
public native int setRectShutter(int lv,
                                 int rv,
                                 int uh,
                                 int lh)
Sets and activates rectangular display shutter. If a bitmap shutter is exists, it is deactivated if this method returns successfully. If no shutter display value exists, a default of 0 (black) is set.

Parameters:
lv - the left vertical edge
rv - the right vertical edge
uh - the upper horizontal edge
lh - the lower horizontal edge
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setRotation
public native int setRotation(int rotation)
Sets rotation status of the presentation state.

Parameters:
rotation - the rotation to be set (from jDVPSRotationType).
Returns:
EC_Normal if successful, an error code otherwise (from jE_Condition).
 o setShutterPresentationValue
public native int setShutterPresentationValue(int pvalue)
Sets the shutter presentation value to the given P-value.

Parameters:
pvalue - the shutter presentation value.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setVOILUTFromImage
public native int setVOILUTFromImage(int idx)
Activates one of the VOI LUTs from the attached image.

Parameters:
idx - index of the VOI transform, must be < getNumberOfVOILUTsInImage().
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setVOIWindow
public native int setVOIWindow(double wCenter,
                               double wWidth,
                               String description)
Sets a user defined VOI window center and width.

Parameters:
wCenter - the window center
wWidth - the window width
description - an optional description. Default: absent.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o setVOIWindowFromImage
public native int setVOIWindowFromImage(int idx)
Activates one of the VOI Windows from the attached image.

Parameters:
idx - index of the VOI transform, must be < getNumberOfVOIWindowsInImage().
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o sortGraphicLayers
public native void sortGraphicLayers()
Sorts the graphic layers according to the graphic layer order. Layers with lower order have lower indices after sorting which means that the layers can be drawn to the screen in ascending index order. Calling this routine may result in a re-numbering of the graphic layer orders in a way that does not affect their sequence.

 o toBackGraphicLayer
public native int toBackGraphicLayer(int idx)
Makes a graphic layer the lowest layer for display. This method assigns a graphic layer order lower than all existing graphic layer orders to the given graphic layer, sorts and renumbers the list of graphic layers. Upon success, the given graphic layer is guaranteed to have the new index 0.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o toFrontGraphicLayer
public native int toFrontGraphicLayer(int idx)
Makes a graphic layer the highest layer for display. This method assigns a graphic layer order higher than all existing graphic layer orders to the given graphic layer, sorts and renumbers the list of graphic layers. Upon success, the given graphic layer is guaranteed to have the new index (getNumberOfGraphicLayers()-1).

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).

All Packages  Class Hierarchy  This Package  Previous  Next  Index