Skip to content

Commit 3ba3e62

Browse files
author
pierre
committed
Add warning to prevent user
1 parent b2cd793 commit 3ba3e62

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

Source/MediaStorageAndFileFormat/gdcmOverlay.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,12 @@ class GDCM_EXPORT Overlay : public Object
9393

9494
/// set overlay from byte array + length
9595
void SetOverlay(const char *array, size_t length);
96-
///
96+
97+
/// \warning Before calling this method, you must verify the consistency
98+
/// between the image metadata (Image PixelFormat, Rows, Columns) and the
99+
/// overlay parameters. This pre-verification is required to ensure that the
100+
/// bit-depth is compatible and that the overlay data fits within the
101+
/// allocated pixel storage.
97102
bool GrabOverlayFromPixelData(DataSet const &ds);
98103

99104
/// Return the Overlay Data as ByteValue:

0 commit comments

Comments
 (0)