#include <objtools/eutils/efetch/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 CImage_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_Attlist , e_image }

typedef C_Attlist	TAttlist

typedef Tparent::CMemberIndex< E_memberIndex, 3 >	TmemberIndex

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 atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Member Functions
	CImage (void)

	~CImage (void)

	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)

CImage *	GetSubImage (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 CImage_Base
	CImage_Base (void)

virtual	~CImage_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetAttlist (void) const
	Check if a value has been assigned to Attlist data member. More...

bool	CanGetAttlist (void) const
	Check if it is safe to call GetAttlist method. More...

void	ResetAttlist (void)
	Reset Attlist data member. More...

const TAttlist &	GetAttlist (void) const
	Get the Attlist member data. More...

void	SetAttlist (TAttlist &value)
	Assign a value to Attlist data member. More...

TAttlist &	SetAttlist (void)
	Assign a value to Attlist data member. More...

bool	IsSetImage (void) const
	Check if a value has been assigned to Image data member. More...

bool	CanGetImage (void) const
	Check if value of Image member is getatable. More...

void	ResetImage (void)
	Reset Image data member. More...

void	SetImage (void)
	Set NULL data member (assign 'NULL' value to Image data member). More...

virtual void	Reset (void)
	Reset the whole object. More...

Public Member Functions inherited from CSerialObject
	CSerialObject (void)

virtual	~CSerialObject (void)

virtual const CTypeInfo *	GetThisTypeInfo (void) const =0

virtual void	Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
	Set object to copy of another one. More...

virtual bool	Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
	Check if both objects contain the same values. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

void	ThrowUnassigned (TMemberIndex index) const

void	ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const

bool	HasNamespaceName (void) const
	Check if object data type has namespace name. More...

const string &	GetNamespaceName (void) const
	Get namespace name. More...

bool	HasNamespacePrefix (void) const
	Check if data type has namespace prefix. More...

const string &	GetNamespacePrefix (void) const
	Get namespace prefix. More...

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (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...

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 Types
typedef CImage_Base	Tparent

Private Member Functions
	CImage (const CImage &value)

CImage &	operator= (const CImage &value)

	CImage (const CImage &)

CImage &	operator= (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 CSerialObject
static void	SetVerifyDataThread (ESerialVerifyData verify)

static void	SetVerifyDataGlobal (ESerialVerifyData verify)

static string	UnassignedString (void)

static CStringUTF8	UnassignedStringUTF8 (void)

static char	UnassignedByte (void)

Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT 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 CSerialObject
static const char *	ms_UnassignedStr = "<unassigned>"

static const char	ms_UnassignedByte = char(0xcd)

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

CImage –.

Definition at line 65 of file Image.hpp.

Member Typedef Documentation

◆ TConstPixel

typedef const unsigned char* CImage::TConstPixel

Definition at line 71 of file image.hpp.

◆ TImageStrip

typedef vector<unsigned char> CImage::TImageStrip

Definition at line 74 of file image.hpp.

◆ TPixel

typedef unsigned char* CImage::TPixel

Definition at line 70 of file image.hpp.

Member Enumeration Documentation

◆ EChannel

enum CImage::EChannel

Enumerator
eRed
eGreen
eBlue
eAlpha

Definition at line 77 of file image.hpp.

Constructor & Destructor Documentation

◆ CImage() [1/3]

CImage::CImage ( void )

◆ CImage() [2/3]

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

Definition at line 53 of file image.cpp.

References depth, and Init().

◆ CImage() [3/3]

CImage::CImage ( const CImage & )

private

Member Function Documentation

◆ Flip()

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().

◆ GetAspectRatio()

float CImage::GetAspectRatio ( void ) const

Definition at line 103 of file image.cpp.

References m_Height, and m_Width.

◆ GetData()

const unsigned char * CImage::GetData ( void ) const

Definition at line 85 of file image.cpp.

References _ASSERT, and m_Data.

Referenced by GetSubImage(), CGlTexture::Load(), CPrintHanderWx::OnPrintPage(), CImageIORaw::WriteImage(), and CBlastHitMatrix::WriteToFile().

◆ GetDepth()

size_t CImage::GetDepth ( void ) const

inline

Definition at line 108 of file image.hpp.

References m_Depth.

Referenced by CImageUtil::FlipX(), CImageUtil::FlipY(), CGlTexture::Load(), CImageUtil::Scale(), SetAlpha(), and CImageIORaw::WriteImage().

◆ GetHeight()

size_t CImage::GetHeight ( void ) const

inline

Definition at line 99 of file image.hpp.

References m_Height.

Referenced by CImageUtil::FlipX(), CImageUtil::FlipY(), CGlCgiImageApplication::GetAspectRatio(), IImageGrabber::GrabImage(), IImageGrabber::GrabImages(), CGlTexture::Load(), CGlOsContext::MakeCurrent(), CPrintHanderWx::OnPrintPage(), CPhyloTreeWidget::OnSaveImages(), CConvImageApp::Run(), CImageUtil::Scale(), CImageIORaw::WriteImage(), CPreviewSetupDlg::x_InitDialog(), and CGlPreviewSetupWidget::x_Render().

◆ GetSubImage()

CImage * CImage::GetSubImage	(	size_t	x,
		size_t	y,
		size_t	w,
		size_t	h
	)		const

Definition at line 232 of file image.cpp.

References CImage(), ERR_POST_X, GetData(), i, m_Data, m_Depth, m_Height, m_Width, msg(), NCBI_THROW, NStr::NumericToString(), CRef< C, Locker >::Release(), SetData(), and Warning().

Referenced by CPhyloTreeWidget::OnSaveImages().

◆ GetWidth()

size_t CImage::GetWidth ( void ) const

inline

Definition at line 98 of file image.hpp.

References m_Width.

Referenced by CImageUtil::FlipX(), CImageUtil::FlipY(), CGlCgiImageApplication::GetAspectRatio(), IImageGrabber::GrabImage(), IImageGrabber::GrabImages(), CGlTexture::Load(), CGlOsContext::MakeCurrent(), CPrintHanderWx::OnPrintPage(), CPhyloTreeWidget::OnSaveImages(), CConvImageApp::Run(), CImageUtil::Scale(), CImageIORaw::WriteImage(), CPreviewSetupDlg::x_InitDialog(), and CGlPreviewSetupWidget::x_Render().

◆ Init()

void CImage::Init	(	size_t	width,
		size_t	height,
		size_t	depth
	)

Definition at line 62 of file image.cpp.

References _TRACE, depth, m_Data, m_Depth, m_Height, m_Width, msg(), NCBI_THROW, and NStr::NumericToString().

Referenced by CImage(), IImageGrabber::GrabImage(), IImageGrabber::GrabImages(), and CGlOsContext::MakeCurrent().

◆ operator()() [1/2]

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.

◆ operator()() [2/2]

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.

◆ operator=()

CImage& CImage::operator= ( const CImage & )

private

◆ SetAlpha()

void CImage::SetAlpha	(	unsigned char	val,
		bool	add_channel = `false`
	)

Definition at line 113 of file image.cpp.

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

◆ SetBlue()

void CImage::SetBlue ( unsigned char val )

inline

Definition at line 190 of file image.hpp.

References eBlue, SetChannel(), and val.

◆ SetChannel()

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

Definition at line 206 of file image.cpp.

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

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

◆ SetData()

unsigned char * CImage::SetData ( void )

Definition at line 92 of file image.cpp.

References _ASSERT, and m_Data.

Referenced by Flip(), CImageUtil::FlipX(), CImageUtil::FlipY(), CGlTexture::GenerateImage(), GetSubImage(), IImageGrabber::GrabImage(), IImageGrabber::GrabImages(), CGlOsContext::MakeCurrent(), CPhyloTreeWidget::OnPrint(), CImageIORaw::ReadImage(), and IPhyloTreeRender::x_GenerateTexture().

◆ SetDepth()

void CImage::SetDepth	(	size_t	depth,
		bool	update_image = `true`
	)

Definition at line 132 of file image.cpp.

References depth, m_Data, m_Depth, m_Height, m_Width, msg(), NCBI_THROW, and NStr::NumericToString().

Referenced by CGlCgiImageApplication::ProcessRequest(), SetAlpha(), and CBlastHitMatrix::x_RenderImage().

◆ SetGreen()

void CImage::SetGreen ( unsigned char val )

inline

Definition at line 180 of file image.hpp.

References eAlpha, SetChannel(), and val.

◆ SetRed()

void CImage::SetRed ( unsigned char val )

inline

Definition at line 170 of file image.hpp.

References eRed, SetChannel(), and val.

Member Data Documentation

◆ m_Data

TImageStrip CImage::m_Data

private

Definition at line 137 of file image.hpp.

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

◆ m_Depth

size_t CImage::m_Depth

private

Definition at line 135 of file image.hpp.

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

◆ m_Height

size_t CImage::m_Height

private

Definition at line 134 of file image.hpp.

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

◆ m_Width

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:

include/objtools/eutils/efetch/Image.hpp
src/objtools/eutils/efetch/Image.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TConstPixel

◆ TImageStrip

◆ TPixel

Member Enumeration Documentation

◆ EChannel

Constructor & Destructor Documentation

◆ CImage() [1/3]

◆ CImage() [2/3]

◆ CImage() [3/3]

Member Function Documentation

◆ Flip()

◆ GetAspectRatio()

◆ GetData()

◆ GetDepth()

◆ GetHeight()

◆ GetSubImage()

◆ GetWidth()

◆ Init()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=()

◆ SetAlpha()

◆ SetBlue()

◆ SetChannel()

◆ SetData()

◆ SetDepth()

◆ SetGreen()

◆ SetRed()

Member Data Documentation

◆ m_Data

◆ m_Depth

◆ m_Height

◆ m_Width