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

Class J2Ci.jDVInterface

Object
   |
   +----J2Ci.jDVInterface

public class jDVInterface
extends Object
A jDVInterface represents the relating C++-Class DVInterface in Java.

Author:
Andreas Schröter

Constructor Index

 o J2Ci.jDVInterface(String)
Constructor, creates a relating C++-Object.

Method Index

 o deleteInstance(String, String, String)
Removes an image
 o deleteSeries(String, String)
Removes a series.
 o deleteStudy(String)
Removes a study
 o disablePState()
Stores the current presentation state in a temporary place and creates a new presentation state that corresponds with an image displayed "without" presentation state.
 o enablePState()
Restores the stored presentation state (see disablePresentationState) and deletes the temporary presentation state.
 o finalize()
Destructor, removes *this* relating C++-Object out of memory
 o getAccessionNumber()
Returns the accession number of a study which is selected by "selectStudy".
 o getAmbientLightValue(jDoubleByRef)
Returns ambient light value for the Barten transformation.
 o getCurrentPState()
Gets the current PresentationState-Object
 o getDatabaseFolder()
Returns the database folder to be used for sending/receiving/browsing.
 o getEthnicGroup()
Returns the PatientEthnicGroup of a study which is selected by the method selectStudy
 o getFilename(String, String, String)
Searches in the database for a DICOM instance with the given study, series and instance UIDs and returns its pathname if found.
 o getGUIConfigEntry(String)
Returns the value of configuration file entry key=value in the section GENERAL/GUI of the config file.
 o getGUIConfigEntryBool(String, boolean)
Returns the value of configuration file entry key=value in the section GENERAL/GUI of the config file.
 o getImageNumber()
Returns the image number of an instance which is selected by the methods selectStudy, selectSeries and selectInstance
 o getInstanceStatus()
Gets the state of the selected image.
 o getInstanceUID()
Gets the UID of the selected image.
 o getModality()
Gets the modality of the selected image.
 o getMonitorCharacteristicsFile()
Returns the filename (path) of the monitor characteristics file used to implement the Barten transform, as configured in section GENERAL/MONITOR/CHARACTERICSTICS in the config file.
 o getNameOfPhysiciansReadingStudy()
Returns the name of a physician reading a selected study by "selectStudy".
 o getNetworkAETitle()
Returns the AETitle with which this application should identify itself.
 o getNetworkBitPreserving()
Returns the BITPRESERVINGMODE entry for the network receiver from the section GENERAL/NETWORK in the config file.
 o getNetworkDisableNewVRs()
Returns the DISABLENEWVRS entry for the network receiver from the section GENERAL/NETWORK in the config file.
 o getNetworkImplicitVROnly()
Returns the IMPLICITONLY entry for the network receiver from the section GENERAL/NETWORK in the config file.
 o getNetworkMaxPDU()
Returns the MAXPDU entry for the network receiver from the section GENERAL/NETWORK in the config file.
 o getNetworkPort()
Returns the PORT entry for the network receiver from the section GENERAL/NETWORK in the config file.
 o getNumberOfInstances()
Gets the number of images.
 o getNumberOfPStates()
Returns number of presentation states referencing the currently selected image.
 o getNumberOfSeries()
Gets the number of series.
 o getNumberOfStudies()
Gets the amount of studies.
 o getNumberOfTargets()
Gets the number of possible targets.
 o getOtherPatientID()
Returns the OtherPatientID of a study which is selected by the method selectStudy
 o getOtherPatientNames()
Returns the Other Patient Names of a study which is selected by the method selectStudy
 o getPStateDescription(int)
Returns description of specified presentation state referencing the currently selected image.
 o getPStateLabel(int)
Returns label of specified presentation state referencing the currently selected image.
 o getPatientBirthDate()
Returns the PatientBirthDate of a study which is selected by the method selectStudy
 o getPatientBirthTime()
Returns the PatientBirthTime of a study which is selected by the method selectStudy
 o getPatientID()
Returns the PatientID of a study which is selected by the method selectStudy
 o getPatientName()
Returns the Patient's Name of a study which is selected by the method selectStudy
 o getPatientSex()
Returns the PatientSex of a study which is selected by the method selectStudy
 o getPresentationDescription()
Returns the Presentation Description of the currently selected instance.
 o getPresentationLabel()
Returns the Presentation Label of the currently selected instance.
 o getReceiverName()
Returns the filename (path) of the DICOM Store SCP application used for receiving images, as configured in section GENERAL/NETWORK/RECEIVER in the config file.
 o getReferringPhysiciansName()
Returns the referring physicians name of a study which is selected by "selectStudy".
 o getSenderName()
Returns the filename (path) of the DICOM Store SCU application used for sending images, as configured in section GENERAL/NETWORK/SENDER in the config file.
 o getSeriesDate()
Returns the series date of a series which is selected by "selectSeries".
 o getSeriesDescription()
Returns the series description of a series which is selected by "selectSeries".
 o getSeriesNumber()
Returns the series number of a series which is selected by "selectSeries"
 o getSeriesOperatorsName()
Returns the series operators name of a series which is selected by "selectSeries".
 o getSeriesPerformingPhysiciansName()
Returns the series performing physicians name of a series which is selected by "selectSeries".
 o getSeriesProtocolName()
Returns the series protocol name of a series which is selected by "selectSeries".
 o getSeriesStatus()
Gets the state of the selected series.
 o getSeriesTime()
Returns the series time of a series which is selected by "selectSeries".
 o getSeriesUID()
Gets the UID of the selected series.
 o getStudyDate()
Returns the study date of a study which is selected by "selectStudy".
 o getStudyDescription()
Gets the desciption of the selected study.
 o getStudyStatus()
Gets the state of the selected study.
 o getStudyTime()
Returns the study time of a study which is selected by "selectStudy".
 o getStudyUID()
Gets the UID of the selected study
 o getTargetAETitle(String)
Returns the HOSTNAME entry for the communication partner with the given target ID from the configuration file.
 o getTargetDescription(int)
Gets the description of a target at an index.
 o getTargetDescription(String)
Gets a target description of a target with a known ID.
 o getTargetDisableNewVRs(String)
Returns the DISABLENEWVRS entry for the communication partner with the given target ID from the configuration file.
 o getTargetHostname(String)
Returns the HOSTNAME entry for the communication partner with the given target ID from the configuration file.
 o getTargetID(int)
Gets a target with at an index.
 o getTargetImplicitOnly(String)
Returns the IMPLICITONLY entry for the communication partner with the given target ID from the configuration file.
 o getTargetMaxPDU(String)
Returns the MAXPDU entry for the communication partner with the given target ID from the configuration file.
 o getTargetPort(String)
Returns the PORT entry for the communication partner with the given target ID from the configuration file.
 o instanceReviewed(String, String, String)
If the image is reviewed, the state of the database can be changed from "isNew" to "isNotNew".
 o isBartenTransformPossible()
Checks whether Barten correction is possible, i.e.
 o isPresentationState()
Checks if the image is a PresentationState.
 o isPresentationStateSeries()
Checks if this Series contains a PresentationState.
 o loadImage(String)
Loads an image/instance
 o loadImage(String, String, String)
Loads an image from a series/study
 o loadPState(String, String)
Loads a PresentationState for an image
 o loadPState(String, String, String)
Loads a PresentationState for a study/series
 o lockDatabase(boolean)
Create exclusiv access to the database
 o newInstancesReceived()
Tests whether new DICOM objects have been received and added to the database since the last call to this method.
 o releaseDatabase()
Releases the database.
 o resetPresentationState()
Resets the presentation state object to the status it had immediately after the last successful operation of "loadImage" or "loadPState".
 o saveCurrentImage(String, boolean)
Saves the DICOM image that is currently attached to the presentation state in a file with the given path and filename.
 o saveDICOMImage(String, byte[], long, long, double)
Saves a monochrome bitmap as a DICOM Secondary Capture image.
 o saveDICOMImage(String, byte[], long, long, double, boolean, String)
saves a monochrome bitmap as a DICOM Secondary Capture image.
 o savePState()
Saves a PresentationState
 o savePState(String, boolean)
Saves a PresentationState as...
 o selectInstance(int)
Selects an image.
 o selectPState(int, boolean)
Selects and loads specified presentation state referencing the currently selected image.
 o selectSeries(int)
Selects a series.
 o selectStudy(int)
Select a study.
 o sendIOD(String, String, String, String)
Sends an IOD to another application or modality
 o sendSeries(String, String, String)
Sends a complete series over network to a different DICOM peer.
 o sendStudy(String, String)
Sends a complete study over network to a different DICOM peer.
 o setAmbientLightValue(double)
Sets ambient light value for the Barten transformation.
 o startReceiver()
Starts the network receiver process (Storage Service Class SCP).
 o terminateReceiver()
Terminates the network receiver process (Storage Service Class SCP).

Constructors

 o jDVInterface
public jDVInterface(String configfile)
Constructor, creates a relating C++-Object.

Parameters:
configfile - s String defining the name of the config file.

Methods

 o deleteInstance
public native int deleteInstance(String studyUID,
                                 String seriesUID,
                                 String instanceUID)
Removes an image

Parameters:
studyUID - UID of Study
seriesUID - UID of Series
instanceUID - UID of Image
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o deleteSeries
public native int deleteSeries(String studyUID,
                               String seriesUID)
Removes a series.

Parameters:
studyUID - UID of study
seriesUID - UID of series
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o deleteStudy
public native int deleteStudy(String studyUID)
Removes a study

Parameters:
studyUID - UID of Study
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o disablePState
public native int disablePState()
Stores the current presentation state in a temporary place and creates a new presentation state that corresponds with an image displayed "without" presentation state. If called twice, an error code is returned.

Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o enablePState
public native int enablePState()
Restores the stored presentation state (see disablePresentationState) and deletes the temporary presentation state. If no stored presentation state exists, returns an error.

Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o finalize
protected void finalize()
Destructor, removes *this* relating C++-Object out of memory

Overrides:
finalize in class Object
 o getAccessionNumber
public native java.lang.String getAccessionNumber()
Returns the accession number of a study which is selected by "selectStudy".

Returns:
accession number
 o getAmbientLightValue
public native int getAmbientLightValue(jDoubleByRef value)
Returns ambient light value for the Barten transformation.

Parameters:
value - returned ambient light value. The object of class jDoubleByRef must be created before passing to this method!
Returns:
EC_Normal upon success, an error code otherwise(from jE_Condition).
 o getCurrentPState
public J2Ci.jDVPresentationState getCurrentPState()
Gets the current PresentationState-Object

Returns:
jDVPresentationState-Object
 o getDatabaseFolder
public native java.lang.String getDatabaseFolder()
Returns the database folder to be used for sending/receiving/browsing. Value is taken from the section GENERAL/DATABASE/DIRECTORY in the config file. If absent, a default value is returned.

Returns:
database folder path. Never returns NULL.
 o getEthnicGroup
public native java.lang.String getEthnicGroup()
Returns the PatientEthnicGroup of a study which is selected by the method selectStudy

 o getFilename
public native java.lang.String getFilename(String studyUID,
                                           String seriesUID,
                                           String instanceUID)
Searches in the database for a DICOM instance with the given study, series and instance UIDs and returns its pathname if found. If the given instance is not found in the database, NULL is returned. This method may only be called when the database is locked.

Parameters:
studyUID - the DICOM study instance UID
seriesUID - the DICOM series instance UID
instanceUID - the DICOM SOP instance UID
Returns:
filename (path) if found, NULL otherwise
 o getGUIConfigEntry
public native java.lang.String getGUIConfigEntry(String key)
Returns the value of configuration file entry key=value in the section GENERAL/GUI of the config file. If the entry is absent, NULL is returned.

Parameters:
key - the entry key
Returns:
entry value or NULL.
 o getGUIConfigEntryBool
public native boolean getGUIConfigEntryBool(String key,
                                            boolean dfl)
Returns the value of configuration file entry key=value in the section GENERAL/GUI of the config file. If the entry is absent or cannot be parsed, the default dfl is returned.

Parameters:
key - the entry key
dfl - the default to be used if the value is absent or incorrect
Returns:
entry value or default.
 o getImageNumber
public native java.lang.String getImageNumber()
Returns the image number of an instance which is selected by the methods selectStudy, selectSeries and selectInstance

 o getInstanceStatus
public native int getInstanceStatus()
Gets the state of the selected image.

Returns:
Value fom jDVIFhierarchyStatus
 o getInstanceUID
public native java.lang.String getInstanceUID()
Gets the UID of the selected image.

Returns:
UID
 o getModality
public native java.lang.String getModality()
Gets the modality of the selected image.

Returns:
The modality.
 o getMonitorCharacteristicsFile
public native java.lang.String getMonitorCharacteristicsFile()
Returns the filename (path) of the monitor characteristics file used to implement the Barten transform, as configured in section GENERAL/MONITOR/CHARACTERICSTICS in the config file.

Returns:
monitor characteristics path name or null
 o getNameOfPhysiciansReadingStudy
public native java.lang.String getNameOfPhysiciansReadingStudy()
Returns the name of a physician reading a selected study by "selectStudy".

Returns:
name of physician
 o getNetworkAETitle
public native java.lang.String getNetworkAETitle()
Returns the AETitle with which this application should identify itself. The AETitle is taken from the section GENERAL/NETWORK in the config file. If absent, a default value is returned.

Returns:
AETitle for this application. Never returns NULL.
 o getNetworkBitPreserving
public native boolean getNetworkBitPreserving()
Returns the BITPRESERVINGMODE entry for the network receiver from the section GENERAL/NETWORK in the config file.

Returns:
entry if present in the config file, OFFalse otherwise.
 o getNetworkDisableNewVRs
public native boolean getNetworkDisableNewVRs()
Returns the DISABLENEWVRS entry for the network receiver from the section GENERAL/NETWORK in the config file.

Returns:
entry if present in the config file, OFFalse otherwise.
 o getNetworkImplicitVROnly
public native boolean getNetworkImplicitVROnly()
Returns the IMPLICITONLY entry for the network receiver from the section GENERAL/NETWORK in the config file.

Returns:
entry if present in the config file, OFFalse otherwise.
 o getNetworkMaxPDU
public native int getNetworkMaxPDU()
Returns the MAXPDU entry for the network receiver from the section GENERAL/NETWORK in the config file.

Returns:
entry if present and parsable in the config file, 0 otherwise.
 o getNetworkPort
public native int getNetworkPort()
Returns the PORT entry for the network receiver from the section GENERAL/NETWORK in the config file.

Returns:
entry if present and parsable in the config file, 0 otherwise.
 o getNumberOfInstances
public native int getNumberOfInstances()
Gets the number of images.

Returns:
Number of images.
 o getNumberOfPStates
public native int getNumberOfPStates()
Returns number of presentation states referencing the currently selected image. If no instance is currently selected or the selected instance is a presentation state, returns an error.

Returns:
number of presentation states, 0 if none available or an error occurred
 o getNumberOfSeries
public native int getNumberOfSeries()
Gets the number of series.

Returns:
Number of series.
 o getNumberOfStudies
public native int getNumberOfStudies()
Gets the amount of studies.

Returns:
amount of studies.
 o getNumberOfTargets
public native int getNumberOfTargets()
Gets the number of possible targets.

Returns:
Number of targets.
 o getOtherPatientID
public native java.lang.String getOtherPatientID()
Returns the OtherPatientID of a study which is selected by the method selectStudy

 o getOtherPatientNames
public native java.lang.String getOtherPatientNames()
Returns the Other Patient Names of a study which is selected by the method selectStudy

 o getPStateDescription
public native java.lang.String getPStateDescription(int idx)
Returns description of specified presentation state referencing the currently selected image.

Parameters:
idx - index to be selected, must be < getNumberOfPStates()
Returns:
presentation state description or NULL if idx is invalid.
 o getPStateLabel
public native java.lang.String getPStateLabel(int idx)
Returns label of specified presentation state referencing the currently selected image.

Parameters:
idx - index to be selected, must be < getNumberOfPStates()
Returns:
presentation state label or NULL idx is invalid
 o getPatientBirthDate
public native java.lang.String getPatientBirthDate()
Returns the PatientBirthDate of a study which is selected by the method selectStudy

 o getPatientBirthTime
public native java.lang.String getPatientBirthTime()
Returns the PatientBirthTime of a study which is selected by the method selectStudy

 o getPatientID
public native java.lang.String getPatientID()
Returns the PatientID of a study which is selected by the method selectStudy

 o getPatientName
public native java.lang.String getPatientName()
Returns the Patient's Name of a study which is selected by the method selectStudy

 o getPatientSex
public native java.lang.String getPatientSex()
Returns the PatientSex of a study which is selected by the method selectStudy

 o getPresentationDescription
public native java.lang.String getPresentationDescription()
Returns the Presentation Description of the currently selected instance. May be called only if a valid instance selection exists - see selectInstance(). This method acquires a database lock which must be explicitly freed by the user.

Returns:
Presentation Description or NULL if absent or not selected.
 o getPresentationLabel
public native java.lang.String getPresentationLabel()
Returns the Presentation Label of the currently selected instance. May be called only if a valid instance selection exists - see selectInstance(). This method acquires a database lock which must be explicitly freed by the user.

Returns:
Presentation Label or NULL if absent or not selected.
 o getReceiverName
public native java.lang.String getReceiverName()
Returns the filename (path) of the DICOM Store SCP application used for receiving images, as configured in section GENERAL/NETWORK/RECEIVER in the config file.

Returns:
receive application path name or NULL if absent.
 o getReferringPhysiciansName
public native java.lang.String getReferringPhysiciansName()
Returns the referring physicians name of a study which is selected by "selectStudy".

Returns:
physicians name
 o getSenderName
public native java.lang.String getSenderName()
Returns the filename (path) of the DICOM Store SCU application used for sending images, as configured in section GENERAL/NETWORK/SENDER in the config file.

Returns:
send application path name or NULL if absent.
 o getSeriesDate
public native java.lang.String getSeriesDate()
Returns the series date of a series which is selected by "selectSeries".

Returns:
series date
 o getSeriesDescription
public native java.lang.String getSeriesDescription()
Returns the series description of a series which is selected by "selectSeries".

Returns:
series description
 o getSeriesNumber
public native java.lang.String getSeriesNumber()
Returns the series number of a series which is selected by "selectSeries"

Returns:
series number
 o getSeriesOperatorsName
public native java.lang.String getSeriesOperatorsName()
Returns the series operators name of a series which is selected by "selectSeries".

Returns:
operator name
 o getSeriesPerformingPhysiciansName
public native java.lang.String getSeriesPerformingPhysiciansName()
Returns the series performing physicians name of a series which is selected by "selectSeries".

Returns:
physician name
 o getSeriesProtocolName
public native java.lang.String getSeriesProtocolName()
Returns the series protocol name of a series which is selected by "selectSeries".

Returns:
protocol name
 o getSeriesStatus
public native int getSeriesStatus()
Gets the state of the selected series.

Returns:
Value from jDVIFhierarchyStatus
 o getSeriesTime
public native java.lang.String getSeriesTime()
Returns the series time of a series which is selected by "selectSeries".

Returns:
series time
 o getSeriesUID
public native java.lang.String getSeriesUID()
Gets the UID of the selected series.

Returns:
UID
 o getStudyDate
public native java.lang.String getStudyDate()
Returns the study date of a study which is selected by "selectStudy".

Returns:
study date
 o getStudyDescription
public native java.lang.String getStudyDescription()
Gets the desciption of the selected study.

Returns:
Description
 o getStudyStatus
public native int getStudyStatus()
Gets the state of the selected study.

Returns:
Value (from jDVIFhierarchyStatus).
 o getStudyTime
public native java.lang.String getStudyTime()
Returns the study time of a study which is selected by "selectStudy".

Returns:
study time
 o getStudyUID
public native java.lang.String getStudyUID()
Gets the UID of the selected study

Returns:
UID
 o getTargetAETitle
public native java.lang.String getTargetAETitle(String targetID)
Returns the HOSTNAME entry for the communication partner with the given target ID from the configuration file.

Parameters:
targetID - communication target ID, must be one of the target identifiers returned by getTargetID().
Returns:
entry if present in the config file, NULL otherwise.
 o getTargetDescription
public native java.lang.String getTargetDescription(int idx)
Gets the description of a target at an index.

Parameters:
idx - Index of target.
Returns:
Target description
 o getTargetDescription
public native java.lang.String getTargetDescription(String targetID)
Gets a target description of a target with a known ID.

Parameters:
descr - ID of target
Returns:
Target description
 o getTargetDisableNewVRs
public native boolean getTargetDisableNewVRs(String targetID)
Returns the DISABLENEWVRS entry for the communication partner with the given target ID from the configuration file.

Parameters:
targetID - communication target ID, must be one of the target identifiers returned by getTargetID().
Returns:
entry if present in the config file, OFFalse otherwise.
 o getTargetHostname
public native java.lang.String getTargetHostname(String targetID)
Returns the HOSTNAME entry for the communication partner with the given target ID from the configuration file.

Parameters:
targetID - communication target ID, must be one of the target identifiers returned by getTargetID().
Returns:
entry if present in the config file, NULL otherwise.
 o getTargetID
public native java.lang.String getTargetID(int idx)
Gets a target with at an index.

Parameters:
idx - Index of target
Returns:
ID of the target.
 o getTargetImplicitOnly
public native boolean getTargetImplicitOnly(String targetID)
Returns the IMPLICITONLY entry for the communication partner with the given target ID from the configuration file.

Parameters:
targetID - communication target ID, must be one of the target identifiers returned by getTargetID().
Returns:
entry if present in the config file, OFFalse otherwise.
 o getTargetMaxPDU
public native int getTargetMaxPDU(String targetID)
Returns the MAXPDU entry for the communication partner with the given target ID from the configuration file.

Parameters:
targetID - communication target ID, must be one of the target identifiers returned by getTargetID().
Returns:
entry if present and parsable in the config file, 0.
 o getTargetPort
public native int getTargetPort(String targetID)
Returns the PORT entry for the communication partner with the given target ID from the configuration file.

Parameters:
targetID - communication target ID, must be one of the target identifiers returned by getTargetID().
Returns:
entry if present and parsable in the config file, 0.
 o instanceReviewed
public native int instanceReviewed(String studyUID,
                                   String seriesUID,
                                   String instanceUID)
If the image is reviewed, the state of the database can be changed from "isNew" to "isNotNew".

Parameters:
studyUID - UID of Study
seriesUID - UID of Series
instanceUID - UID of Image
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o isBartenTransformPossible
public native boolean isBartenTransformPossible()
Checks whether Barten correction is possible, i.e. a valid monitor characteristics description exists and current system is a low-cost system (without built-in calibration).

 o isPresentationState
public native boolean isPresentationState()
Checks if the image is a PresentationState.

Returns:
true, if yes.
 o isPresentationStateSeries
public native boolean isPresentationStateSeries()
Checks if this Series contains a PresentationState.

Returns:
true, if yes.
 o loadImage
public native int loadImage(String filename)
Loads an image/instance

Parameters:
filename - filename of the instance
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o loadImage
public native int loadImage(String studyUID,
                            String seriesUID,
                            String instanceUID)
Loads an image from a series/study

Parameters:
studyUID - UID of Study
seriesUID - UID of Series
instanceUID - UID of Image
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o loadPState
public native int loadPState(String pstName,
                             String imgName)
Loads a PresentationState for an image

Parameters:
pstName - Name of PresentationStates
imgName - Name of Image
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o loadPState
public native int loadPState(String studyUID,
                             String seriesUID,
                             String instanceUID)
Loads a PresentationState for a study/series

Parameters:
studyUID - UID of Study
seriesUID - UID of Series
instanceUID - UID of Image
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o lockDatabase
public native int lockDatabase(boolean exclusive)
Create exclusiv access to the database

Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o newInstancesReceived
public native boolean newInstancesReceived()
Tests whether new DICOM objects have been received and added to the database since the last call to this method.

Parameters:
true - if new instances have been received.
 o releaseDatabase
public native int releaseDatabase()
Releases the database. Removes any shared or exclusive lock on the database. This method should be called when a database transaction is finished (i.e. reading studies, ...). As long as a lock exists on the db, no other application can add new images to the db.

Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o resetPresentationState
public native int resetPresentationState()
Resets the presentation state object to the status it had immediately after the last successful operation of "loadImage" or "loadPState".

Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o saveCurrentImage
public native int saveCurrentImage(String filename,
                                   boolean explicitVR)
Saves the DICOM image that is currently attached to the presentation state in a file with the given path and filename. This method does not acquire a database lock and does not register the saved presentation state in the database.

Parameters:
filename - path and filename under which the image is to be saved
explicitVR - selects the transfer syntax to be written. True (the default) selects Explicit VR Little Endian, False selects Implicit VR Little Endian.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o saveDICOMImage
public native int saveDICOMImage(String filename,
                                 byte pixelData,
                                 long width,
                                 long height,
                                 double aspectRatio)
Saves a monochrome bitmap as a DICOM Secondary Capture image. The bitmap must use one byte per pixel, left to right, top to bottom order of the pixels. 0 is interpreted as black, 255 as white.

Parameters:
filename - the file name or path under which the image is saved.
pixelData - a pointer to the image data. Must contain at least width*height bytes of data.
width - the width of the image, must be <= 0xFFFF
height - the height of the image, must be <= 0xFFFF
aspectRatio - the pixel aspect ratio as width/height. If omitted, a pixel aspect ratio of 1/1 is assumed (default is 1.0).
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o saveDICOMImage
public native int saveDICOMImage(String filename,
                                 byte pixelData,
                                 long width,
                                 long height,
                                 double aspectRatio,
                                 boolean explicitVR,
                                 String instanceUID)
saves a monochrome bitmap as a DICOM Secondary Capture image. The bitmap must use one byte per pixel, left to right, top to bottom order of the pixels. 0 is interpreted as black, 255 as white.

Parameters:
filename - the file name or path under which the image is saved.
pixelData - a pointer to the image data. Must contain at least width*height bytes of data.
width - the width of the image, must be <= 0xFFFF
height - the height of the image, must be <= 0xFFFF
aspectRatio - the pixel aspect ratio as width/height. If omitted, a pixel aspect ratio of 1/1 is assumed.
explicitVR - selects the transfer syntax to be written. True selects Explicit VR Little Endian, False selects Implicit VR Little Endian.
instanceUID - optional parameter containing the SOP Instance UID to be written. This parameter should be omitted unless the SOP Instance UID needs to be controlled externally.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o savePState
public native int savePState()
Saves a PresentationState

Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o savePState
public native int savePState(String filename,
                             boolean explicitVR)
Saves a PresentationState as...

Parameters:
filename - Filename of PresentationState
explicitVR - selects the transfer syntax explicit/implicit VR little endian.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o selectInstance
public native int selectInstance(int idx)
Selects an image.

Parameters:
idx - Index of image.
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o selectPState
public native int selectPState(int idx,
                               boolean changeStatus)
Selects and loads specified presentation state referencing the currently selected image.

Parameters:
idx - index to be selected, must be < getNumberOfPStates()
changeStatus - if true the presentation state is marked 'reviewed' (not new)
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o selectSeries
public native int selectSeries(int idx)
Selects a series.

Parameters:
idx - Index of series
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o selectStudy
public native int selectStudy(int idx)
Select a study.

Parameters:
idx - Index of study
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o sendIOD
public native int sendIOD(String targetID,
                          String studyUID,
                          String seriesUID,
                          String instanceUID)
Sends an IOD to another application or modality

Parameters:
targetID - ID of target
studyUID - UID of Study
seriesUID - UID of Series
instanceUID - UID of Image
Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).
 o sendSeries
public native int sendSeries(String targetID,
                             String studyUID,
                             String seriesUID)
Sends a complete series over network to a different DICOM peer. A separate application or process is launched to handle the send operation. This call returns when the send operation has successfully been launched. No information about the status or success of the transfer itself is being made available.

Parameters:
targetID - symbolic identifier of the send target, must be one of the strings returned by getTargetID().
studyUID - Study Instance UID of the series to be sent. Must be a series contained in the database.
seriesUID - Series Instance UID of the series to be sent. Must be a series contained in the database.
Returns:
EC_Normal when the send process has successfully been launched, an error condition otherwise (from jE_Condition).
 o sendStudy
public native int sendStudy(String targetID,
                            String studyUID)
Sends a complete study over network to a different DICOM peer. A separate application or process is launched to handle the send operation. This call returns when the send operation has successfully been launched. No information about the status or success of the transfer itself is being made available.

Parameters:
targetID - symbolic identifier of the send target, must be one of the strings returned by getTargetID().
studyUID - Study Instance UID of the study to be sent. Must be a study contained in the database.
Returns:
EC_Normal when the send process has successfully been launched, an error condition otherwise (from jE_Condition).
 o setAmbientLightValue
public native int setAmbientLightValue(double value)
Sets ambient light value for the Barten transformation.

Parameters:
value - ambient light value to be set
Returns:
EC_Normal upon success, an error code otherwise(from jE_Condition).
 o startReceiver
public native int startReceiver()
Starts the network receiver process (Storage Service Class SCP). The receiver process will wait for incoming DICOM associations, receive images and presentation states. Data will be stored in file and registered in the database index file. Attention: Successful return of this method is no guarantee that the network receiver has successfully started, because certain errors (i.e. incorrect settings in the config file) will only be noted in the network receiver process when running. On Unix platform, successful return of this method means that the fork() used to start the receiver was successful. On Win32 platforms, it means that the CreateProcess() call was successful.

Returns:
EC_Normal if the receiver process could be started, an error code otherwise (from jE_Condition).
 o terminateReceiver
public native int terminateReceiver()
Terminates the network receiver process (Storage Service Class SCP). This method attempts to terminate the network receiver process by requesting a DICOM association with it and delivering a special "shutdown" command. If for some reason the network receiver cannot be found (i.e. because it has terminated abnormally), a TCP/IP timeout (several seconds) may occur before this method returns.

Returns:
EC_Normal upon success, an error code otherwise (from jE_Condition).

All Packages  Class Hierarchy  This Package  Previous  Next  Index