XYZTransform Class Reference

#include <XYZTransform.h>

Inheritance diagram for XYZTransform:

[legend]Collaboration diagram for XYZTransform:

[legend]List of all members.

---

Detailed Description

A transform that transforms the X, Y and Z coordinates independently.

Author:

Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Oded Wurman <owurman@stanford.edu>

Definition at line 26 of file XYZTransform.h.

Public Member Functions
virtual double	aspectRatio () const
	Get the aspect ratio.
virtual XYZTransform *	clone () const
	Creates a new Transform object by copying an existing one.
virtual const Range &	limitX () const
	Returns a Range whose values are the limits on the X coordinate.
virtual const Range &	limitY () const
	Returns a Range whose values are the limits on the Y coordinate.
virtual const Range &	limitZ () const
	Returns a Range whose values are the limits on the Z coordinate.
const std::string &	name () const
	Returns the name of the Transform.
virtual void	transform (std::vector< double > &x, std::vector< double > &y, std::vector< double > &z) const
virtual void	transform (double &x, double &y, double &z) const
virtual void	validate (Range &x, Range &y, Range &z) const
TransformBase *	xTransform () const
	Returns the transform function on the X axis.
	XYZTransform (const XYZTransform &)
	The copy constructor.
	XYZTransform (UnaryTransform *x, UnaryTransform *y, UnaryTransform *z)
	The following constructor takes three base constructors as arguments.
TransformBase *	yTransform () const
	Returns the transform function on the Y axis.
TransformBase *	zTransform () const
	Returns the transform function on the Z axis.
virtual	~XYZTransform ()
	The virtual destructor.
Protected Attributes
std::string	m_name
	Name of the Transform.
Private Attributes
UnaryTransform *	m_x
	The transform on the X axis.
UnaryTransform *	m_y
	The transform on the Y axis.
UnaryTransform *	m_z
	The transform on the Z axis.

---

Constructor & Destructor Documentation

XYZTransform::XYZTransform (  UnaryTransform *  x, UnaryTransform *  y, UnaryTransform *  z )

The following constructor takes three base constructors as arguments. Definition at line 18 of file XYZTransform.cxx. References TransformBase::m_name, m_x, m_y, and m_z.

XYZTransform::XYZTransform (  const XYZTransform &   )

The copy constructor. Definition at line 35 of file XYZTransform.cxx. References UnaryTransform::clone(), m_x, m_y, and m_z.

XYZTransform::~XYZTransform (   )  [virtual]

The virtual destructor. Definition at line 28 of file XYZTransform.cxx. References m_x, m_y, and m_z.

---

Member Function Documentation

double TransformBase::aspectRatio (   )  const [virtual, inherited]

Get the aspect ratio. Reimplemented in BinaryTransform, HammerAito, Lambert, and XYTransform. Definition at line 48 of file TransformBase.cxx. Referenced by CompositePlotter::getAspectRatio().

XYZTransform * XYZTransform::clone (   )  const [virtual]

Creates a new Transform object by copying an existing one. Implements XYZTransformBase. Definition at line 52 of file XYZTransform.cxx.

const Range & XYZTransform::limitX (   )  const [virtual]

Returns a Range whose values are the limits on the X coordinate. Definition at line 89 of file XYZTransform.cxx. References UnaryTransform::limits(), and m_x.

const Range & XYZTransform::limitY (   )  const [virtual]

Returns a Range whose values are the limits on the Y coordinate. Definition at line 95 of file XYZTransform.cxx. References UnaryTransform::limits(), and m_y.

const Range & XYZTransform::limitZ (   )  const [virtual]

Returns a Range whose values are the limits on the Z coordinate. Definition at line 101 of file XYZTransform.cxx. References UnaryTransform::limits(), and m_z.

const string & TransformBase::name (   )  const [inherited]

Returns the name of the Transform. Definition at line 43 of file TransformBase.cxx. References TransformBase::m_name. Referenced by BinaryTransform::BinaryTransform(), TransformXML::createElement(), DisplayController::getLog(), DisplayController::setLog(), and XYTransform::XYTransform().

void XYZTransform::transform (  std::vector< double > &  x, std::vector< double > &  y, std::vector< double > &  z )  const [virtual]

Definition at line 71 of file XYZTransform.cxx. References m_x, m_y, m_z, and UnaryTransform::transform().

void XYZTransform::transform (  double &  x, double &  y, double &  z )  const [virtual]

Definition at line 59 of file XYZTransform.cxx. References m_x, m_y, m_z, and UnaryTransform::transform().

void XYZTransform::validate (  Range &  x, Range &  y, Range &  z )  const [virtual]

Definition at line 81 of file XYZTransform.cxx. References m_x, m_y, m_z, and UnaryTransform::validate().

TransformBase * XYZTransform::xTransform (   )  const

Returns the transform function on the X axis. Definition at line 106 of file XYZTransform.cxx. References m_x.

TransformBase * XYZTransform::yTransform (   )  const

Returns the transform function on the Y axis. Definition at line 111 of file XYZTransform.cxx. References m_y.

TransformBase * XYZTransform::zTransform (   )  const

Returns the transform function on the Z axis. Definition at line 116 of file XYZTransform.cxx. References m_z.

---

Member Data Documentation

std::string TransformBase::m_name [protected, inherited]

Name of the Transform. Definition at line 39 of file TransformBase.h. Referenced by BinaryTransform::BinaryTransform(), HammerAito::HammerAito(), Lambert::Lambert(), LinearTransform::LinearTransform(), LogTransform::LogTransform(), TransformBase::name(), TransformBase::TransformBase(), XYTransform::XYTransform(), XYZTransform(), and XYZTransformBase::XYZTransformBase().

UnaryTransform* XYZTransform::m_x [private]

The transform on the X axis. Definition at line 30 of file XYZTransform.h. Referenced by limitX(), transform(), validate(), xTransform(), XYZTransform(), and ~XYZTransform().

UnaryTransform* XYZTransform::m_y [private]

The transform on the Y axis. Definition at line 33 of file XYZTransform.h. Referenced by limitY(), transform(), validate(), XYZTransform(), yTransform(), and ~XYZTransform().

UnaryTransform* XYZTransform::m_z [private]

The transform on the Z axis. Definition at line 36 of file XYZTransform.h. Referenced by limitZ(), transform(), validate(), XYZTransform(), zTransform(), and ~XYZTransform().

---

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

• XYZTransform.h
• XYZTransform.cxx

---