Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

Image_AlienPixMap Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

 Image_AlienPixMap ()
 Empty constructor. More...
 
virtual ~Image_AlienPixMap ()
 Destructor. More...
 
bool Load (const TCollection_AsciiString &theFileName)
 Read image data from file. More...
 
bool Load (std::istream &theStream, const TCollection_AsciiString &theFileName)
 Read image data from stream. More...
 
bool Load (const Standard_Byte *theData, Standard_Size theLength, const TCollection_AsciiString &theFileName)
 Read image data from memory buffer. More...
 
bool Save (const TCollection_AsciiString &theFileName)
 Write image data to file using file extension to determine compression format. More...
 
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. thePixelFormat - if specified pixel format doesn't supported by image library than nearest supported will be used instead! theSizeRowBytes - may be ignored by this class and required alignment will be used instead! More...
 
virtual bool InitCopy (const Image_PixMap &theCopy) override
 Initialize by copying data. More...
 
virtual void Clear () override
 Method correctly deallocate internal buffer. More...
 
bool AdjustGamma (const Standard_Real theGammaCorr)
 Performs gamma correction on image. theGamma - gamma value to use; a value of 1.0 leaves the image alone. More...
 
- Public Member Functions inherited from Image_PixMap
Image_Format Format () const
 Return pixel format. More...
 
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). More...
 
Standard_Size Width () const
 Return image width in pixels. More...
 
Standard_Size Height () const
 Return image height in pixels. More...
 
Standard_Size Depth () const
 Return image depth in pixels. More...
 
Standard_Size SizeX () const
 Return image width in pixels. More...
 
Standard_Size SizeY () const
 Return image height in pixels. More...
 
Standard_Size SizeZ () const
 Return image depth in pixels. More...
 
NCollection_Vec3< Standard_SizeSizeXYZ () const
 Return image width x height x depth in pixels. More...
 
Standard_Real Ratio () const
 Return width / height. More...
 
bool IsEmpty () const
 Return true if data is NULL. More...
 
 Image_PixMap ()
 Empty constructor. Initialize the NULL image plane. More...
 
virtual ~Image_PixMap ()
 Destructor. More...
 
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(). More...
 
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(). More...
 
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(). More...
 
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). More...
 
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. More...
 
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). More...
 
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). More...
 
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. More...
 
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! More...
 
Standard_Size TopDownInc () const
 Returns +1 if scanlines ordered in Top->Down order in memory and -1 otherwise. More...
 
const Standard_ByteData () const
 Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.). More...
 
Standard_ByteChangeData ()
 Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.). More...
 
const Standard_ByteRow (Standard_Size theRow) const
 Return data pointer to requested row (first column). Indexation starts from 0. More...
 
Standard_ByteChangeRow (Standard_Size theRow)
 Return data pointer to requested row (first column). Indexation starts from 0. More...
 
const Standard_ByteSlice (Standard_Size theSlice) const
 Return data pointer to requested 2D slice. Indexation starts from 0. More...
 
Standard_ByteChangeSlice (Standard_Size theSlice)
 Return data pointer to requested 2D slice. Indexation starts from 0. More...
 
const Standard_ByteSliceRow (Standard_Size theSlice, Standard_Size theRow) const
 Return data pointer to requested row (first column). Indexation starts from 0. More...
 
Standard_ByteChangeSliceRow (Standard_Size theSlice, Standard_Size theRow)
 Return data pointer to requested row (first column). Indexation starts from 0. More...
 
Standard_Size SizePixelBytes () const
 Return bytes reserved for one pixel (may include extra bytes for alignment). More...
 
Standard_Size SizeRowBytes () const
 Return bytes reserved per row. Could be larger than needed to store packed row (extra bytes for alignment etc.). More...
 
Standard_Size RowExtraBytes () const
 Return the extra bytes in the row. More...
 
Standard_Size MaxRowAligmentBytes () const
 Compute the maximal row alignment for current row size. More...
 
Standard_Size SizeSliceBytes () const
 Return number of bytes per 2D slice. More...
 
Standard_Size SizeBytes () const
 Return buffer size. More...
 
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. More...
 
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. More...
 
const Standard_ByteRawValue (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. More...
 
Standard_ByteChangeRawValue (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. More...
 
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. More...
 
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. More...
 
const Standard_ByteRawValueXY (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. More...
 
Standard_ByteChangeRawValueXY (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. More...
 
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. More...
 
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. More...
 
const Standard_ByteRawValueXYZ (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. More...
 
Standard_ByteChangeRawValueXYZ (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. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static bool IsTopDownDefault ()
 Return default rows order used by underlying image library. More...
 
- Static Public Member Functions inherited from Image_PixMap
static bool IsBigEndianHost ()
 Determine Big-Endian at runtime. More...
 
static Standard_Size SizePixelBytes (const Image_Format thePixelFormat)
 Return bytes reserved for one pixel (may include extra bytes for alignment). More...
 
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: More...
 
static void ToBlackWhite (Image_PixMap &theImage)
 Convert image to Black/White. More...
 
static bool FlipY (Image_PixMap &theImage)
 Reverse line order as it draws it from bottom to top. More...
 
static const Handle< NCollection_BaseAllocator > & DefaultAllocator ()
 Return default image data allocator. More...
 
static Standard_CString ImageFormatToString (Image_Format theFormat)
 Return string representation of pixel format. More...
 
static Standard_CString ImageFormatToString (Image_CompressedFormat theFormat)
 Return string representation of compressed pixel format. More...
 
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. More...
 
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. More...
 
static float ConvertFromHalfFloat (const uint16_t theHalf)
 Convert 16-bit half-float value into 32-bit float (simple conversion). More...
 
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. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Attributes inherited from Image_PixMap
Image_PixMapData myData
 data buffer More...
 
Image_Format myImgFormat
 pixel format More...
 

Detailed Description

Image class that support file reading/writing operations using auxiliary image library. Supported image 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. 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. thePixelFormat - if specified pixel format doesn't supported by image library than nearest supported will be used instead! 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,
Standard_Size  theLength,
const TCollection_AsciiString theFileName 
)

Read image data from memory buffer.

Parameters
theDatamemory pointer to read from; when NULL, function will attempt to open theFileName file
theLengthmemory buffer length
theFileNameoptional 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()

bool Image_AlienPixMap::Save ( const TCollection_AsciiString theFileName)

Write image data to file using file extension to determine compression format.


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