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::RecenterImage< T > Class Template Reference

Changes the center of an image, wrapping it around the edges. More...

#include <RecenterImage.h>

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

Public Member Functions

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< RecenterImage< T > > create (Args &&... args)
 

Protected Member Functions

 RecenterImage (std::shared_ptr< const Image< T >> img, const PixelCoordinate &new_center)
 

Private Attributes

std::shared_ptr< const Image< T > > m_img
 
PixelCoordinate m_center
 

Additional Inherited Members

- Public Types inherited from SourceXtractor::Image< T >
using PixelType = T
 

Detailed Description

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

Changes the center of an image, wrapping it around the edges.

Definition at line 36 of file RecenterImage.h.

Constructor & Destructor Documentation

◆ RecenterImage()

template<typename T >
SourceXtractor::RecenterImage< T >::RecenterImage ( std::shared_ptr< const Image< T >>  img,
const PixelCoordinate new_center 
)
inlineprotected

Definition at line 38 of file RecenterImage.h.

Member Function Documentation

◆ create()

template<typename T >
template<typename... Args>
static std::shared_ptr<RecenterImage<T> > SourceXtractor::RecenterImage< T >::create ( Args &&...  args)
inlinestatic

◆ getChunk()

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

◆ getHeight()

template<typename T >
int SourceXtractor::RecenterImage< T >::getHeight ( ) const
inlineoverridevirtual

Returns the height of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 56 of file RecenterImage.h.

References SourceXtractor::RecenterImage< T >::m_img.

◆ getRepr()

template<typename T >
std::string SourceXtractor::RecenterImage< T >::getRepr ( ) const
inlineoverridevirtual

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

Implements SourceXtractor::Image< T >.

Definition at line 48 of file RecenterImage.h.

References SourceXtractor::RecenterImage< T >::m_img.

◆ getWidth()

template<typename T >
int SourceXtractor::RecenterImage< T >::getWidth ( ) const
inlineoverridevirtual

Returns the width of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 52 of file RecenterImage.h.

References SourceXtractor::RecenterImage< T >::m_img.

Member Data Documentation

◆ m_center

template<typename T >
PixelCoordinate SourceXtractor::RecenterImage< T >::m_center
private

Definition at line 78 of file RecenterImage.h.

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

◆ m_img

template<typename T >
std::shared_ptr<const Image<T> > SourceXtractor::RecenterImage< T >::m_img
private

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