Turi Create  4.0
turi::image_type Class Reference

#include <core/data/image/image_type.hpp>

Public Member Functions

 image_type ()=default
 Constructor.
 
 image_type (const char *image_data, size_t height, size_t width, size_t channels, size_t image_data_size, int version, int format)
 Construct from existing data.
 
 image_type (const boost::gil::rgb8_image_t &gil_image)
 Construct from a Boost GIL rgb8 Image.
 
 image_type (const boost::gil::rgba8_image_t &gil_image)
 Construct from a Boost GIL rgba8 Image.
 
bool is_decoded () const
 Check whether image is decoded.
 
void save (oarchive &oarc) const
 Serialization.
 
void load (iarchive &iarc)
 Deserialization.
 
const unsigned char * get_image_data () const
 Returns a char* pointer to the raw image data.
 
bool operator== (const image_type &other) const
 Equality comparator, two images are equal when every property is identical.
 

Public Attributes

boost::shared_ptr< char[]> m_image_data
 The image data, stored in the format indicated by m_format in a char array.
 
size_t m_height = 0
 The height of the image.
 
size_t m_width = 0
 The width of the image.
 
size_t m_channels = 0
 The number of channels in the image: Grayscale = 1, RGB = 3, RGBA = 4.
 
size_t m_image_data_size = 0
 Length of m_image_data char array.
 
char m_version = IMAGE_TYPE_CURRENT_VERSION
 Version of image_type object.
 
Format m_format = Format::UNDEFINED
 Format of data, intitialized as UNDEFINED.
 

Detailed Description

Image type, which is typedef'd to flex_image, part of the flexible_type union. Holds image data and meta-data pertaining to image size and file type, but does not hold meta-data like path or category.

Definition at line 35 of file image_type.hpp.


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