SourceXtractorPlusPlus  0.15
Please provide a description of the project.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
SourceXtractor::Image< T > Class Template Referenceabstract

Interface representing an image. More...

#include <Image.h>

Inheritance diagram for SourceXtractor::Image< T >:
[legend]

Public Types

using PixelType = T
 

Public Member Functions

virtual ~Image ()=default
 Destructor. More...
 
virtual std::string getRepr () const =0
 Get a string identifying this image in a human readable manner. More...
 
virtual int getWidth () const =0
 Returns the width of the image in pixels. More...
 
virtual int getHeight () const =0
 Returns the height of the image in pixels. More...
 
virtual std::shared_ptr
< ImageChunk< T > > 
getChunk (int x, int y, int width, int height) const =0
 
std::shared_ptr< ImageChunk< T > > getChunk (const PixelCoordinate &start, const PixelCoordinate &end) const
 
bool isInside (int x, int y) const
 Returns true if the given coordinates are inside the image bounds. More...
 

Detailed Description

template<typename T>
class SourceXtractor::Image< T >

Interface representing an image.

Template Parameters
Tthe type of the pixel values

Definition at line 43 of file Image.h.

Member Typedef Documentation

template<typename T>
using SourceXtractor::Image< T >::PixelType = T

Definition at line 47 of file Image.h.

Constructor & Destructor Documentation

template<typename T>
virtual SourceXtractor::Image< T >::~Image ( )
virtualdefault

Destructor.

Member Function Documentation

template<typename T>
virtual std::shared_ptr<ImageChunk<T> > SourceXtractor::Image< T >::getChunk ( int  x,
int  y,
int  width,
int  height 
) const
pure virtual
template<typename T>
std::shared_ptr<ImageChunk<T> > SourceXtractor::Image< T >::getChunk ( const PixelCoordinate start,
const PixelCoordinate end 
) const
inline

Definition at line 65 of file Image.h.

template<typename T>
virtual int SourceXtractor::Image< T >::getHeight ( ) const
pure virtual
template<typename T>
virtual std::string SourceXtractor::Image< T >::getRepr ( ) const
pure virtual
template<typename T>
virtual int SourceXtractor::Image< T >::getWidth ( ) const
pure virtual
template<typename T>
bool SourceXtractor::Image< T >::isInside ( int  x,
int  y 
) const
inline

Returns true if the given coordinates are inside the image bounds.

Definition at line 72 of file Image.h.

Referenced by SourceXtractor::Image< SourceXtractor::Image::PixelType >::getChunk(), and SourceXtractor::getMirrorPixel().


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