SourceXtractorPlusPlus  0.13
Please provide a description of the project.
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 T getValue (int x, int y) const =0
 Returns the value of the pixel with the coordinates (x,y) More...
 
getValue (PixelCoordinate pc) const
 
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
 
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

◆ PixelType

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

Definition at line 47 of file Image.h.

Constructor & Destructor Documentation

◆ ~Image()

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

Destructor.

Member Function Documentation

◆ getChunk()

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

◆ getHeight()

template<typename T >
virtual int SourceXtractor::Image< T >::getHeight ( ) const
pure virtual

◆ getRepr()

template<typename T >
virtual std::string SourceXtractor::Image< T >::getRepr ( ) const
pure virtual

◆ getValue() [1/2]

template<typename T >
virtual T SourceXtractor::Image< T >::getValue ( int  x,
int  y 
) const
pure virtual

◆ getValue() [2/2]

template<typename T >
T SourceXtractor::Image< T >::getValue ( PixelCoordinate  pc) const
inline

Definition at line 60 of file Image.h.

◆ getWidth()

template<typename T >
virtual int SourceXtractor::Image< T >::getWidth ( ) const
pure virtual

◆ isInside()

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 73 of file Image.h.


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