Program: gdcm
Module: $RCSfile: gdcmPixelWriteConvert.cxx,v $
Language: C++
- Date: $Date: 2005/06/24 10:55:59 $
- Version: $Revision: 1.9 $
+ Date: $Date: 2005/10/23 15:09:19 $
+ Version: $Revision: 1.11 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
//-----------------------------------------------------------------------------
// Public
/**
- * \brief SetReadData
+ * \brief sets Read Data (and size)
* @param data data (uint8_t is for prototyping. if your data is not uint8_t
* just cast the pointer for calling the method)
- * @param size size in bytes
+ * @param size data size, in bytes
*/
void PixelWriteConvert::SetReadData(uint8_t *data, size_t size)
{
}
/**
- * \brief Sets User Data
+ * \brief Sets the internal pointer to the caller's 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 its data before gdcm uses them (e.g. with
+ * the Write() method )
* @param data data (uint8_t is for prototyping. if your data is not uint8_t
* just cast the pointer for calling the method)
- * @param size size in bytes
+ * @param size size, in bytes.
*/
void PixelWriteConvert::SetUserData(uint8_t *data, size_t size)
{
/**
* \brief Get Data (UserData or ReadData)
- * @return data data data (uint8_t is for prototyping. if your data is not uint8_t
- * just cast the returned pointer)
+ * @return data (uint8_t is for prototyping. if your data is
+ * *not* uint8_t, just cast the returned pointer)
*/
uint8_t *PixelWriteConvert::GetData()
{
/**
* \brief Get Data Size (UserData or ReadData)
- * @return size size in bytes
+ * @return size, in bytes.
*/
size_t PixelWriteConvert::GetDataSize()
{