Fawkes API  Fawkes Development Version
firevision::Scaler Class Referenceabstract

Image scaler interface. More...

#include <>>

Inheritance diagram for firevision::Scaler:

Public Member Functions

virtual ~Scaler ()
 Virtual empty destructor. More...
 
virtual void set_scale_factor (float factor)=0
 Set scale factor. More...
 
virtual void set_original_dimensions (unsigned int width, unsigned int height)=0
 Set original image dimensions. More...
 
virtual void set_scaled_dimensions (unsigned int width, unsigned int height)=0
 Set dimenins of scaled image buffer. More...
 
virtual void set_original_buffer (unsigned char *buffer)=0
 Set original image buffer. More...
 
virtual void set_scaled_buffer (unsigned char *buffer)=0
 Set scaled image buffer. More...
 
virtual void scale ()=0
 Scale image. More...
 
virtual unsigned int needed_scaled_width ()=0
 Minimum needed width of scaled image depending on factor and original image width. More...
 
virtual unsigned int needed_scaled_height ()=0
 Minimum needed height of scaled image depending on factor and original image height. More...
 
virtual float get_scale_factor ()=0
 Returns the scale factor. More...
 

Detailed Description

Image scaler interface.

Image scalers allow for scaling images by a given factor.

Author
Tim Niemueller

Definition at line 32 of file scaler.h.

Constructor & Destructor Documentation

◆ ~Scaler()

firevision::Scaler::~Scaler ( )
virtual

Virtual empty destructor.

Definition at line 75 of file scaler.cpp.

Member Function Documentation

◆ get_scale_factor()

float firevision::Scaler::get_scale_factor ( )
pure virtual

Returns the scale factor.

Returns
the scale factor

Implemented in firevision::LossyScaler.

◆ needed_scaled_height()

unsigned int firevision::Scaler::needed_scaled_height ( )
pure virtual

Minimum needed height of scaled image depending on factor and original image height.

Returns
minimum needed height

Implemented in firevision::LossyScaler.

Referenced by MiniImageProducer::MiniImageProducer().

◆ needed_scaled_width()

unsigned int firevision::Scaler::needed_scaled_width ( )
pure virtual

Minimum needed width of scaled image depending on factor and original image width.

Returns
minimum needed width

Implemented in firevision::LossyScaler.

Referenced by MiniImageProducer::MiniImageProducer().

◆ scale()

void firevision::Scaler::scale ( )
pure virtual

Scale image.

Implemented in firevision::LossyScaler.

◆ set_original_buffer()

void firevision::Scaler::set_original_buffer ( unsigned char *  buffer)
pure virtual

Set original image buffer.

Parameters
bufferYUV 422 planar buffer

Implemented in firevision::LossyScaler.

◆ set_original_dimensions()

void firevision::Scaler::set_original_dimensions ( unsigned int  width,
unsigned int  height 
)
pure virtual

Set original image dimensions.

Parameters
widthimage width
heightheight

Implemented in firevision::LossyScaler.

Referenced by MiniImageProducer::MiniImageProducer().

◆ set_scale_factor()

void firevision::Scaler::set_scale_factor ( float  factor)
pure virtual

Set scale factor.

Parameters
factorscale factor

Implemented in firevision::LossyScaler.

Referenced by MiniImageProducer::MiniImageProducer().

◆ set_scaled_buffer()

void firevision::Scaler::set_scaled_buffer ( unsigned char *  buffer)
pure virtual

Set scaled image buffer.

Parameters
bufferYUV 422 planar buffer

Implemented in firevision::LossyScaler.

◆ set_scaled_dimensions()

void firevision::Scaler::set_scaled_dimensions ( unsigned int  width,
unsigned int  height 
)
pure virtual

Set dimenins of scaled image buffer.

Parameters
widthimage width
heightheight

Implemented in firevision::LossyScaler.


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