cmtkImageRGB.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkImageRGB_h_included_
#define __cmtkImageRGB_h_included_

#include <cmtkconfig.h>

#include <Pipeline/cmtkPlane.h>
#include <Pipeline/cmtkImage.h>
#include <Pipeline/cmtkRGB.h>

#include <Base/cmtkTypes.h>

namespace
cmtk
{


typedef enum {
  IMAGE_RGB,
  IMAGE_RGBA
} ImageAlphaToggle;

class ImageRGB : 
  public Plane 
{
public:
  static ImageRGB* New();

  const byte *GetDataPtr() const
  { 
    return this->Data; 
  }

  byte *GetDataPtr( const bool forceAlloc );

  void GetPixel( RGBA& rgb, const int index );

  void SetPixel( const int index, const RGBA& rgb );

  void GetPixel( RGB& rgb, const int index );

  void SetPixel( const int index, const RGB& rgb );

  void SetAlphaChannel( const ImageAlphaToggle alphaChannel,
                        const bool convertData = false );

  ImageAlphaToggle GetAlphaChannel() const { return AlphaChannel; }

  bool IsGreyscale() const;

protected:
  ImageRGB();
  
  ~ImageRGB();

private:
  byte *Data;

  ImageAlphaToggle AlphaChannel;

  unsigned int BytesPerPixel;

  unsigned int DataSize;
};


} // namespace cmtk

#endif // #ifndef __cmtkImageRGB_h_included_