SourceXtractor::ThresholdedImage< T > Class Template Reference

Used to subtract a constant value from an Image. More...

#include <ThresholdedImage.h>

Inheritance diagram for SourceXtractor::ThresholdedImage< T >:

Collaboration diagram for SourceXtractor::ThresholdedImage< T >:

Public Member Functions
virtual	~ThresholdedImage ()=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
static std::shared_ptr< ThresholdedImage< T > >	create (std::shared_ptr< const Image< T > > image, std::shared_ptr< const Image< T > > variance_map, T threshold_multiplier)

Protected Member Functions
	ThresholdedImage (std::shared_ptr< const Image< T > > image, std::shared_ptr< const Image< T > > variance_map, T threshold_multiplier)

Private Attributes
std::shared_ptr< const Image< T > >	m_image
std::shared_ptr< const Image< T > >	m_variance_map
T	m_threshold_multiplier

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

Detailed Description

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

Used to subtract a constant value from an Image.

Definition at line 41 of file ThresholdedImage.h.

Constructor & Destructor Documentation

ThresholdedImage()

template<typename T >

SourceXtractor::ThresholdedImage< T >::ThresholdedImage ( std::shared_ptr< const Image< T > > image, std::shared_ptr< const Image< T > > variance_map, T threshold_multiplier )

inlineprotected

Definition at line 45 of file ThresholdedImage.h.

References SourceXtractor::ThresholdedImage< T >::m_image, and SourceXtractor::ThresholdedImage< T >::m_variance_map.

~ThresholdedImage()

template<typename T >

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

virtualdefault

Destructor.

Member Function Documentation

create()

template<typename T >

static std::shared_ptr< ThresholdedImage< T > > SourceXtractor::ThresholdedImage< T >::create ( std::shared_ptr< const Image< T > > image, std::shared_ptr< const Image< T > > variance_map, T threshold_multiplier )

inlinestatic

Definition at line 58 of file ThresholdedImage.h.

getChunk()

template<typename T >

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

inlineoverridevirtual

Implements SourceXtractor::Image< T >.

Definition at line 75 of file ThresholdedImage.h.

References SourceXtractor::UniversalImageChunk< T >::create(), SourceXtractor::ThresholdedImage< T >::m_image, SourceXtractor::ThresholdedImage< T >::m_threshold_multiplier, SourceXtractor::ThresholdedImage< T >::m_variance_map, std::move(), std::sqrt(), x, and y.

Here is the call graph for this function:

getHeight()

template<typename T >

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

inlineoverridevirtual

Returns the height of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 71 of file ThresholdedImage.h.

References SourceXtractor::ThresholdedImage< T >::m_image.

getRepr()

template<typename T >

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

inlineoverridevirtual

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

Implements SourceXtractor::Image< T >.

Definition at line 63 of file ThresholdedImage.h.

References SourceXtractor::ThresholdedImage< T >::m_image.

getWidth()

template<typename T >

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

inlineoverridevirtual

Returns the width of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 67 of file ThresholdedImage.h.

References SourceXtractor::ThresholdedImage< T >::m_image.

Member Data Documentation

m_image

template<typename T >

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

private

Definition at line 88 of file ThresholdedImage.h.

Referenced by SourceXtractor::ThresholdedImage< T >::getChunk(), SourceXtractor::ThresholdedImage< T >::getHeight(), SourceXtractor::ThresholdedImage< T >::getRepr(), SourceXtractor::ThresholdedImage< T >::getWidth(), and SourceXtractor::ThresholdedImage< T >::ThresholdedImage().

m_threshold_multiplier

template<typename T >

T SourceXtractor::ThresholdedImage< T >::m_threshold_multiplier

private

Definition at line 89 of file ThresholdedImage.h.

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

m_variance_map

template<typename T >

std::shared_ptr<const Image<T> > SourceXtractor::ThresholdedImage< T >::m_variance_map

private

Definition at line 88 of file ThresholdedImage.h.

Referenced by SourceXtractor::ThresholdedImage< T >::getChunk(), and SourceXtractor::ThresholdedImage< T >::ThresholdedImage().

---

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

• SEFramework/SEFramework/Image/ThresholdedImage.h