LEADTOOLS DICOM C++ Class Library Help
| LEADTOOLS DICOM C++ Class Library Help > Classes and Member Functions > LDicomWaveformChannel > LDicomWaveformChannel Class Members > LDicomWaveformChannel::SetChannelSensitivity |
#include "Ltdic.h"
L_UINT16 LDicomWaveformChannel::SetChannelSensitivity(bInclude, dChannelSensitivity, pChannelSensitivityUnits, dChannelSensitivityCF= 1.0, dChannelBaseline= 0.0)
|
L_BOOL bInclude; |
/* insertion/removal flag */ |
|
L_DOUBLE dChannelSensitivity; |
/* new channel sensitivity*/ |
|
pDICOMCODESEQUENCEITEM pChannelSensitivityUnits; |
/* pointer to a structure*/ |
|
L_DOUBLE dChannelSensitivityCF; |
/* new Channel Sensitivity Correction Factor*/ |
|
L_DOUBLE dChannelBaseline; |
/* new Channel Baseline*/ |
Sets the channel sensitivity.
|
Parameter |
Description |
|
|
bInclude |
Flag that specifies whether the function should insert or remove the following elements from the DICOM dataset: Channel Sensitivity (003A,0210), Channel Sensitivity Units Sequence(003A,0211), Channel Sensitivity Correction Factor (003A,0212), and Channel Baseline (003A,0213). |
|
|
|
Value |
Meaning |
|
|
TRUE |
Insert the elements related to channel sensitivity (that correspond to this channel) into the dataset and then set their value. |
|
|
FALSE |
Delete the channel sensitivity-related elements (that correspond to this channel) from the dataset. |
|
dChannelSensitivity |
New channel sensitivity. For more information, refer to the Channel Sensitivity (003A,0210) element in the DICOM standard. |
|
|
pChannelSensitivityUnits |
Pointer to a structure that describes the channel sensitivity units. For more information, refer to "Channel Sensitivity Units Sequence" (003A,0211) in the DICOM standard. |
|
|
dChannelSensitivityCF |
New channel sensitivity correction factor. For more information, refer to the "Channel Sensitivity Correction Factor" (003A,0212) element in the DICOM standard. The default value for this parameter is 1.0. |
|
|
dChannelBaseline |
New channel baseline. For more information, refer to the "Channel Baseline" (003A,0213) element in the DICOM standard. The default value for this parameter is 0.0. |
|
Returns
|
0 |
The function was successful. |
|
> 0 |
An error occurred. Refer to Return Codes. |
Comments
Use this function to insert and set the values for all the elements related to channel sensitivity.
This function fails and Returns DICOM_ERROR_NULL_PTR if pChannelSensitivityUnits is NULL.
Before calling this function, initialize pChannelSensitivityUnits > uStructSize to be sizeof(DICOMCODESEQUENCEITEM) and initialize all the members of the structure.
In DICOM, it is mandatory to specify the channel sensitivity if the channel samples represent defined (not arbitrary) units. Since this is almost always the case, it is important to call this function to create a proper waveform channel.
To fill the members of the pChannelSensitivityUnits structure you can use the functions offered by the LDicomContextGroup class. For more information about this class and the use of Coded Concepts in DICOM, please refer to Working with Context Groups.
Required DLLs and Libraries
|
LTDIC For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application |
Win32, x64
See Also
|
Functions: |
|
|
Topics: |
Example
For an Example, refer to LDicomWaveformChannel::SetChannelSamples8
