Image class that support file reading/writing operations using auxiliary image library. Supported image formats: More...

#include <Image_AlienPixMap.hxx>

Inheritance diagram for Image_AlienPixMap:

[legend]

Public Member Functions
	Image_AlienPixMap ()
	Empty constructor.

virtual	~Image_AlienPixMap ()
	Destructor.

bool	Load (const TCollection_AsciiString &theFileName)
	Read image data from file.

bool	Load (std::istream &theStream, const TCollection_AsciiString &theFileName)
	Read image data from stream.

bool	Load (const Standard_Byte *theData, const Standard_Size theLength, const TCollection_AsciiString &theFileName)
	Read image data from memory buffer.

bool	Save (const TCollection_AsciiString &theFileName)
	Write image data to file.

bool	Save (std::ostream &theStream, const TCollection_AsciiString &theExtension)
	Write image data to stream.

bool	Save (Standard_Byte *theBuffer, const Standard_Size theLength, const TCollection_AsciiString &theFileName)
	Write image data to file or memory buffer using file extension to determine format.

virtual bool	InitTrash (Image_Format thePixelFormat, const Standard_Size theSizeX, const Standard_Size theSizeY, const Standard_Size theSizeRowBytes=0) override
	Initialize image plane with required dimensions.

virtual bool	InitCopy (const Image_PixMap &theCopy) override
	Initialize by copying data.

virtual void	Clear () override
	Method correctly deallocate internal buffer.

bool	AdjustGamma (const Standard_Real theGammaCorr)
	Performs gamma correction on image.

Public Member Functions inherited from Image_PixMap
Image_Format	Format () const
	Return pixel format.

void	SetFormat (const Image_Format thePixelFormat)
	Override pixel format specified by InitXXX() methods. Will throw exception if pixel size of new format is not equal to currently initialized format. Intended to switch formats indicating different interpretation of the same data (e.g. ImgGray and ImgAlpha).

Standard_Size	Width () const
	Return image width in pixels.

Standard_Size	Height () const
	Return image height in pixels.

Standard_Size	Depth () const
	Return image depth in pixels.

Standard_Size	SizeX () const
	Return image width in pixels.

Standard_Size	SizeY () const
	Return image height in pixels.

Standard_Size	SizeZ () const
	Return image depth in pixels.

NCollection_Vec3< Standard_Size >	SizeXYZ () const
	Return image width x height x depth in pixels.

Standard_Real	Ratio () const
	Return width / height.

bool	IsEmpty () const
	Return true if data is NULL.

	Image_PixMap ()
	Empty constructor. Initialize the NULL image plane.

virtual	~Image_PixMap ()
	Destructor.

Quantity_ColorRGBA	PixelColor (Standard_Integer theX, Standard_Integer theY, Standard_Boolean theToLinearize=false) const
	Returns the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to Value() and ChangeValue().

void	SetPixelColor (const Standard_Integer theX, const Standard_Integer theY, const Quantity_Color &theColor, const Standard_Boolean theToDeLinearize=false)
	Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to Value() and ChangeValue().

void	SetPixelColor (const Standard_Integer theX, const Standard_Integer theY, const Quantity_ColorRGBA &theColor, const Standard_Boolean theToDeLinearize=false)
	Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to Value() and ChangeValue().

bool	InitZero (Image_Format thePixelFormat, const Standard_Size theSizeX, const Standard_Size theSizeY, const Standard_Size theSizeRowBytes=0, const Standard_Byte theValue=0)
	Initialize image plane with required dimensions. Buffer will be zeroed (black color for most formats).

virtual bool	InitWrapper3D (Image_Format thePixelFormat, Standard_Byte *theDataPtr, const NCollection_Vec3< Standard_Size > &theSizeXYZ, const Standard_Size theSizeRowBytes=0)
	Initialize 2D/3D image as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying.

virtual bool	InitTrash3D (Image_Format thePixelFormat, const NCollection_Vec3< Standard_Size > &theSizeXYZ, const Standard_Size theSizeRowBytes=0)
	Initialize 2D/3D image with required dimensions. Memory will be left uninitialized (performance trick).

bool	InitZero3D (Image_Format thePixelFormat, const NCollection_Vec3< Standard_Size > &theSizeXYZ, const Standard_Size theSizeRowBytes=0, const Standard_Byte theValue=0)
	Initialize 2D/3D image with required dimensions. Buffer will be zeroed (black color for most formats).

bool	IsTopDown () const
	Returns TRUE if image data is stored from Top to the Down. By default Bottom Up order is used instead (topmost scanlines starts from the bottom in memory). which is most image frameworks naturally support.

void	SetTopDown (const bool theIsTopDown)
	Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored!

Standard_Size	TopDownInc () const
	Returns +1 if scanlines ordered in Top->Down order in memory and -1 otherwise.

const Standard_Byte *	Data () const
	Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).

Standard_Byte *	ChangeData ()
	Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).

const Standard_Byte *	Row (Standard_Size theRow) const
	Return data pointer to requested row (first column). Indexation starts from 0.

Standard_Byte *	ChangeRow (Standard_Size theRow)
	Return data pointer to requested row (first column). Indexation starts from 0.

const Standard_Byte *	Slice (Standard_Size theSlice) const
	Return data pointer to requested 2D slice. Indexation starts from 0.

Standard_Byte *	ChangeSlice (Standard_Size theSlice)
	Return data pointer to requested 2D slice. Indexation starts from 0.

const Standard_Byte *	SliceRow (Standard_Size theSlice, Standard_Size theRow) const
	Return data pointer to requested row (first column). Indexation starts from 0.

Standard_Byte *	ChangeSliceRow (Standard_Size theSlice, Standard_Size theRow)
	Return data pointer to requested row (first column). Indexation starts from 0.

Standard_Size	SizePixelBytes () const
	Return bytes reserved for one pixel (may include extra bytes for alignment).

Standard_Size	SizeRowBytes () const
	Return bytes reserved per row. Could be larger than needed to store packed row (extra bytes for alignment etc.).

Standard_Size	RowExtraBytes () const
	Return the extra bytes in the row.

Standard_Size	MaxRowAligmentBytes () const
	Compute the maximal row alignment for current row size.

Standard_Size	SizeSliceBytes () const
	Return number of bytes per 2D slice.

Standard_Size	SizeBytes () const
	Return buffer size.

template<typename ColorType_t >
const ColorType_t &	Value (Standard_Size theRow, Standard_Size theCol) const
	Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.

template<typename ColorType_t >
ColorType_t &	ChangeValue (Standard_Size theRow, Standard_Size theCol)
	Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.

const Standard_Byte *	RawValue (Standard_Size theRow, Standard_Size theCol) const
	Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.

Standard_Byte *	ChangeRawValue (Standard_Size theRow, Standard_Size theCol)
	Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.

template<typename ColorType_t >
const ColorType_t &	ValueXY (Standard_Size theX, Standard_Size theY) const
	Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.

template<typename ColorType_t >
ColorType_t &	ChangeValueXY (Standard_Size theX, Standard_Size theY)
	Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.

const Standard_Byte *	RawValueXY (Standard_Size theX, Standard_Size theY) const
	Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.

Standard_Byte *	ChangeRawValueXY (Standard_Size theX, Standard_Size theY)
	Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.

template<typename ColorType_t >
const ColorType_t &	ValueXYZ (Standard_Size theX, Standard_Size theY, Standard_Size theZ) const
	Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.

template<typename ColorType_t >
ColorType_t &	ChangeValueXYZ (Standard_Size theX, Standard_Size theY, Standard_Size theZ)
	Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.

const Standard_Byte *	RawValueXYZ (Standard_Size theX, Standard_Size theY, Standard_Size theZ) const
	Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.

Standard_Byte *	ChangeRawValueXYZ (Standard_Size theX, Standard_Size theY, Standard_Size theZ)
	Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static bool	IsTopDownDefault ()
	Return default rows order used by underlying image library.

Static Public Member Functions inherited from Image_PixMap
static bool	IsBigEndianHost ()
	Determine Big-Endian at runtime.

static Standard_Size	SizePixelBytes (const Image_Format thePixelFormat)
	Return bytes reserved for one pixel (may include extra bytes for alignment).

static bool	SwapRgbaBgra (Image_PixMap &theImage)
	Auxiliary method for swapping bytes between RGB and BGR formats. This method modifies the image data but does not change pixel format! Method will fail if pixel format is not one of the following:

static void	ToBlackWhite (Image_PixMap &theImage)
	Convert image to Black/White.

static bool	FlipY (Image_PixMap &theImage)
	Reverse line order as it draws it from bottom to top.

static const Handle< NCollection_BaseAllocator > &	DefaultAllocator ()
	Return default image data allocator.

static Standard_CString	ImageFormatToString (Image_Format theFormat)
	Return string representation of pixel format.

static Standard_CString	ImageFormatToString (Image_CompressedFormat theFormat)
	Return string representation of compressed pixel format.

static Quantity_ColorRGBA	ColorFromRawPixel (const Standard_Byte *theRawValue, const Image_Format theFormat, const Standard_Boolean theToLinearize=false)
	Convert raw pixel value into Quantity_ColorRGBA. This function is relatively slow.

static void	ColorToRawPixel (Standard_Byte *theRawValue, const Image_Format theFormat, const Quantity_ColorRGBA &theColor, const Standard_Boolean theToDeLinearize=false)
	Set raw pixel value from Quantity_ColorRGBA. This function is relatively slow.

static float	ConvertFromHalfFloat (const uint16_t theHalf)
	Convert 16-bit half-float value into 32-bit float (simple conversion).

static uint16_t	ConvertToHalfFloat (const float theFloat)
	Convert 32-bit float value into IEEE-754 16-bit floating-point format without infinity: 1-5-10, exp-15, +-131008.0, +-6.1035156E-5, +-5.9604645E-8, 3.311 digits.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Protected Attributes inherited from Image_PixMap
Image_PixMapData	myData
	data buffer

Image_Format	myImgFormat
	pixel format

Detailed Description

Image class that support file reading/writing operations using auxiliary image library. Supported image formats:

*.bmp - bitmap image, lossless format without compression.
*.ppm - PPM (Portable Pixmap Format), lossless format without compression.
*.png - PNG (Portable Network Graphics) lossless format with compression.
*.jpg, *.jpe, *.jpeg - JPEG/JIFF (Joint Photographic Experts Group) lossy format (compressed with quality losses). YUV color space used (automatically converted from/to RGB).
*.tif, *.tiff - TIFF (Tagged Image File Format).
*.tga - TGA (Truevision Targa Graphic), lossless format.
*.gif - GIF (Graphical Interchange Format), lossy format. Color stored using palette (up to 256 distinct colors).
*.exr - OpenEXR high dynamic-range format (supports float pixel formats).

Constructor & Destructor Documentation

◆ Image_AlienPixMap()

Image_AlienPixMap::Image_AlienPixMap ( )

Empty constructor.

◆ ~Image_AlienPixMap()

virtual Image_AlienPixMap::~Image_AlienPixMap ( )

virtual

Destructor.

Member Function Documentation

◆ AdjustGamma()

bool Image_AlienPixMap::AdjustGamma ( const Standard_Real theGammaCorr )

Performs gamma correction on image.

Parameters

[in] theGamma - gamma value to use; a value of 1.0 leaves the image alone

◆ Clear()

virtual void Image_AlienPixMap::Clear ( )

overridevirtual

Method correctly deallocate internal buffer.

Reimplemented from Image_PixMap.

◆ InitCopy()

virtual bool Image_AlienPixMap::InitCopy ( const Image_PixMap & theCopy )

overridevirtual

Initialize by copying data.

Reimplemented from Image_PixMap.

◆ InitTrash()

virtual bool Image_AlienPixMap::InitTrash	(	Image_Format	thePixelFormat,
		const Standard_Size	theSizeX,
		const Standard_Size	theSizeY,
		const Standard_Size	theSizeRowBytes = `0`
	)

overridevirtual

Initialize image plane with required dimensions.

Parameters

[in]	thePixelFormat	if specified pixel format doesn't supported by image library than nearest supported will be used instead!
[in]	theSizeRowBytes	may be ignored by this class and required alignment will be used instead!

Reimplemented from Image_PixMap.

◆ IsTopDownDefault()

static bool Image_AlienPixMap::IsTopDownDefault ( )

static

Return default rows order used by underlying image library.

◆ Load() [1/3]

bool Image_AlienPixMap::Load	(	const Standard_Byte *	theData,
		const Standard_Size	theLength,
		const TCollection_AsciiString &	theFileName
	)

Read image data from memory buffer.

Parameters

[in]	theData	memory pointer to read from; when NULL, function will attempt to open theFileName file
[in]	theLength	memory buffer length
[in]	theFileName	optional file name

◆ Load() [2/3]

bool Image_AlienPixMap::Load ( const TCollection_AsciiString & theFileName )

inline

Read image data from file.

◆ Load() [3/3]

bool Image_AlienPixMap::Load	(	std::istream &	theStream,
		const TCollection_AsciiString &	theFileName
	)

Read image data from stream.

◆ Save() [1/3]

bool Image_AlienPixMap::Save ( const TCollection_AsciiString & theFileName )

inline

Write image data to file.

Parameters

[in] theFileName file name to save

◆ Save() [2/3]

bool Image_AlienPixMap::Save	(	Standard_Byte *	theBuffer,
		const Standard_Size	theLength,
		const TCollection_AsciiString &	theFileName
	)

Write image data to file or memory buffer using file extension to determine format.

Parameters

[out]	theBuffer	buffer pointer where to write when NULL, function write image data to theFileName file
[in]	theLength	memory buffer length
[in]	theFileName	file name to save; when theBuffer isn't NULL used only to determine format

◆ Save() [3/3]

bool Image_AlienPixMap::Save	(	std::ostream &	theStream,
		const TCollection_AsciiString &	theExtension
	)

Write image data to stream.

Parameters

[out]	theStream	stream where to write
[in]	theExtension	image format

The documentation for this class was generated from the following file:

Image_AlienPixMap.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Image_AlienPixMap()

◆ ~Image_AlienPixMap()

Member Function Documentation

◆ AdjustGamma()

◆ Clear()

◆ InitCopy()

◆ InitTrash()

◆ IsTopDownDefault()

◆ Load() [1/3]

◆ Load() [2/3]

◆ Load() [3/3]

◆ Save() [1/3]

◆ Save() [2/3]

◆ Save() [3/3]