SourceXtractorPlusPlus  0.16
Please provide a description of the project.
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
SourceXtractor::SubImage< T > Class Template Reference

Part of another image. More...

#include <SubImage.h>

Inheritance diagram for SourceXtractor::SubImage< T >:
[legend]
Collaboration diagram for SourceXtractor::SubImage< T >:
[legend]

Public Member Functions

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

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 SourceXtractor::SubImage< T >::getHeight(), SourceXtractor::SubImage< T >::getWidth(), SourceXtractor::PixelCoordinate::m_x, and SourceXtractor::PixelCoordinate::m_y.

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 SourceXtractor::SubImage< T >::getHeight(), SourceXtractor::SubImage< T >::getWidth(), x, and y.

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>
static std::shared_ptr<SubImage<T> > SourceXtractor::SubImage< T >::create ( Args &&...  args)
inlinestatic

◆ getChunk()

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

◆ 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 SourceXtractor::SubImage< T >::m_height.

Referenced by SourceXtractor::SubImage< T >::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 SourceXtractor::SubImage< T >::m_height, SourceXtractor::SubImage< T >::m_image, SourceXtractor::SubImage< T >::m_offset, SourceXtractor::SubImage< T >::m_width, SourceXtractor::PixelCoordinate::m_x, SourceXtractor::PixelCoordinate::m_y, 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 SourceXtractor::SubImage< T >::m_width.

Referenced by SourceXtractor::SubImage< T >::SubImage().

Member Data Documentation

◆ m_height

template<typename T >
int SourceXtractor::SubImage< T >::m_height
private

◆ m_image

template<typename T >
std::shared_ptr<const Image<T> > SourceXtractor::SubImage< T >::m_image
private

◆ m_offset

template<typename T >
PixelCoordinate SourceXtractor::SubImage< T >::m_offset
private

◆ m_width

template<typename T >
int SourceXtractor::SubImage< T >::m_width
private

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