SourceXtractor::Image< T > Class Template Reference

Interface representing an image. More...

#include <Image.h>

Inheritance diagram for SourceXtractor::Image< T >:

Public Types
using	PixelType = T

Public Member Functions
virtual	~Image ()=default
	Destructor.
virtual std::string	getRepr () const =0
	Get a string identifying this image in a human readable manner.
virtual int	getWidth () const =0
	Returns the width of the image in pixels.
virtual int	getHeight () const =0
	Returns the height of the image in pixels.
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.

Detailed Description

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

Interface representing an image.

Template Parameters

T	the type of the pixel values

Definition at line 44 of file Image.h.

Member Typedef Documentation

PixelType

template<typename T >

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

Definition at line 48 of file Image.h.

Constructor & Destructor Documentation

~Image()

template<typename T >

virtual SourceXtractor::Image< T >::~Image ( )

virtualdefault

Destructor.

Member Function Documentation

getChunk() [1/2]

template<typename T >

std::shared_ptr< ImageChunk< T > > SourceXtractor::Image< T >::getChunk ( const PixelCoordinate & start, const PixelCoordinate & end ) const

inline

Definition at line 66 of file Image.h.

References std::end(), SourceXtractor::Image< T >::getChunk(), SourceXtractor::Image< T >::isInside(), SourceXtractor::PixelCoordinate::m_x, and SourceXtractor::PixelCoordinate::m_y.

Here is the call graph for this function:

getChunk() [2/2]

template<typename T >

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

pure virtual

Implemented in SourceXtractor::FunctionalImage< T, I >, SourceXtractor::MaskedImage< T, M, Operator >, SourceXtractor::BufferedImage< T >, SourceXtractor::ImageAccessor< T >, SourceXtractor::ImageAccessor< WriteableInterfaceType::PixelType >, SourceXtractor::ImageChunk< T >, SourceXtractor::ImageChunk< WriteableInterfaceType::PixelType >, SourceXtractor::MirrorImage< T >, SourceXtractor::PaddedImage< T, CoordinateInterpolation >, SourceXtractor::PaddedImage< T, nullptr >, SourceXtractor::ProcessedImage< T, P >, SourceXtractor::RecenterImage< T >, SourceXtractor::SubImage< T >, SourceXtractor::ThresholdedImage< T >, SourceXtractor::VectorImage< T >, SourceXtractor::VectorImage< DetectionImage::PixelType >, SourceXtractor::VectorImage< int >, SourceXtractor::VectorImage< SeFloat >, SourceXtractor::VectorImage< SourceXtractor::SeFloat >, SourceXtractor::LockedWriteableImage< T >, and SourceXtractor::ConstantImage< T >.

Referenced by SourceXtractor::Image< T >::getChunk().

getHeight()

template<typename T >

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

pure virtual

Returns the height of the image in pixels.

Implemented in SourceXtractor::ConstantImage< T >, SourceXtractor::FunctionalImage< T, I >, SourceXtractor::ImageChunk< T >, SourceXtractor::ImageChunk< WriteableInterfaceType::PixelType >, SourceXtractor::MaskedImage< T, M, Operator >, SourceXtractor::VectorImage< T >, SourceXtractor::VectorImage< DetectionImage::PixelType >, SourceXtractor::VectorImage< int >, SourceXtractor::VectorImage< SeFloat >, SourceXtractor::VectorImage< SourceXtractor::SeFloat >, SourceXtractor::BufferedImage< T >, SourceXtractor::ImageAccessor< T >, SourceXtractor::ImageAccessor< WriteableInterfaceType::PixelType >, SourceXtractor::MirrorImage< T >, SourceXtractor::PaddedImage< T, CoordinateInterpolation >, SourceXtractor::PaddedImage< T, nullptr >, SourceXtractor::ProcessedImage< T, P >, SourceXtractor::RecenterImage< T >, SourceXtractor::SubImage< T >, SourceXtractor::ThresholdedImage< T >, and SourceXtractor::LockedWriteableImage< T >.

Referenced by SourceXtractor::Image< T >::isInside().

getRepr()

template<typename T >

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

pure virtual

Get a string identifying this image in a human readable manner.

Implemented in SourceXtractor::ConstantImage< T >, SourceXtractor::FunctionalImage< T, I >, SourceXtractor::MaskedImage< T, M, Operator >, SourceXtractor::VectorImage< T >, SourceXtractor::VectorImage< DetectionImage::PixelType >, SourceXtractor::VectorImage< int >, SourceXtractor::VectorImage< SeFloat >, SourceXtractor::VectorImage< SourceXtractor::SeFloat >, SourceXtractor::BufferedImage< T >, SourceXtractor::ImageAccessor< T >, SourceXtractor::ImageAccessor< WriteableInterfaceType::PixelType >, SourceXtractor::ImageChunk< T >, SourceXtractor::ImageChunk< WriteableInterfaceType::PixelType >, SourceXtractor::MirrorImage< T >, SourceXtractor::PaddedImage< T, CoordinateInterpolation >, SourceXtractor::PaddedImage< T, nullptr >, SourceXtractor::ProcessedImage< T, P >, SourceXtractor::RecenterImage< T >, SourceXtractor::SubImage< T >, SourceXtractor::ThresholdedImage< T >, and SourceXtractor::LockedWriteableImage< T >.

getWidth()

template<typename T >

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

pure virtual

Returns the width of the image in pixels.

Implemented in SourceXtractor::ConstantImage< T >, SourceXtractor::FunctionalImage< T, I >, SourceXtractor::ImageChunk< T >, SourceXtractor::ImageChunk< WriteableInterfaceType::PixelType >, SourceXtractor::MaskedImage< T, M, Operator >, SourceXtractor::VectorImage< T >, SourceXtractor::VectorImage< DetectionImage::PixelType >, SourceXtractor::VectorImage< int >, SourceXtractor::VectorImage< SeFloat >, SourceXtractor::VectorImage< SourceXtractor::SeFloat >, SourceXtractor::BufferedImage< T >, SourceXtractor::ImageAccessor< T >, SourceXtractor::ImageAccessor< WriteableInterfaceType::PixelType >, SourceXtractor::MirrorImage< T >, SourceXtractor::PaddedImage< T, CoordinateInterpolation >, SourceXtractor::PaddedImage< T, nullptr >, SourceXtractor::ProcessedImage< T, P >, SourceXtractor::RecenterImage< T >, SourceXtractor::SubImage< T >, SourceXtractor::ThresholdedImage< T >, and SourceXtractor::LockedWriteableImage< T >.

Referenced by SourceXtractor::Image< T >::isInside().

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.

References SourceXtractor::Image< T >::getHeight(), SourceXtractor::Image< T >::getWidth(), x, and y.

Referenced by SourceXtractor::Image< T >::getChunk().

Here is the call graph for this function:

---

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

• SEFramework/SEFramework/Image/Image.h