Utils::CylindricalTransformationParameters Class Reference

A class to hold and validate parameters for a cylindrical coordinate transformations. More...

#include <cylindrical_transformation_parameters.hpp>

Public Member Functions
	CylindricalTransformationParameters ()=default
	CylindricalTransformationParameters (Utils::Vector3d const &center, Utils::Vector3d const &axis, Utils::Vector3d const &orientation)
	Main constructor.
	CylindricalTransformationParameters (Utils::Vector3d const &center, Utils::Vector3d const &axis)
	if you only provide center and axis, an orientation will be generated automatically such that it is orthogonal to axis
Utils::Vector3d	center () const
Utils::Vector3d	axis () const
Utils::Vector3d	orientation () const

Detailed Description

A class to hold and validate parameters for a cylindrical coordinate transformations.

Definition at line 34 of file cylindrical_transformation_parameters.hpp.

Constructor & Destructor Documentation

CylindricalTransformationParameters() [1/3]

Utils::CylindricalTransformationParameters::CylindricalTransformationParameters ( )

default

CylindricalTransformationParameters() [2/3]

Utils::CylindricalTransformationParameters::CylindricalTransformationParameters ( Utils::Vector3d const &  center, Utils::Vector3d const &  axis, Utils::Vector3d const &  orientation  )

inline

Main constructor.

Parameters

center	The origin of the cylindrical coordinates.
axis	The "z"-axis. Must be normalized.
orientation	The axis along which phi = 0. Must be normalized and orthogonal to axis.

Definition at line 45 of file cylindrical_transformation_parameters.hpp.

CylindricalTransformationParameters() [3/3]

Utils::CylindricalTransformationParameters::CylindricalTransformationParameters ( Utils::Vector3d const &  center, Utils::Vector3d const &  axis  )

inline

if you only provide center and axis, an orientation will be generated automatically such that it is orthogonal to axis

Definition at line 55 of file cylindrical_transformation_parameters.hpp.

Member Function Documentation

axis()

Utils::Vector3d Utils::CylindricalTransformationParameters::axis ( ) const

inline

Definition at line 61 of file cylindrical_transformation_parameters.hpp.

center()

Utils::Vector3d Utils::CylindricalTransformationParameters::center ( ) const

inline

Definition at line 60 of file cylindrical_transformation_parameters.hpp.

orientation()

Utils::Vector3d Utils::CylindricalTransformationParameters::orientation ( ) const

inline

Definition at line 62 of file cylindrical_transformation_parameters.hpp.

---

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

• cylindrical_transformation_parameters.hpp