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

#include <LockedImage.h>

Inheritance diagram for SourceXtractor::LockedImage< T >:
[legend]
Collaboration diagram for SourceXtractor::LockedImage< 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...
 
getValue (int x, int y) const override
 Returns the value of the pixel with the coordinates (x,y) More...
 
- Public Member Functions inherited from SourceXtractor::ImageBase< T >
virtual ~ImageBase ()
 
virtual 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...
 
getValue (PixelCoordinate pc) const
 
bool isInside (int x, int y) const
 Returns true if the given coordinates are inside the image bounds. More...
 
- Public Member Functions inherited from std::enable_shared_from_this< ImageBase< T > >
enable_shared_from_this (T... args)
 
operator= (T... args)
 
shared_from_this (T... args)
 
~enable_shared_from_this (T... args)
 

Static Public Member Functions

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

Protected Member Functions

 LockedImage (std::shared_ptr< const Image< T >> img)
 

Private Attributes

std::shared_ptr< const Image< T > > m_img
 
std::lock_guard< std::recursive_mutexm_lock
 

Additional Inherited Members

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

Detailed Description

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

Definition at line 28 of file LockedImage.h.

Constructor & Destructor Documentation

◆ LockedImage()

template<typename T >
SourceXtractor::LockedImage< T >::LockedImage ( std::shared_ptr< const Image< T >>  img)
inlineprotected

Definition at line 30 of file LockedImage.h.

Member Function Documentation

◆ create()

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

◆ getHeight()

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

Returns the height of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 47 of file LockedImage.h.

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

◆ getRepr()

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

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

Implements SourceXtractor::Image< T >.

Definition at line 39 of file LockedImage.h.

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

◆ getValue()

template<typename T >
T SourceXtractor::LockedImage< T >::getValue ( int  x,
int  y 
) const
inlineoverridevirtual

Returns the value of the pixel with the coordinates (x,y)

Implements SourceXtractor::Image< T >.

Definition at line 51 of file LockedImage.h.

References SourceXtractor::LockedImage< T >::m_img, x, and y.

◆ getWidth()

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

Returns the width of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 43 of file LockedImage.h.

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

Member Data Documentation

◆ m_img

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

◆ m_lock

template<typename T >
std::lock_guard<std::recursive_mutex> SourceXtractor::LockedImage< T >::m_lock
private

Definition at line 57 of file LockedImage.h.


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