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

Image implementation which keeps the pixel values in memory. More...

#include <VectorImage.h>

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

Public Member Functions

std::string getRepr () const final
 Get a string identifying this image in a human readable manner. More...
 
int getHeight () const final
 Returns the height of the image in pixels. More...
 
int getWidth () const final
 Returns the width of the image in pixels. More...
 
getValue (int x, int y) const final
 Returns the value of the pixel with the coordinates (x,y) More...
 
void setValue (int x, int y, T value) final
 
void setValue (PixelCoordinate pc, T value)
 
T & at (int x, int y)
 
void fillValue (T value)
 
const std::vector< T > & getData () const
 
std::vector< T > & getData ()
 
virtual ~VectorImage ()=default
 Destructor. More...
 
virtual std::shared_ptr< ImageChunk< T > > getChunk (int x, int y, int width, int height) const override
 
- Public Member Functions inherited from SourceXtractor::ImageBase< T >
virtual ~ImageBase ()
 
- Public Member Functions inherited from SourceXtractor::Image< T >
virtual ~Image ()=default
 Destructor. More...
 
getValue (PixelCoordinate pc) const
 
- 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< VectorImage< T > > create (Args &&... args)
 

Protected Member Functions

 VectorImage (int width, int height)
 
 VectorImage (int width, int height, std::vector< T > data)
 
template<typename Iter >
 VectorImage (int width, int height, Iter data_begin, Iter data_end, typename std::enable_if< std::is_base_of< std::input_iterator_tag, typename std::iterator_traits< Iter >::iterator_category >::value and std::is_same< T, typename std::iterator_traits< Iter >::value_type >::value >::type *=0)
 
 VectorImage (const Image< T > &other_image)
 
 VectorImage (const std::shared_ptr< const Image< T >> &other_image)
 

Private Attributes

int m_width
 
int m_height
 
std::vector< T > m_data
 

Additional Inherited Members

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

Detailed Description

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

Image implementation which keeps the pixel values in memory.

The pixel values are kept in a vector. The first element of the vector is the pixel with coordinate (0,0) and the following elements have increasing x and y indices, with the x index (in the width direction) increasing more rapidly. This means the order of the vector elements should be:

(0,0), (1,0), (2,0), ..., (width-1,0), (0,1), (1,1), ..., (width-1,height-1)

Template Parameters
Tthe type of the pixel values

Definition at line 53 of file VectorImage.h.

Constructor & Destructor Documentation

◆ VectorImage() [1/5]

template<typename T >
SourceXtractor::VectorImage< T >::VectorImage ( int  width,
int  height 
)
inlineprotected

Definition at line 56 of file VectorImage.h.

◆ VectorImage() [2/5]

template<typename T >
SourceXtractor::VectorImage< T >::VectorImage ( int  width,
int  height,
std::vector< T >  data 
)
inlineprotected

Definition at line 60 of file VectorImage.h.

◆ VectorImage() [3/5]

template<typename T >
template<typename Iter >
SourceXtractor::VectorImage< T >::VectorImage ( int  width,
int  height,
Iter  data_begin,
Iter  data_end,
typename std::enable_if< std::is_base_of< std::input_iterator_tag, typename std::iterator_traits< Iter >::iterator_category >::value and std::is_same< T, typename std::iterator_traits< Iter >::value_type >::value >::type *  = 0 
)
inlineprotected

Definition at line 67 of file VectorImage.h.

◆ VectorImage() [4/5]

template<typename T >
SourceXtractor::VectorImage< T >::VectorImage ( const Image< T > &  other_image)
inlineprotected

Definition at line 76 of file VectorImage.h.

◆ VectorImage() [5/5]

template<typename T >
SourceXtractor::VectorImage< T >::VectorImage ( const std::shared_ptr< const Image< T >> &  other_image)
inlineprotected

Definition at line 85 of file VectorImage.h.

◆ ~VectorImage()

template<typename T >
virtual SourceXtractor::VectorImage< T >::~VectorImage ( )
virtualdefault

Destructor.

Member Function Documentation

◆ at()

template<typename T >
T& SourceXtractor::VectorImage< T >::at ( int  x,
int  y 
)
inline

◆ create()

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

Definition at line 89 of file VectorImage.h.

Referenced by SourceXtractor::SEBackgroundLevelAnalyzer::analyzeBackground(), SourceXtractor::SimpleBackgroundAnalyzer::analyzeBackground(), BenchConvolution::benchmark(), SourceXtractor::BgConvolutionImageSource::BgConvolutionImageSource(), SourceXtractor::DetectionFrameGroupStampTask::computeProperties(), SourceXtractor::PsfTask::computeProperties(), SourceXtractor::DetectionFrameSourceStampTask::computeProperties(), SourceXtractor::MoffatModelFittingTask::computeProperties(), SourceXtractor::DirectConvolution< T, TPadding >::convolve(), SourceXtractor::FlexibleModelFittingTask::createImageCopy(), SourceXtractor::FlexibleModelFittingTask::createWeightImage(), ModelFitting::ImageTraits< ImageInterfaceTypePtr >::factory(), ModelFitting::ImageTraits< WriteableInterfaceTypePtr >::factory(), SourceXtractor::PsfPluginConfig::generateGaussianPsf(), BenchBackgroundConvolution::generateImage(), BenchConvolution::generateImage(), SourceXtractor::BgDFTConvolutionImageSource::generateTile(), SourceXtractor::ProcessedImage< T, P >::getChunk(), SourceXtractor::SegmentationConfig::getDefaultFilter(), SourceXtractor::VariablePsf::getPsf(), SourceXtractor::ImagePsf::getScaledKernel(), SourceXtractor::ImageMode< T >::ImageMode(), SourceXtractor::ImageTile< T >::ImageTile(), SourceXtractor::SegmentationConfig::loadASCIIFilter(), TestImage::mainMethod(), SourceXtractor::MedianFilter< T >::operator()(), SourceXtractor::MultiThresholdPartitionStep::partition(), SourceXtractor::readImage(), and SourceXtractor::readPsfEx().

◆ fillValue()

template<typename T >
void SourceXtractor::VectorImage< T >::fillValue ( value)
inline

Definition at line 123 of file VectorImage.h.

◆ getChunk()

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

Reimplemented from SourceXtractor::ImageBase< T >.

Definition at line 140 of file VectorImage.h.

◆ getData() [1/2]

template<typename T >
std::vector<T>& SourceXtractor::VectorImage< T >::getData ( )
inline

Definition at line 131 of file VectorImage.h.

◆ getData() [2/2]

template<typename T >
const std::vector<T>& SourceXtractor::VectorImage< T >::getData ( ) const
inline

Definition at line 127 of file VectorImage.h.

Referenced by SourceXtractor::getMedian().

◆ getHeight()

template<typename T >
int SourceXtractor::VectorImage< T >::getHeight ( ) const
inlinefinalvirtual

Returns the height of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 97 of file VectorImage.h.

◆ getRepr()

template<typename T >
std::string SourceXtractor::VectorImage< T >::getRepr ( ) const
inlinefinalvirtual

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

Implements SourceXtractor::Image< T >.

Definition at line 93 of file VectorImage.h.

◆ getValue()

template<typename T >
T SourceXtractor::VectorImage< T >::getValue ( int  x,
int  y 
) const
inlinefinalvirtual

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

Implements SourceXtractor::Image< T >.

Definition at line 106 of file VectorImage.h.

◆ getWidth()

template<typename T >
int SourceXtractor::VectorImage< T >::getWidth ( ) const
inlinefinalvirtual

Returns the width of the image in pixels.

Implements SourceXtractor::Image< T >.

Definition at line 101 of file VectorImage.h.

◆ setValue() [1/2]

template<typename T >
void SourceXtractor::VectorImage< T >::setValue ( int  x,
int  y,
value 
)
inlinefinalvirtual

◆ setValue() [2/2]

template<typename T >
void SourceXtractor::VectorImage< T >::setValue ( PixelCoordinate  pc,
value 
)
inline

Definition at line 114 of file VectorImage.h.

Member Data Documentation

◆ m_data

template<typename T >
std::vector<T> SourceXtractor::VectorImage< T >::m_data
private

◆ m_height

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

◆ m_width

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

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