numeric::linear_algebra::EllipseParameters Class Reference

Container class for ellipse parameters. More...

#include <EllipseParameters.hh>

Inheritance diagram for numeric::linear_algebra::EllipseParameters:

Public Member Functions
	EllipseParameters ()
	Default constructor for ellipse parameters. More...
	EllipseParameters (Real h, Real k, Real a, Real b, MathMatrix< Real > rotation)
	@Brief Construct a set of ellipse parameters given axes, center, and rotation More...
	EllipseParameters (EllipseParameters const &src)
	Create a new set of ellipse parameters from an existing initialized object. More...
	~EllipseParameters () override
EllipseParametersOP	clone () const
void	add_buffer (Real major_buffer, Real minor_buffer)
	Add buffer to major & minor radius. More...
Real	center_h () const
	Get the x-coordinate of the ellipse center. More...
Real	center_k () const
	Get the y-coordinate of the ellipse center. More...
Real	major_radius () const
	Get the major radius length of the ellipse. More...
Real	minor_radius () const
	Get the minor radius length of the ellipse. More...
MathMatrix< Real >	rotation () const
	2D matrix defining the ellipse rotation More...
Public Member Functions inherited from utility::VirtualBase
	VirtualBase ()=default
	Default constructor. More...
virtual	~VirtualBase ()=default
	The virtual destructor is one of the main reasons for the VirtualBase class. More...
	VirtualBase (VirtualBase const &)=default
	VirtualBase (VirtualBase &&)=default
VirtualBase &	operator= (VirtualBase const &)=default
VirtualBase &	operator= (VirtualBase &&)=default

Private Attributes
Real	h_
Real	k_
Real	a_
Real	b_
MathMatrix< Real >	rotation_

Detailed Description

Container class for ellipse parameters.

Constructor & Destructor Documentation

EllipseParameters() [1/3]

numeric::linear_algebra::EllipseParameters::EllipseParameters

(

)

Default constructor for ellipse parameters.

References rotation_.

Referenced by clone().

EllipseParameters() [2/3]

numeric::linear_algebra::EllipseParameters::EllipseParameters	(	Real	h,
		Real	k,
		Real	a,
		Real	b,
		MathMatrix< Real >	rotation
	)

@Brief Construct a set of ellipse parameters given axes, center, and rotation

EllipseParameters() [3/3]

numeric::linear_algebra::EllipseParameters::EllipseParameters

(

EllipseParameters const &

src

)

Create a new set of ellipse parameters from an existing initialized object.

~EllipseParameters()

numeric::linear_algebra::EllipseParameters::~EllipseParameters ( )

override

Member Function Documentation

add_buffer()

void numeric::linear_algebra::EllipseParameters::add_buffer	(	Real	major_buffer,
		Real	minor_buffer
	)

Add buffer to major & minor radius.

References a_, and b_.

center_h()

Real numeric::linear_algebra::EllipseParameters::center_h

(

)

const

Get the x-coordinate of the ellipse center.

References h_.

center_k()

Real numeric::linear_algebra::EllipseParameters::center_k

(

)

const

Get the y-coordinate of the ellipse center.

References k_.

clone()

EllipseParametersOP numeric::linear_algebra::EllipseParameters::clone

(

)

const

References EllipseParameters().

major_radius()

Real numeric::linear_algebra::EllipseParameters::major_radius

(

)

const

Get the major radius length of the ellipse.

References a_.

minor_radius()

Real numeric::linear_algebra::EllipseParameters::minor_radius

(

)

const

Get the minor radius length of the ellipse.

References b_.

rotation()

MathMatrix< Real > numeric::linear_algebra::EllipseParameters::rotation

(

)

const

2D matrix defining the ellipse rotation

References rotation_.

Member Data Documentation

a_

Real numeric::linear_algebra::EllipseParameters::a_

private

Referenced by add_buffer(), and major_radius().

b_

Real numeric::linear_algebra::EllipseParameters::b_

private

Referenced by add_buffer(), and minor_radius().

h_

Real numeric::linear_algebra::EllipseParameters::h_

private

Referenced by center_h().

k_

Real numeric::linear_algebra::EllipseParameters::k_

private

Referenced by center_k().

rotation_

MathMatrix< Real > numeric::linear_algebra::EllipseParameters::rotation_

private

Referenced by EllipseParameters(), and rotation().

---

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

• src/numeric/linear_algebra/EllipseParameters.hh
• src/numeric/linear_algebra/EllipseParameters.cc