mlImageProperties.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_IMAGE_PROPERTIES_H
#define ML_IMAGE_PROPERTIES_H
 
 
#include "mlInitSystemML.h"
#include "mlSubImageBox.h"
 
#include <mlImageVector.h>
 
ML_START_NAMESPACE
 
 
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
class ML_UNIX_ONLY_EXPORT(MLEXPORT) ImageProperties
{
 
public:
  //-------------------------------------------------------------------
  //-------------------------------------------------------------------
  MLEXPORT ImageProperties();
 
  MLEXPORT virtual ~ImageProperties();
 
  MLEXPORT ImageProperties(ImageVector extent,
                           MLDataType  dataType,
                           MLdouble    minValue,
                           MLdouble    maxValue);
 
  MLEXPORT ImageProperties(const ImageProperties& imageProperties);
 
  MLEXPORT ImageProperties &operator=(const ImageProperties& imageProperties);
 
  MLEXPORT void setImageProperties(const ImageProperties& imageProperties);
 
  //-------------------------------------------------------------------
  //-------------------------------------------------------------------
  MLEXPORT bool operator==(const ImageProperties& imageProperties) const;
 
  MLEXPORT bool operator!=(const ImageProperties& imageProperties) const;
 
  //-------------------------------------------------------------------
  //-------------------------------------------------------------------
  MLEXPORT void setImageExtent(const ImageVector& extent)  { _extent=extent; }
 
  inline ImageVector getImageExtent() const { return _extent; }
 
  inline SubImageBox getBoxFromImageExtent() const { return SubImageBox(ImageVector(static_cast<MLint>(0)), getImageExtent()-ImageVector(static_cast<MLint>(1))); }
 
  inline bool hasValidExtent() const {
    return getNumVoxels() > 0;
  }
 
  inline MLint getNumVoxels() const { const MLint retVal = ImageVector::compMul(_extent); return retVal < 0 ? 0 : retVal; }
 
  inline MLint getSizeInBytes() const{ return getNumVoxels() * static_cast<MLint>(MLSizeOf(_dataType)); }
 
  //-------------------------------------------------------------------
  //-------------------------------------------------------------------
  MLEXPORT virtual void setDataType(MLDataType dataType);
 
  inline MLDataType getDataType() const { return _dataType;        }
 
  //-------------------------------------------------------------------
  //-------------------------------------------------------------------
  inline void     setMinVoxelValue(MLdouble minval)    { _minVoxelValue=minval; }
  inline MLdouble getMinVoxelValue()             const { return _minVoxelValue; }
  inline void     setMaxVoxelValue(MLdouble maxval)    { _maxVoxelValue=maxval; }
  inline MLdouble getMaxVoxelValue()             const { return _maxVoxelValue; }
 
private:
 
  void _assignMembers(const ImageProperties &imgProps);
 
  //-------------------------------------------------------------------
  //-------------------------------------------------------------------
  MLDataType   _dataType;
 
  ImageVector _extent;
 
  MLdouble  _minVoxelValue;
 
  MLdouble  _maxVoxelValue;
 
 
#if ML_DEPRECATED_SINCE(3,5,0)
 
 
public:
 
  inline MLEXPORT ML_DEPRECATED void setImgProps(const ImageProperties &imgProps) { setImageProperties(imgProps); }
  inline MLEXPORT ML_DEPRECATED void setImgExt(const ImageVector &ext)  { _extent=ext; }
  inline ML_DEPRECATED ImageVector getImgExt() const { return _extent; }
  inline ML_DEPRECATED SubImageBox getBoxFromImgExt() const  { return getBoxFromImageExtent(); }
  inline ML_DEPRECATED MLint getSize() const { return getNumVoxels(); }
  inline ML_DEPRECATED MLint getByteSize() const { return getSizeInBytes(); }
 
 
#endif
 
};
 
 
ML_END_NAMESPACE
 
#endif //of  __mlImageProperties_H