SourceXtractor::SubImage< T > Class Template Reference

Part of another image. More...

#include <SubImage.h>

Inheritance diagram for SourceXtractor::SubImage< T >:

Collaboration diagram for SourceXtractor::SubImage< T >:

Public Member Functions
virtual	~SubImage ()=default
	Destructor.
std::string	getRepr () const override
	Get a string identifying this image in a human readable manner.
int	getWidth () const override
	Returns the width of the image in pixels.
int	getHeight () const override
	Returns the height of the image in pixels.
std::shared_ptr< ImageChunk< T > >	getChunk (int x, int y, int width, int height) const override
Public Member Functions inherited from SourceXtractor::Image< T >
virtual	~Image ()=default
	Destructor.
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.

Static Public Member Functions
template<typename... Args>
static std::shared_ptr< SubImage< T > >	create (Args &&... args)

Protected Member Functions
	SubImage (std::shared_ptr< const Image< T > > image, const PixelCoordinate &offset, int width, int height)
	SubImage (std::shared_ptr< const Image< T > > image, int x, int y, int width, int height)

Private Attributes
std::shared_ptr< const Image< T > >	m_image
PixelCoordinate	m_offset
int	m_width
int	m_height

Additional Inherited Members
Public Types inherited from SourceXtractor::Image< T >
using	PixelType = T

Detailed Description

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

Part of another image.

Definition at line 34 of file SubImage.h.

Constructor & Destructor Documentation

SubImage() [1/2]

template<typename T>

SourceXtractor::SubImage< T >::SubImage ( std::shared_ptr< const Image< T > > image, const PixelCoordinate & offset, int width, int height )

inlineprotected

Definition at line 36 of file SubImage.h.

References getHeight(), getWidth(), m_height, m_image, m_offset, m_width, SourceXtractor::PixelCoordinate::m_x, and SourceXtractor::PixelCoordinate::m_y.

Referenced by create().

Here is the call graph for this function:

SubImage() [2/2]

template<typename T>

SourceXtractor::SubImage< T >::SubImage ( std::shared_ptr< const Image< T > > image, int x, int y, int width, int height )

inlineprotected

Definition at line 42 of file SubImage.h.

References getHeight(), getWidth(), m_height, m_image, m_offset, and m_width.

Here is the call graph for this function:

~SubImage()

template<typename T>

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

virtualdefault

Destructor.

Member Function Documentation

create()

template<typename T>

template<typename... Args>

std::shared_ptr< SubImage< T > > SourceXtractor::SubImage< T >::create ( Args &&... args )

inlinestatic

Definition at line 55 of file SubImage.h.

References std::forward(), and SubImage().

Referenced by SourceXtractor::BgDFTConvolutionImageSource::generateTile().

Here is the call graph for this function:

getChunk()

template<typename T>

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

inlineoverridevirtual

Implements SourceXtractor::Image< T >.

Definition at line 71 of file SubImage.h.

References m_image, and m_offset.

getHeight()

template<typename T>

int SourceXtractor::SubImage< T >::getHeight ( ) const

inlineoverridevirtual

Returns the height of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 67 of file SubImage.h.

References m_height.

Referenced by SubImage(), and SubImage().

getRepr()

template<typename T>

std::string SourceXtractor::SubImage< T >::getRepr ( ) const

inlineoverridevirtual

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

Implements SourceXtractor::Image< T >.

Definition at line 59 of file SubImage.h.

References m_height, m_image, m_offset, m_width, and std::to_string().

Here is the call graph for this function:

getWidth()

template<typename T>

int SourceXtractor::SubImage< T >::getWidth ( ) const

inlineoverridevirtual

Returns the width of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 63 of file SubImage.h.

References m_width.

Referenced by SubImage(), and SubImage().

Member Data Documentation

m_height

template<typename T>

int SourceXtractor::SubImage< T >::m_height

private

Definition at line 78 of file SubImage.h.

Referenced by getHeight(), getRepr(), SubImage(), and SubImage().

m_image

template<typename T>

std::shared_ptr<const Image<T> > SourceXtractor::SubImage< T >::m_image

private

Definition at line 76 of file SubImage.h.

Referenced by getChunk(), getRepr(), SubImage(), and SubImage().

m_offset

template<typename T>

PixelCoordinate SourceXtractor::SubImage< T >::m_offset

private

Definition at line 77 of file SubImage.h.

Referenced by getChunk(), getRepr(), SubImage(), and SubImage().

m_width

template<typename T>

int SourceXtractor::SubImage< T >::m_width

private

Definition at line 78 of file SubImage.h.

Referenced by getRepr(), getWidth(), SubImage(), and SubImage().

---

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

• SEFramework/SEFramework/Image/SubImage.h