peak::ipl::PixelColumn Class Reference

Represents the values for a vertical line of pixels in an image. More...

#include <peak_ipl/types/peak_ipl_pixel_line.hpp>

Inheritance diagram for peak::ipl::PixelColumn:

Public Member Functions
	PixelColumn ()=delete
	PixelColumn (const Image &image, size_t column)
	~PixelColumn () override=default
	PixelColumn (const PixelColumn &other)=default
PixelColumn &	operator= (const PixelColumn &other)=default
	PixelColumn (PixelColumn &&other)=default
PixelColumn &	operator= (PixelColumn &&other)=default
Public Member Functions inherited from peak::ipl::PixelLine
	PixelLine ()=delete
	PixelLine (const Image &image, peak::ipl::Orientation orientation, size_t offset)
	Constructor.
virtual	~PixelLine ()
	Destructor for the PixelLine instance.
	PixelLine (const PixelLine &other)
	Copy Constructor for a new PixelLine instance.
PixelLine &	operator= (const PixelLine &other)
	Copy assigment for PixelLine instance.
	PixelLine (PixelLine &&other) noexcept
	Move constructor for PixelLine instance.
PixelLine &	operator= (PixelLine &&other) noexcept
	Move assignment for PixelLine instance.
peak::ipl::PixelFormatName	PixelFormatName () const
	Returns the pixel format of the given pixel line.
peak::ipl::Orientation	Orientation () const
	Returns the orientation of the given pixel line.
size_t	Offset () const
	Returns the offset of the given pixel line. (Vertical: Left - Horizontal: Top).
std::vector< Channel >	Channels () const
	Returns the number of the given pixel line's channels.

Detailed Description

Represents the values for a vertical line of pixels in an image.

Constructor & Destructor Documentation

PixelColumn() [1/4]

peak::ipl::PixelColumn::PixelColumn ( )

delete

PixelColumn() [2/4]

peak::ipl::PixelColumn::PixelColumn ( const Image &  image, size_t  column  )

inlineexplicit

~PixelColumn()

peak::ipl::PixelColumn::~PixelColumn ( )

overridedefault

PixelColumn() [3/4]

peak::ipl::PixelColumn::PixelColumn ( const PixelColumn &  other )

default

PixelColumn() [4/4]

peak::ipl::PixelColumn::PixelColumn ( PixelColumn &&  other )

default

Member Function Documentation

operator=() [1/2]

PixelColumn & peak::ipl::PixelColumn::operator= ( const PixelColumn &  other )

default

operator=() [2/2]

PixelColumn & peak::ipl::PixelColumn::operator= ( PixelColumn &&  other )

default

---

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

• peak_ipl/types/peak_ipl_pixel_line.hpp