SourceXtractorPlusPlus: SourceXtractor::LockedWriteableImage< T > Class Template Reference

SourceXtractorPlusPlus 0.12

Please provide a description of the project.

#include <LockedWriteableImage.h>

Inheritance diagram for SourceXtractor::LockedWriteableImage< T >:

Collaboration diagram for SourceXtractor::LockedWriteableImage< T >:

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...

T	getValue (int x, int y) const override
	Returns the value of the pixel with the coordinates (x,y) More...

void	setValue (int x, int y, T value) override

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...

T	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 > >
T	enable_shared_from_this (T... args)

T	operator= (T... args)

T	shared_from_this (T... args)

T	~enable_shared_from_this (T... args)

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

Protected Member Functions
	LockedWriteableImage (std::shared_ptr< WriteableImage< T >> img)

Private Attributes
std::shared_ptr< WriteableImage< T > >	m_img

std::lock_guard< std::recursive_mutex >	m_lock

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

Detailed Description

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

Definition at line 19 of file LockedWriteableImage.h.

Constructor & Destructor Documentation

◆ LockedWriteableImage()

template<typename T >

SourceXtractor::LockedWriteableImage< T >::LockedWriteableImage ( std::shared_ptr< WriteableImage< T >> img )

inlineprotected

Definition at line 21 of file LockedWriteableImage.h.

Member Function Documentation

◆ create()

template<typename T >

template<typename... Args>

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

inlinestatic

Definition at line 26 of file LockedWriteableImage.h.

Referenced by SourceXtractor::CheckImages::getApertureImage(), SourceXtractor::CheckImages::getAutoApertureImage(), SourceXtractor::CheckImages::getGroupImage(), SourceXtractor::CheckImages::getModelFittingImage(), SourceXtractor::CheckImages::getMoffatImage(), SourceXtractor::CheckImages::getPartitionImage(), SourceXtractor::CheckImages::getPsfImage(), and SourceXtractor::CheckImages::getSegmentationImage().

◆ getHeight()

template<typename T >

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

inlineoverridevirtual

Returns the height of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 38 of file LockedWriteableImage.h.

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

◆ getRepr()

template<typename T >

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

inlineoverridevirtual

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

Implements SourceXtractor::Image< T >.

Definition at line 30 of file LockedWriteableImage.h.

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

◆ getValue()

template<typename T >

T SourceXtractor::LockedWriteableImage< 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 42 of file LockedWriteableImage.h.

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

◆ getWidth()

template<typename T >

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

inlineoverridevirtual

Returns the width of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 34 of file LockedWriteableImage.h.

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

◆ setValue()

template<typename T >

void SourceXtractor::LockedWriteableImage< T >::setValue	(	int	x,
		int	y,
		T	value
	)

inlineoverridevirtual

Implements SourceXtractor::WriteableImage< T >.

Definition at line 46 of file LockedWriteableImage.h.

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

Member Data Documentation

◆ m_img

template<typename T >

std::shared_ptr<WriteableImage<T> > SourceXtractor::LockedWriteableImage< T >::m_img

private

Definition at line 51 of file LockedWriteableImage.h.

Referenced by SourceXtractor::LockedWriteableImage< T >::getHeight(), SourceXtractor::LockedWriteableImage< T >::getRepr(), SourceXtractor::LockedWriteableImage< T >::getValue(), SourceXtractor::LockedWriteableImage< T >::getWidth(), and SourceXtractor::LockedWriteableImage< T >::setValue().

◆ m_lock

template<typename T >

std::lock_guard<std::recursive_mutex> SourceXtractor::LockedWriteableImage< T >::m_lock

private

Definition at line 52 of file LockedWriteableImage.h.

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

SEImplementation/SEImplementation/Image/LockedWriteableImage.h