UnaryTransform Class Reference

#include <UnaryTransform.h>

Inheritance diagram for UnaryTransform:

[legend]Collaboration diagram for UnaryTransform:

[legend]List of all members.

---

Detailed Description

A transform that transforms coordinates in one dimension from one coordinate system to another.

Author:

Paul_Kunz@slac.stanford.edu

Definition at line 33 of file UnaryTransform.h.

Public Member Functions
virtual const Range &	adjustValues (AxisModelBase &model, const Range &limit)=0
	Sets the range of given axis to be a new "nice" within the limits given.
virtual double	aspectRatio () const
	Get the aspect ratio.
virtual UnaryTransform *	clone () const =0
	Function to make copy of object.
virtual void	inverseTransform (double &x) const =0
	Inverse transforms the coordinate x.
virtual bool	isLinear () const =0
virtual const Range &	limits () const
	Returns a Range whose values are the limits on the coordinate.
const std::string &	name () const
	Returns the name of the Transform.
virtual const std::vector< AxisTick > &	setTicks (AxisModelBase &axis)=0
	Sets the vector of ticks along the axis to which this unary transform is applied.
virtual void	transform (std::vector< double > &x) const =0
	Transforms each element of the vector x.
virtual void	transform (double &x) const =0
	Transforms the coordinate x.
virtual void	validate (Range &) const =0
	Validates the Range.
virtual	~UnaryTransform ()
	The virtual destructor.
Protected Member Functions
	UnaryTransform (double low, double high)
	Constructor for setting m_limits.
Protected Attributes
const Range	m_limits
	The valid Range of the transform.
std::string	m_name
	Name of the Transform.

---

Constructor & Destructor Documentation

UnaryTransform::UnaryTransform (  double  low, double  high )  [protected]

Constructor for setting m_limits. Definition at line 15 of file UnaryTransform.cxx.

UnaryTransform::~UnaryTransform (   )  [virtual]

The virtual destructor. Definition at line 20 of file UnaryTransform.cxx.

---

Member Function Documentation

virtual const Range& UnaryTransform::adjustValues (  AxisModelBase &  model, const Range &  limit )  [pure virtual]

Sets the range of given axis to be a new "nice" within the limits given. Implemented in LinearTransform, and LogTransform.

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().

virtual UnaryTransform* UnaryTransform::clone (   )  const [pure virtual]

Function to make copy of object. Implements TransformBase. Implemented in LinearTransform, and LogTransform. Referenced by BinaryTransform::BinaryTransform(), TransformFactory::createXY(), TransformFactory::createXYZ(), XYTransform::XYTransform(), and XYZTransform::XYZTransform().

virtual void UnaryTransform::inverseTransform (  double &  x  )  const [pure virtual]

Inverse transforms the coordinate x. Implemented in LinearTransform, and LogTransform. Referenced by XYTransform::inverseTransform(), and BinaryTransform::inverseTransformZ().

virtual bool UnaryTransform::isLinear (   )  const [pure virtual]

Implemented in LinearTransform, and LogTransform.

const Range & UnaryTransform::limits (   )  const [virtual]

Returns a Range whose values are the limits on the coordinate. Definition at line 25 of file UnaryTransform.cxx. References m_limits. Referenced by XYZTransform::limitX(), XYTransform::limitX(), XYZTransform::limitY(), XYTransform::limitY(), XYZTransform::limitZ(), and BinaryTransform::limitZ().

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().

virtual const std::vector< AxisTick >& UnaryTransform::setTicks (  AxisModelBase &  axis  )  [pure virtual]

Sets the vector of ticks along the axis to which this unary transform is applied. Implemented in LinearTransform, and LogTransform. Referenced by XYTransform::setTicks().

virtual void UnaryTransform::transform (  std::vector< double > &  x  )  const [pure virtual]

Transforms each element of the vector x. Implemented in LinearTransform, and LogTransform.

virtual void UnaryTransform::transform (  double &  x  )  const [pure virtual]

Transforms the coordinate x. Implemented in LinearTransform, and LogTransform. Referenced by XYZTransform::transform(), XYTransform::transform(), and BinaryTransform::transformZ().

virtual void UnaryTransform::validate (  Range &   )  const [pure virtual]

Validates the Range. Adjusts the Range to be restricted to that which is valid for the transform. Implemented in LinearTransform, and LogTransform. Referenced by XYZTransform::validate(), and XYTransform::validate().

---

Member Data Documentation

const Range UnaryTransform::m_limits [protected]

The valid Range of the transform. Definition at line 39 of file UnaryTransform.h. Referenced by limits().

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::XYZTransform(), and XYZTransformBase::XYZTransformBase().

---

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

• UnaryTransform.h
• UnaryTransform.cxx

---