Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
numeric::linear_algebra::EllipseParameters Class Reference

Container class for ellipse parameters. More...

#include <EllipseParameters.hh>

Inheritance diagram for numeric::linear_algebra::EllipseParameters:
Inheritance graph
[legend]

Public Member Functions

 EllipseParameters ()
 Default constructor for ellipse parameters. More...
 
 EllipseParameters (Real h, Real k, Real a, Real b, MathMatrix< Real > rotation)
 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< Realrotation () 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
 
VirtualBaseoperator= (VirtualBase const &)=default
 
VirtualBaseoperator= (VirtualBase &&)=default
 

Private Attributes

Real h_
 
Real k_
 
Real a_
 
Real b_
 
MathMatrix< Realrotation_
 

Detailed Description

Container class for ellipse parameters.

Constructor & Destructor Documentation

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

Default constructor for ellipse parameters.

References rotation_.

Referenced by clone().

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

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

numeric::linear_algebra::EllipseParameters::EllipseParameters ( EllipseParameters const &  src)

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

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

Member Function Documentation

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

Add buffer to major & minor radius.

References a_, and b_.

Real numeric::linear_algebra::EllipseParameters::center_h ( ) const

Get the x-coordinate of the ellipse center.

References h_.

Real numeric::linear_algebra::EllipseParameters::center_k ( ) const

Get the y-coordinate of the ellipse center.

References k_.

EllipseParametersOP numeric::linear_algebra::EllipseParameters::clone ( ) const

References EllipseParameters().

Real numeric::linear_algebra::EllipseParameters::major_radius ( ) const

Get the major radius length of the ellipse.

References a_.

Real numeric::linear_algebra::EllipseParameters::minor_radius ( ) const

Get the minor radius length of the ellipse.

References b_.

MathMatrix< Real > numeric::linear_algebra::EllipseParameters::rotation ( ) const

2D matrix defining the ellipse rotation

References rotation_.

Member Data Documentation

Real numeric::linear_algebra::EllipseParameters::a_
private

Referenced by add_buffer(), and major_radius().

Real numeric::linear_algebra::EllipseParameters::b_
private

Referenced by add_buffer(), and minor_radius().

Real numeric::linear_algebra::EllipseParameters::h_
private

Referenced by center_h().

Real numeric::linear_algebra::EllipseParameters::k_
private

Referenced by center_k().

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

Referenced by EllipseParameters(), and rotation().


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