+ * \brief
+ * Read the pixels from disk (uncompress if necessary),
+ * Transforms YBR pixels, if any, into RGB pixels
+ * Transforms 3 planes R, G, B, if any, into a single RGB Plane
+ * Transforms single Grey plane + 3 Palettes into a RGB Plane
+ * Copies at most MaxSize bytes of pixel data to caller allocated
+ * memory space.
+ * \warning This function allows people that want to build a volume
+ * from an image stack *not to* have, first to get the image pixels,
+ * and then move them to the volume area.
+ * It's absolutely useless for any VTK user since vtk chooses
+ * to invert the lines of an image, that is the last line comes first
+ * (for some axis related reasons?). Hence he will have
+ * to load the image line by line, starting from the end.
+ * VTK users have to call GetImageData
+ *
+ * @param destination Address (in caller's memory space) at which the
+ * pixel data should be copied
+ * @param maxSize Maximum number of bytes to be copied. When MaxSize
+ * is not sufficient to hold the pixel data the copy is not
+ * executed (i.e. no partial copy).
+ * @return On success, the number of bytes actually copied. Zero on
+ * failure e.g. MaxSize is lower than necessary.
+ */
+size_t File::GetImageDataIntoVector (void* destination, size_t maxSize)
+{
+ if ( ! GetDecompressed() )
+ {
+ // If the decompression failed nothing can be done.
+ return 0;
+ }
+
+ if ( HeaderInternal->HasLUT() && PixelConverter->BuildRGBImage() )
+ {
+ if ( PixelConverter->GetRGBSize() > maxSize )
+ {
+ dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger"
+ "than caller's expected MaxSize");
+ return 0;
+ }
+ memcpy( destination,
+ (void*)PixelConverter->GetRGB(),
+ PixelConverter->GetRGBSize() );
+ return PixelConverter->GetRGBSize();
+ }
+
+ // Either no LUT conversion necessary or LUT conversion failed
+ if ( PixelConverter->GetDecompressedSize() > maxSize )
+ {
+ dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger"
+ "than caller's expected MaxSize");
+ return 0;
+ }
+ memcpy( destination,
+ (void*)PixelConverter->GetDecompressed(),
+ PixelConverter->GetDecompressedSize() );
+ return PixelConverter->GetDecompressedSize();
+}
+
+/**
+ * \brief Allocates necessary memory,
+ * Transforms YBR pixels (if any) into RGB pixels
+ * Transforms 3 planes R, G, B (if any) into a single RGB Plane
+ * Copies the pixel data (image[s]/volume[s]) to newly allocated zone.
+ * DOES NOT transform Grey plane + 3 Palettes into a RGB Plane
+ * @return Pointer to newly allocated pixel data.
+ * \ NULL if alloc fails
+ */
+uint8_t* File::GetImageDataRaw ()
+{
+ return GetDecompressed();
+}
+
+uint8_t* File::GetDecompressed()
+{
+ uint8_t* decompressed = PixelConverter->GetDecompressed();
+ if ( ! decompressed )
+ {
+ // The decompressed image migth not be loaded yet:
+ std::ifstream* fp = HeaderInternal->OpenFile();
+ PixelConverter->ReadAndDecompressPixelData( fp );
+ if(fp)
+ HeaderInternal->CloseFile();
+
+ decompressed = PixelConverter->GetDecompressed();
+ if ( ! decompressed )
+ {
+ dbg.Verbose(0, "File::GetDecompressed: read/decompress of "
+ "pixel data apparently went wrong.");
+ return 0;
+ }
+ }
+
+ return decompressed;
+}
+
+/**
+ * \brief Points the internal Pixel_Data pointer to the callers inData
+ * image representation, BUT WITHOUT COPYING THE DATA.
+ * 'image' Pixels are presented as C-like 2D arrays : line per line.
+ * 'volume'Pixels are presented as C-like 3D arrays : plane per plane
+ * \warning Since the pixels are not copied, it is the caller's responsability
+ * not to deallocate it's data before gdcm uses them (e.g. with
+ * the Write() method.
+ * @param inData user supplied pixel area
+ * @param expectedSize total image size, in Bytes