Imaging_scale Class Reference

Scale of each viewing world dimension in the imaging system. More...

#include <imaging_model.h>

List of all members.

Public Member Functions
	Imaging_scale () throw (jwscxx::base::Arg_error)
	Constructs an Imaging_scale initialized with default values.
virtual	~Imaging_scale ()
	Deletes this Imaging_scale.
float	get_x () const
	Returns the number of world x-units per pixel width.
float	get_y () const
	Returns the number of world y-units per pixel height.
float	get_z () const
	Returns the number of world z-units per image.
void	set (float x, float y, float z) throw (jwscxx::base::Arg_error)
	Sets the scale.
Protected Attributes
float	x
	Number of viewing world units in the x-dimension per pixel column width.
float	y
	Number of viewing world units in the y-dimension per pixel row height.
float	z
	Number of viewing world units in the z-dimension per image.
Friends
std::ostream &	operator<< (std::ostream &, const Imaging_scale &)
	Prints an Imaging_scale to an output stream.
std::istream &	operator>> (std::istream &, Imaging_scale &)
	Reads an Imaging_scale into an input stream.

---

Detailed Description

Scale of each viewing world dimension in the imaging system.

Definition at line 154 of file imaging_model.h.

---

Constructor & Destructor Documentation

Imaging_scale::Imaging_scale

(

)

throw (jwscxx::base::Arg_error)

Constructs an Imaging_scale initialized with default values.

Initializes with default values.

Exceptions:

jwscxx::base::Arg_error

Scale not > 0.

Definition at line 194 of file imaging_model.cpp.

virtual Imaging_scale::~Imaging_scale

(

)

[inline, virtual]

Deletes this Imaging_scale.

Definition at line 165 of file imaging_model.h.

---

Member Function Documentation

float Imaging_scale::get_x

(

)

const [inline]

Returns the number of world x-units per pixel width.

Definition at line 169 of file imaging_model.h.

float Imaging_scale::get_y

(

)

const [inline]

Returns the number of world y-units per pixel height.

Definition at line 173 of file imaging_model.h.

float Imaging_scale::get_z

(

)

const [inline]

Returns the number of world z-units per image.

Definition at line 177 of file imaging_model.h.

void Imaging_scale::set	(	float	x,
		float	y,
		float	z
	)		throw (jwscxx::base::Arg_error)

Sets the scale.

Parameters:

x	Imaging_scale::x
y	Imaging_scale::y
z	Imaging_scale::z

Exceptions:

jwscxx::base::Arg_error

Scale not > 0.

Definition at line 207 of file imaging_model.cpp.

---

Friends And Related Function Documentation

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

Prints an Imaging_scale to an output stream.

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

Reads an Imaging_scale into an input stream.

---

Member Data Documentation

float Imaging_scale::x [protected]

Number of viewing world units in the x-dimension per pixel column width.

Definition at line 190 of file imaging_model.h.

float Imaging_scale::y [protected]

Number of viewing world units in the y-dimension per pixel row height.

Definition at line 196 of file imaging_model.h.

float Imaging_scale::z [protected]

Number of viewing world units in the z-dimension per image.

Definition at line 201 of file imaging_model.h.

---

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

• imaging_model.h
• imaging_model.cpp