Imaging_window Class Reference

Images of windows to analyze. More...

#include <imaging_model.h>

List of all members.

Public Member Functions
	Imaging_window () throw (jwscxx::base::Arg_error)
	Constructs an Imaging_window initialized with default values.
virtual	~Imaging_window ()
	Deletes this Imaging_window.
uint32_t	get_col () const
	Returns the first column index of the window.
uint32_t	get_row () const
	Returns the first row index of the window.
uint32_t	get_img () const
	Returns the first image index of the window.
uint32_t	get_num_cols () const
	Returns the number of columns in the window.
uint32_t	get_num_rows () const
	Returns the number of rows in the window.
uint32_t	get_num_imgs () const
	Returns the number of images in the window.
void	set (uint32_t col, uint32_t row, uint32_t img, uint32_t num_cols, uint32_t num_rows, uint32_t num_imgs) throw (jwscxx::base::Arg_error)
	Sets the window.
Protected Attributes
uint32_t	col
	First column index of the window in the images.
uint32_t	row
	First row index of the window in the images.
uint32_t	img
	First image index of the window in the images.
uint32_t	num_cols
	Number of columns in the window.
uint32_t	num_rows
	Number of rows in the window.
uint32_t	num_imgs
	Number of images in the window.
Friends
std::ostream &	operator<< (std::ostream &, const Imaging_window &)
	Prints an Imaging_window to an output stream.
std::istream &	operator>> (std::istream &, Imaging_window &)
	Reads an Imaging_window into an input stream.

---

Detailed Description

Images of windows to analyze.

Definition at line 68 of file imaging_model.h.

---

Constructor & Destructor Documentation

Imaging_window::Imaging_window

(

)

throw (jwscxx::base::Arg_error)

Constructs an Imaging_window initialized with default values.

Initializes with default values.

Exceptions:

jwscxx::base::Arg_error

Number of columns, rows or images is 0.

Definition at line 108 of file imaging_model.cpp.

virtual Imaging_window::~Imaging_window

(

)

[inline, virtual]

Deletes this Imaging_window.

Definition at line 79 of file imaging_model.h.

---

Member Function Documentation

uint32_t Imaging_window::get_col

(

)

const [inline]

Returns the first column index of the window.

Definition at line 83 of file imaging_model.h.

uint32_t Imaging_window::get_row

(

)

const [inline]

Returns the first row index of the window.

Definition at line 87 of file imaging_model.h.

uint32_t Imaging_window::get_img

(

)

const [inline]

Returns the first image index of the window.

Definition at line 91 of file imaging_model.h.

uint32_t Imaging_window::get_num_cols

(

)

const [inline]

Returns the number of columns in the window.

Definition at line 95 of file imaging_model.h.

uint32_t Imaging_window::get_num_rows

(

)

const [inline]

Returns the number of rows in the window.

Definition at line 99 of file imaging_model.h.

uint32_t Imaging_window::get_num_imgs

(

)

const [inline]

Returns the number of images in the window.

Definition at line 103 of file imaging_model.h.

void Imaging_window::set	(	uint32_t	col,
		uint32_t	row,
		uint32_t	img,
		uint32_t	num_cols,
		uint32_t	num_rows,
		uint32_t	num_imgs
	)		throw (jwscxx::base::Arg_error)

Sets the window.

Parameters:

col	Imaging_window::col
row	Imaging_window::row
img	Imaging_window::img
num_cols	Imaging_window::num_cols
num_rows	Imaging_window::num_rows
num_imgs	Imaging_window::num_imgs

Exceptions:

jwscxx::base::Arg_error

Number of columns, rows or images is 0.

Definition at line 126 of file imaging_model.cpp.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	,
		const Imaging_window &
	)		[friend]

Prints an Imaging_window to an output stream.

std::istream& operator>>	(	std::istream &	,
		Imaging_window &
	)		[friend]

Reads an Imaging_window into an input stream.

---

Member Data Documentation

uint32_t Imaging_window::col [protected]

First column index of the window in the images.

Definition at line 122 of file imaging_model.h.

uint32_t Imaging_window::row [protected]

First row index of the window in the images.

Definition at line 125 of file imaging_model.h.

uint32_t Imaging_window::img [protected]

First image index of the window in the images.

Definition at line 128 of file imaging_model.h.

uint32_t Imaging_window::num_cols [protected]

Number of columns in the window.

Definition at line 131 of file imaging_model.h.

uint32_t Imaging_window::num_rows [protected]

Number of rows in the window.

Definition at line 134 of file imaging_model.h.

uint32_t Imaging_window::num_imgs [protected]

Number of images in the window.

Definition at line 137 of file imaging_model.h.

---

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

• imaging_model.h
• imaging_model.cpp