Skip to content

Commit

Permalink
Update SkipProcessingPixelDataValue docstring for clarity.
Browse files Browse the repository at this point in the history
  • Loading branch information
suyashkumar authored Aug 26, 2023
1 parent 9612756 commit 5933371
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions parse.go
Original file line number Diff line number Diff line change
Expand Up @@ -277,10 +277,13 @@ func SkipPixelData() ParseOption {
// SkipProcessingPixelDataValue will attempt to skip processing the _value_
// of any PixelData elements. Unlike SkipPixelData(), this means the PixelData
// bytes will still be read into the Dataset, and can be written back out via
// this library's write functionality. But, if possible, the value will be read
// in as raw bytes with no further processing instead of being parsed. In the
// future, we may be able to extend this functionality to support on-demand
// processing of elements elsewhere in the library.
// this library's write functionality. Specifically, if this option is set,
// a PixelData element will be added to the dataset with the
// PixelDataInfo.IntentionallyUnprocessed = true, and the raw bytes of the
// entire PixelData element stored in PixelDataInfo.UnprocessedValueData.
//
// In the future, we may be able to extend this functionality to support
// on-demand processing of elements elsewhere in the library.
func SkipProcessingPixelDataValue() ParseOption {
return func(set *parseOptSet) {
set.skipProcessingPixelDataValue = true
Expand Down

0 comments on commit 5933371

Please sign in to comment.