NCBI C++ ToolKit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
CImage Class Reference

Search Toolkit Book for CImage

#include <util/image/image.hpp>

+ Inheritance diagram for CImage:
+ Collaboration diagram for CImage:

Public Types

enum  EChannel { eRed = 0, eGreen = 1, eBlue = 2, eAlpha = 3 }
 
typedef unsigned char * TPixel
 
typedef const unsigned char * TConstPixel
 
typedef vector< unsigned char > TImageStrip
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1, eAllocFillZero, eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CImage (void)
 
 CImage (size_t width, size_t height, size_t depth=3)
 
const unsigned char * GetData (void) const
 
unsigned char * SetData (void)
 
TConstPixel operator() (size_t x, size_t y) const
 
TPixel operator() (size_t x, size_t y)
 
size_t GetWidth (void) const
 
size_t GetHeight (void) const
 
float GetAspectRatio (void) const
 
size_t GetDepth (void) const
 
void SetDepth (size_t depth, bool update_image=true)
 
void SetChannel (size_t channel, unsigned char val)
 
void SetRed (unsigned char val)
 
void SetGreen (unsigned char val)
 
void SetBlue (unsigned char val)
 
void SetAlpha (unsigned char val, bool add_channel=false)
 
CImageGetSubImage (size_t x, size_t y, size_t w, size_t h) const
 
void Init (size_t width, size_t height, size_t depth)
 
void Flip (void)
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Private Member Functions

 CImage (const CImage &)
 
CImageoperator= (const CImage &)
 

Private Attributes

size_t m_Width
 
size_t m_Height
 
size_t m_Depth
 
TImageStrip m_Data
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 62 of file image.hpp.

Member Typedef Documentation

typedef const unsigned char* CImage::TConstPixel

Definition at line 71 of file image.hpp.

typedef vector<unsigned char> CImage::TImageStrip

Definition at line 74 of file image.hpp.

typedef unsigned char* CImage::TPixel

Definition at line 70 of file image.hpp.

Member Enumeration Documentation

Enumerator
eRed 
eGreen 
eBlue 
eAlpha 

Definition at line 77 of file image.hpp.

Constructor & Destructor Documentation

CImage::CImage ( void  )

Definition at line 44 of file image.cpp.

Referenced by GetSubImage().

CImage::CImage ( size_t  width,
size_t  height,
size_t  depth = 3 
)

Definition at line 53 of file image.cpp.

References Init().

CImage::CImage ( const CImage )
private

Member Function Documentation

void CImage::Flip ( void  )

Definition at line 275 of file image.cpp.

References m_Data, m_Depth, m_Height, m_Width, SetData(), and swap().

Referenced by IImageGrabber::GrabImages(), and CPhyloTreeWidget::OnPrint().

float CImage::GetAspectRatio ( void  ) const

Definition at line 103 of file image.cpp.

References m_Height, and m_Width.

const unsigned char * CImage::GetData ( void  ) const
size_t CImage::GetDepth ( void  ) const
inline
size_t CImage::GetHeight ( void  ) const
inline
CImage * CImage::GetSubImage ( size_t  x,
size_t  y,
size_t  w,
size_t  h 
) const
size_t CImage::GetWidth ( void  ) const
inline
void CImage::Init ( size_t  width,
size_t  height,
size_t  depth 
)
CImage::TConstPixel CImage::operator() ( size_t  x,
size_t  y 
) const
inline

Definition at line 149 of file image.hpp.

References _ASSERT, m_Data, m_Depth, m_Height, and m_Width.

CImage::TPixel CImage::operator() ( size_t  x,
size_t  y 
)
inline

Definition at line 158 of file image.hpp.

References _ASSERT, m_Data, m_Depth, m_Height, and m_Width.

CImage& CImage::operator= ( const CImage )
private
void CImage::SetAlpha ( unsigned char  val,
bool  add_channel = false 
)

Definition at line 113 of file image.cpp.

References eAlpha, GetDepth(), NCBI_THROW, SetChannel(), and SetDepth().

void CImage::SetBlue ( unsigned char  val)
inline

Definition at line 190 of file image.hpp.

References eBlue, and SetChannel().

void CImage::SetChannel ( size_t  channel,
unsigned char  val 
)

Definition at line 206 of file image.cpp.

References m_Data, m_Depth, m_Height, m_Width, and NCBI_THROW.

Referenced by SetAlpha(), SetBlue(), SetGreen(), and SetRed().

unsigned char * CImage::SetData ( void  )
void CImage::SetDepth ( size_t  depth,
bool  update_image = true 
)
void CImage::SetGreen ( unsigned char  val)
inline

Definition at line 180 of file image.hpp.

References eAlpha, and SetChannel().

void CImage::SetRed ( unsigned char  val)
inline

Definition at line 170 of file image.hpp.

References eRed, and SetChannel().

Member Data Documentation

TImageStrip CImage::m_Data
private

Definition at line 137 of file image.hpp.

Referenced by Flip(), GetData(), GetSubImage(), Init(), operator()(), SetChannel(), SetData(), and SetDepth().

size_t CImage::m_Depth
private

Definition at line 135 of file image.hpp.

Referenced by Flip(), GetDepth(), GetSubImage(), Init(), operator()(), SetChannel(), and SetDepth().

size_t CImage::m_Height
private
size_t CImage::m_Width
private

Definition at line 133 of file image.hpp.

Referenced by Flip(), GetAspectRatio(), GetSubImage(), GetWidth(), Init(), operator()(), SetChannel(), and SetDepth().


The documentation for this class was generated from the following files:
Modified on Sun May 20 14:16:08 2018 by modify_doxy.py rev. 546573