LibraryLink Utilities  3.0.1
Modern C++ wrapper over LibraryLink and WSTP
LLU::ImageInterface Struct Referenceabstract

Description

Abstract class that defines a basic set of operations on an image.

+ Inheritance diagram for LLU::ImageInterface:

#include <Interfaces.h>

Public Member Functions

virtual colorspace_t colorspace () const =0
 Get colorspace which describes how colors are represented as numbers. More...
 
virtual mint rows () const =0
 Get number of rows. More...
 
virtual mint columns () const =0
 Get number of columns. More...
 
virtual mint slices () const =0
 Get number of slices. More...
 
virtual mint channels () const =0
 Get number of channels. More...
 
virtual bool alphaChannelQ () const =0
 Check if there is an alpha channel in the image. More...
 
virtual bool interleavedQ () const =0
 Check if the image is interleaved. More...
 
virtual bool is3D () const =0
 Check if the image is 3D. More...
 
virtual mint getRank () const =0
 Get rank. More...
 
virtual mint getFlattenedLength () const =0
 Get the total number of pixels in the image. More...
 
virtual imagedata_t type () const =0
 Get the data type of the image. More...
 
virtual void * rawData () const =0
 Get access to raw image data. More...
 

Member Function Documentation

◆ alphaChannelQ()

virtual bool LLU::ImageInterface::alphaChannelQ ( ) const
pure virtual

◆ channels()

virtual mint LLU::ImageInterface::channels ( ) const
pure virtual

◆ colorspace()

virtual colorspace_t LLU::ImageInterface::colorspace ( ) const
pure virtual

Get colorspace which describes how colors are represented as numbers.

See also
http://reference.wolfram.com/language/LibraryLink/ref/callback/MImage_getColorSpace.html

Implemented in LLU::MContainer< MArgumentType::Image >, and LLU::ImageView.

◆ columns()

virtual mint LLU::ImageInterface::columns ( ) const
pure virtual

◆ getFlattenedLength()

virtual mint LLU::ImageInterface::getFlattenedLength ( ) const
pure virtual

◆ getRank()

virtual mint LLU::ImageInterface::getRank ( ) const
pure virtual

◆ interleavedQ()

virtual bool LLU::ImageInterface::interleavedQ ( ) const
pure virtual

◆ is3D()

virtual bool LLU::ImageInterface::is3D ( ) const
pure virtual

Check if the image is 3D.

Implemented in LLU::MContainer< MArgumentType::Image >, and LLU::ImageView.

◆ rawData()

virtual void* LLU::ImageInterface::rawData ( ) const
pure virtual

Get access to raw image data.

Use with caution.

Returns
pointer to the raw data
See also
http://reference.wolfram.com/language/LibraryLink/ref/callback/MImage_getRawData.html

Implemented in LLU::MContainer< MArgumentType::Image >, and LLU::ImageView.

◆ rows()

virtual mint LLU::ImageInterface::rows ( ) const
pure virtual

◆ slices()

virtual mint LLU::ImageInterface::slices ( ) const
pure virtual

◆ type()

virtual imagedata_t LLU::ImageInterface::type ( ) const
pure virtual

Get the data type of the image.

Returns
type of elements (see definition of imagedata_t)
See also
http://reference.wolfram.com/language/LibraryLink/ref/callback/MImage_getDataType.html

Implemented in LLU::MContainer< MArgumentType::Image >, and LLU::ImageView.