peak::ipl::PixelLine Class Reference

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

#include <peak_ipl/types/peak_ipl_pixel_line.hpp>

Inheritance diagram for peak::ipl::PixelLine:

Data Structures
struct	Channel
	Represents the values of the pixel line. More...

Public Member Functions
	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 of a horizontal or vertical line of pixels in an image.

Constructor & Destructor Documentation

PixelLine() [1/4]

peak::ipl::PixelLine::PixelLine ( )

delete

PixelLine() [2/4]

peak::ipl::PixelLine::PixelLine ( const Image &  image, peak::ipl::Orientation  orientation, size_t  offset  )

inlineexplicit

Constructor.

Parameters

[in]	image	The image to process.
[in]	orientation	The orientation of the pixel line.
[in]	offset	Y offset if orientation = peak::ipl::Orientation::Horizontal; X offset if orientation = peak::ipl::Orientation::Vertical

Exceptions

ImageFormatNotSupportedException

image has a packed pixel format

Since

1.0

1.2 Will throw ImageFormatNotSupportedException if image has a packed pixel format

~PixelLine()

peak::ipl::PixelLine::~PixelLine ( )

inlinevirtual

Destructor for the PixelLine instance.

Destroys a PixelLine instance.

Since

1.0

PixelLine() [3/4]

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

inline

Copy Constructor for a new PixelLine instance.

Creates a new PixelLine instance.

Note

This only creates a shallow copy. See Shallow copy (since 1.8) for a detailed explanation.

Parameters

[in]

other

The other instance to acquire a reference for.

Since

1.0 Deleted

1.8 Implemented as shallow copy

PixelLine() [4/4]

peak::ipl::PixelLine::PixelLine ( PixelLine &&  other )

inlinenoexcept

Move constructor for PixelLine instance.

Moves the instance from other to this. Afterwards other is invalid.

Parameters

[in]

other

The other instance to move.

Since

1.0

Member Function Documentation

Channels()

std::vector< PixelLine::Channel > peak::ipl::PixelLine::Channels ( ) const

inline

Returns the number of the given pixel line's channels.

Returns

Channels

Since

1.0

Exceptions

Exception

An internal error has occurred.

Offset()

size_t peak::ipl::PixelLine::Offset ( ) const

inline

Returns the offset of the given pixel line. (Vertical: Left - Horizontal: Top).

Returns

Offset

Since

1.0

Exceptions

Exception

An internal error has occurred.

operator=() [1/2]

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

inline

Copy assigment for PixelLine instance.

Acquires a reference from other to this instance. If this instance already has a reference, it will be destroyed.

Note

See Shallow copy (since 1.8) for a detailed explanation.

Parameters

[in]

other

The other instance to acquire a reference for.

Since

1.0 Deleted

1.8 Implemented as shallow copy

operator=() [2/2]

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

inlinenoexcept

Move assignment for PixelLine instance.

Moves the instance from other to this. Afterwards other is invalid.

Parameters

[in]

other

The other instance to move.

Since

1.0

Orientation()

peak::ipl::Orientation peak::ipl::PixelLine::Orientation ( ) const

inline

Returns the orientation of the given pixel line.

Returns

Orientation

Since

1.0

Exceptions

Exception

An internal error has occurred.

PixelFormatName()

peak::ipl::PixelFormatName peak::ipl::PixelLine::PixelFormatName ( ) const

inline

Returns the pixel format of the given pixel line.

Returns

PixelFormatName

Since

1.0

Exceptions

Exception

An internal error has occurred.

---

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

• peak_ipl/types/peak_ipl_pixel_line.hpp