References ▼
This is the interface for the LEAD DICOM Reader.
| Type | Name | Description |
|---|---|---|
| VARIANT_BOOL | IsCompressedStream | A read-only property that indicates whether the stream is compressed. A value of VARIANT_TRUE indicates that the stream is either MPEG-2, MPEG-4, H.264, or MPEG-TS. Otherwise, the value is VARIANT_FALSE. |
| LONG_PTR | get_DicomDSPtr | Retrieves the currently initialized DICOM dataset. Typecast this pointer to LDicomDS before using it. Do not make changes to the dataset after the filter is connected, since this might cause problems with the LEAD DICOM Reader. Use this property, instead of get_DicomDS, to obtain the dataset. It is compatible with both 32 and 64 bit platforms. |
Sets the DICOM dataset inside the LEAD DICOM Reader filter.
Pointer to the user dataset.
A value that specifies whether the filter should make a copy of the passed dataset for future usage. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Make a copy of the dataset (allocating memory for it, and maintaining responsibility for freeing this memory). |
| FALSE | The user will take care of the pointer life (and ensure its availability for the Writer as long as it is needed). |
This method should be used instead of SetDicomDS for compatibility on both 32 bit and 64 bit platforms. Before using this method you need to first create and initialize a dataset using the raster toolkit and LDicomDS::InitDS and either LDicomDS::LoadDS or LDicomDS::LoadDSMemory.
Use this method, instead of SetDicomDS, to assign the dataset. It is compatible with both 32 and 64 bit platforms. This method fails if:
The LEAD DICOM Reader is already connected.
The dataset contains no pixel data.
The pixel data could not be read properly.
Call this method with pDS set to NULL:
To stop the LEAD DICOM Reader from using the dataset.
Before freeing the dataset's memory.
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Sets the input file name.
Pointer to OLESTR representing the string that contains the input DICOM file.
You should set the InputFileName to NULL. Be sure to set an input dataset using SetDicomDS because otherwise you will have no input data and the filter will fail to connect. The method fails under the following conditions:
The filter output pin is already connected.
A user dataset is initialized.
The input file contains no pixel data.
The input file is not a valid DICOM file.
The length of the input file name exceeds the maximum length allowed for a file name (260 characters).
The default value is \"\". Note that the DICOM file may contain MPEG2 or H.264/AVCdata, which would require that a MPEG-2 video decoder be installed before the file could be played.
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Retrieves the input file name.
Address of a pointer to the returned DICOM input file name.
This method allocates memory for the string. You are responsible for freeing the memory by using SysFreeString().
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Gets a value that indicates whether the output pin is connected.
Pointer to a variable that will receive the connection state of the output pin. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | The output pin is connected. |
| FALSE | The output pin is not connected. |
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Retrieves the currently initialized DICOM dataset.
Address of a pointer to the returned dataset.
Typecast pDS to LDicomDS before using it. Do not make changes to the dataset after the filter is connected, since this might cause problems with the LEAD DICOM Reader. This method is only compatible with 32 bit platforms. Use get_DicomDSPtr instead.
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Sets the frame time (the time each frame is displayed while playing the PixelData), in milliseconds.
New frame time value in milliseconds.
Possible values range between 20 and 1000. The Frame Control feature must be enabled in order to control the frame time (and thus the play speed). If frame time is not enabled, the stream plays with the frame time set to 40 milliseconds (25 frames per second).
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Retrieves the frame time (the time each frame is displayed while playing the PixelData), in milliseconds. The default value is 40.
Pointer to a variable that will receive the current frame time.
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Sets the frame control using put_FrameTime or set through the interface by using the property page.
A Boolean value that enables or disables frame control. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Enable frame control. |
| FALSE | Disable frame control. |
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Retrieves a value that indicates whether frame control is enabled. The default values is FALSE.
Pointer to a variable that indicates whether frame control is enabled. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Frame control is enabled. |
| FALSE | Frame control is disabled. |
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Sets the filter to drop frames when necessary in order to maintain the frame rate.
A Boolean variable that contains a value that indicates whether frames can be dropped. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Frames can be dropped. |
| FALSE | Keep every frame. |
To enable frame dropping set bEnableFrameDropping to TRUE. To keep every frame set bEnableFrameDropping to FALSE.
Always returns S_OK.
Gets a value that indicates whether the filter is currently set to drop frames when necessary to maintain the frame time. The default value is FALSE.
Pointer to a Boolean value that indicates whether the frame dropping feature is currently set to drop frames.
| Value | Meaning |
|---|---|
| TRUE | The filter is currently set to drop frames when necessary to maintain the frame time. |
| FALSE | The filter is set to keep every frame. |
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| E_INVALIDARG | The input pointer is invalid. |
Sets the DICOM dataset inside the LEAD DICOM Reader filter.
Pointer to the user dataset.
A value that specifies whether the filter should make a copy of the passed dataset for future usage. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Make a copy of the dataset (allocating memory for it, and maintaining responsibility for freeing this memory). |
| FALSE | The user will take care of the pointer life (and ensure its availability for the Writer as long as it is needed). |
Before using this method you need to first create and initialize a dataset using the raster toolkit and LDicomDS::InitDS and either LDicomDS::LoadDS or LDicomDS::LoadDSMemory. This method is only compatible with 32 bit platforms. Use SetDicomDSPtr instead. This method fails if:
The LEAD DICOM Reader is already connected.
The dataset contains no pixel data.
The pixel data could not be read properly.
Call this method with pDS set to NULL:
To stop the LEAD DICOM Reader from using the dataset.
Before freeing the dataset's memory.
| Return | Description |
|---|---|
| S_OK | SUCCESS |
| < 0 | An error occurred. |
Resets the LEAD DICOM Reader option values to the default values, as follows:
InputFileName = "
FrameControl = FALSE
FrameDropping = FALSE
FrameTime = 40
This filter is included as part of LEADTOOLS Medical Module module.
Always returns S_OK.