L_DicomChannelSetSensitivity

Summary

Sets the channel sensitivity.

Syntax

#include "Ltdic.h"

L_LTDIC_API L_UINT16 L_DicomChannelSetSensitivity(hDICOMWaveFormChannel, bInclude, dChannelSensitivity, pChannelSensitivityUnits, dChannelSensitivityCF, dChannelBaseline)

Parameters

HDICOMWAVEFORMCHANNEL hDICOMWaveFormChannel

A DICOM waveform channel handle.

L_BOOL 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). Possible values are:

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.

L_DOUBLE dChannelSensitivity

New channel sensitivity. For more information, refer to the Channel Sensitivity (003A,0210) element in the DICOM standard.

pDICOMCODESEQUENCEITEM 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.

L_DOUBLE dChannelSensitivityCF

New channel sensitivity correction factor. For more information, refer to the "Channel Sensitivity Correction Factor" (003A,0212) element in the DICOM standard.

L_DOUBLE dChannelBaseline

New channel baseline. For more information, refer to the "Channel Baseline" (003A,0213) element in the DICOM standard.

Returns

Value Meaning
DICOM_SUCCESS 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 context groups functions (L_DicomxxxContextGroup and L_DicomxxxCodedConcept) . For more information about these functions and the use of Coded Concepts in DICOM, refer to Working with Context Groups.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For an example, refer to L_DicomChannelSetSamples8.

Help Version 23.0.2024.7.1
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS DICOM C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.