ImageInfo Class Reference

Implements meta-data of images required by data::Load and data::Save for loading and saving images into arma::Mat. More...

Public Member Functions

 ImageInfo (const size_t width=0, const size_t height=0, const size_t channels=3, const size_t quality=90)
 Instantiate the ImageInfo object with the given image width, height, number of channels and quality parameter. More...

 
const size_t & Channels () const
 Get the image channels. More...

 
size_t & Channels ()
 Modify the image channels. More...

 
const size_t & Height () const
 Get the image height. More...

 
size_t & Height ()
 Modify the image height. More...

 
const size_t & Quality () const
 Get the image quality. More...

 
size_t & Quality ()
 Modify the image quality. More...

 
template
<
typename
Archive
>
void serialize (Archive &ar, const unsigned int)
 
const size_t & Width () const
 Get the image width. More...

 
size_t & Width ()
 Modify the image width. More...

 

Detailed Description

Implements meta-data of images required by data::Load and data::Save for loading and saving images into arma::Mat.

Definition at line 36 of file image_info.hpp.

Constructor & Destructor Documentation

◆ ImageInfo()

ImageInfo ( const size_t  width = 0,
const size_t  height = 0,
const size_t  channels = 3,
const size_t  quality = 90 
)

Instantiate the ImageInfo object with the given image width, height, number of channels and quality parameter.

Parameters
widthImage width.
heightImage height.
channelsNumber of channels in the image.
qualityCompression of the image if saved as jpg (0 - 100).

Member Function Documentation

◆ Channels() [1/2]

const size_t& Channels ( ) const
inline

Get the image channels.

Definition at line 64 of file image_info.hpp.

◆ Channels() [2/2]

size_t& Channels ( )
inline

Modify the image channels.

Definition at line 66 of file image_info.hpp.

◆ Height() [1/2]

const size_t& Height ( ) const
inline

Get the image height.

Definition at line 59 of file image_info.hpp.

◆ Height() [2/2]

size_t& Height ( )
inline

Modify the image height.

Definition at line 61 of file image_info.hpp.

◆ Quality() [1/2]

const size_t& Quality ( ) const
inline

Get the image quality.

Definition at line 69 of file image_info.hpp.

◆ Quality() [2/2]

size_t& Quality ( )
inline

Modify the image quality.

Definition at line 71 of file image_info.hpp.

◆ serialize()

void serialize ( Archive &  ar,
const unsigned  int 
)
inline

Definition at line 74 of file image_info.hpp.

◆ Width() [1/2]

const size_t& Width ( ) const
inline

Get the image width.

Definition at line 54 of file image_info.hpp.

◆ Width() [2/2]

size_t& Width ( )
inline

Modify the image width.

Definition at line 56 of file image_info.hpp.


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.3.2/src/mlpack/core/data/image_info.hpp