📄 dviface.h
字号:
* 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. * @return EC_Normal if the receiver processes could be started, an error code otherwise. */ OFCondition startReceiver(); /** 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. * @return EC_Normal if the receiver process could be terminated, an error code otherwise. */ OFCondition terminateReceiver(); /** starts the query/retrieve server process (Query/Retrieve Service Class SCP). * The query/retrieve process will wait for incoming DICOM associations, serve queries and * send the requested instances to the specified destination. Data will be taken from the * same local database used to store received instances and created presentation states, * stored print objects and hardcopy grayscale images. * The configuration file which is required for the query/retrieve process will be created * automatically from the 'global' configuration file each time this method is called, unless * this automatical creation is disabled (entry: [QUERYRETIUEVE] AutoCreateConfigFile = false). * Attention: Successful return of this method is no guarantee that the query/retrieve server * has successfully started, because certain errors (i.e. incorrect settings in the config file) * will only be noted in the query/retrieve 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. * @return EC_Normal if the query/retrieve process could be started, an error code otherwise. */ OFCondition startQueryRetrieveServer(); /** terminates the query/retrieve server process (Query/Retrieve Service Class SCP). * This method attempts to terminate the query/retrieve process by requesting a * DICOM association with it and delivering a special "shutdown" command. * If for some reason the query/retrieve server cannot be found (i.e. because it has * terminated abnormally), a TCP/IP timeout (several seconds) may occur before this * method returns. * @return EC_Normal if the query/retrieve process could be terminated, * an error code otherwise. */ OFCondition terminateQueryRetrieveServer(); /** tests whether the database has been modified in any way since the last * call to this method. Any write access to the database (adding, deleting, changing) * is reported. This method works by modifying and checking the "modification date/time" * of the database index file. This method is not affected by database locks and can be * called at any time. * Always returns OFTrue for the first call after construction of the interface. * Also returns OFTrue if something goes wrong (i.e. if the method cannot make sure * that nothing has changed). * @return OFTrue if the database has been modified since the last call to this method. */ OFBool newInstancesReceived(); /** 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. * @param targetID symbolic identifier of the send target, must be one of the * strings returned by getTargetID(). * @param studyUID Study Instance UID of the study to be sent. Must be a study * contained in the database. * @return EC_Normal when the send process has successfully been launched, * an error condition otherwise. */ OFCondition sendStudy(const char *targetID, const char *studyUID) { return sendIOD(targetID, studyUID, NULL, NULL); } /** 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. * @param targetID symbolic identifier of the send target, must be one of the * strings returned by getTargetID(). * @param studyUID Study Instance UID of the series to be sent. Must be a series * contained in the database. * @param seriesUID Series Instance UID of the series to be sent. Must be a series * contained in the database. * @return EC_Normal when the send process has successfully been launched, * an error condition otherwise. */ OFCondition sendSeries(const char *targetID, const char *studyUID, const char *seriesUID) { return sendIOD(targetID, studyUID, seriesUID, NULL); } /** sends a single instance (image or presentation state) * 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. * @param targetID symbolic identifier of the send target, must be one of the * strings returned by getTargetID(). * @param studyUID Study Instance UID of the IOD to be sent. Must be an IOD * contained in the database. * @param seriesUID Series Instance UID of the IOD to be sent. Must be an IOD * contained in the database. * @param instanceUID SOP Instance UID of the IOD to be sent. Must be an IOD * contained in the database. * @return EC_Normal when the send process has successfully been launched, * an error condition otherwise. */ OFCondition sendIOD(const char *targetID, const char *studyUID, const char *seriesUID, const char *instanceUID); /** creates a dump of the contents of a DICOM file and displays it on-screen. * A separate application or process is launched to handle the dump and display. * This call returns when the dump operation has successfully been launched. * No information about the status or success of the process itself is being made * available. * This method does not acquire a database lock. * @param filename path of file to be displayed. * @return EC_Normal when the process has successfully been launched, * an error condition otherwise. */ OFCondition dumpIOD(const char *filename); /** creates a dump of the contents of a DICOM file and displays it on-screen. * A separate application or process is launched to handle the dump and display. * This call returns when the dump operation has successfully been launched. * No information about the status or success of the process itself is being made * available. * This method acquires a database lock which must be explicitly freed by the user. * @param studyUID Study Instance UID of the IOD to be dumped. Must be an IOD * contained in the database. * @param seriesUID Series Instance UID of the IOD to be dumped. Must be an IOD * contained in the database. * @param instanceUID SOP Instance UID of the IOD to be dumped. Must be an IOD * contained in the database. * @return EC_Normal when the process has successfully been launched, * an error condition otherwise. */ OFCondition dumpIOD(const char *studyUID, const char *seriesUID, const char *instanceUID); /** checks the contents of a DICOM file and displays an evaluation report on the screen. * A separate application or process is launched to handle the evaluation and display. * This call returns when the check operation has successfully been launched. * No information about the status or success of the process itself is being made * available. * This method does not acquire a database lock. * @param filename path of file to be checked. * @return EC_Normal when the process has successfully been launched, * an error condition otherwise. */ OFCondition checkIOD(const char *filename); /** checks the contents of a DICOM file and displays an evaluation report on the screen. * A separate application or process is launched to handle the evaluation and display. * This call returns when the check operation has successfully been launched. * No information about the status or success of the process itself is being made * available. * This method acquires a database lock which must be explicitly freed by the user. * @param studyUID Study Instance UID of the IOD to be checked. Must be an IOD * contained in the database. * @param seriesUID Series Instance UID of the IOD to be checked. Must be an IOD * contained in the database. * @param instanceUID SOP Instance UID of the IOD to be checked. Must be an IOD * contained in the database. * @return EC_Normal when the process has successfully been launched, * an error condition otherwise. */ OFCondition checkIOD(const char *studyUID, const char *seriesUID, const char *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. * @param filename the file name or path under which the image is saved. * @param pixelData a pointer to the image data. Must contain at least * width*height bytes of data. * @param width the width of the image, must be <= 0xFFFF * @param 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. * @param explicitVR selects the transfer syntax to be written. * True selects Explicit VR Little Endian, False selects Implicit VR Little Endian. * @param 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. * @return EC_Normal upon success, an error code otherwise. */ OFCondition saveDICOMImage( const char *filename, const void *pixelData, unsigned long width, unsigned long height, double aspectRatio=1.0, OFBool explicitVR=OFTrue, const char *instanceUID=NULL); /** saves a monochrome bitmap as a DICOM Secondary Capture image * in the same directory in which the database index file resides. * The filename is generated automatically. * When the image is stored successfully, the database index is updated * to include the new object. * This method releases under any circumstances the database lock if it exists. * @param pixelData a pointer to the image data. Must contain at least * width*height bytes of data. * @param width the width of the image, must be <= 0xFFFF * @param 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. * @return EC_Normal upon success, an error code otherwise. */ OFCondition saveDICOMImage( const void *pixelData, unsigned long width, unsigned long height, double aspectRatio=1.0); /** saves a monochrome bitmap as a DICOM Hardcopy Grayscale image. * The bitmap must use 16 bits per pixel, left to right, top to bottom * order of the pixels. It is assumed that only values 0..4095 are used. * @param filename the file name or path under which the image is saved. * @param pixelData a pointer to the image data. Must contain at least * width*height*2 bytes of data. * @param width the width of the image, must be <= 0xFFFF * @param 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. * @param explicitVR selects the transfer syntax to be written. * True selects Explicit VR Little Endian, False selects Implicit VR Little Endian. * @param 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. * @return EC_Normal upon success, an error code otherwise. */ OFCondition saveHardcopyGrayscaleImage( const char *filename, const void *pixelData, unsigned long width, unsigned long height, double aspectRatio=1.0, OFBool explicitVR=OFTrue, const char *instanceUID=NULL); /** saves a monochrome bitmap as a DICOM Hardcopy Grayscale image * in the same directory in which the database index file resides. * The filename is generated automatically. * When the image is stored successfully, the database index is updated * to include the new object. * This method releases under any circumstances the database lock if it exists. * @param pixelData a pointer to the image data. Must contain at least
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -