UnaryTransform Class Reference

#include <UnaryTransform.h>

Inheritance diagram for UnaryTransform:

Inheritance graph
LinearTransformLogTransformTransformBase
[legend]
Collaboration diagram for UnaryTransform:

Collaboration graph
TransformBaseRange
[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 35 of file UnaryTransform.h.

Public Member Functions

virtual const RangeadjustValues (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 UnaryTransformclone () 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 Rangelimits () 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 ( double  low,
double  high 
) [protected]

Constructor for setting m_limits.

Definition at line 18 of file UnaryTransform.cxx.

~UnaryTransform (  )  [virtual]

The virtual destructor.

Definition at line 23 of file UnaryTransform.cxx.


Member Function Documentation

virtual const Range& 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 aspectRatio (  )  const [virtual, inherited]

Get the aspect ratio.

Reimplemented in AIR, AIR2, ARC, ARC2, BinaryTransform, Cartesian, Cartesian2, GlobalSinusoidal, GlobalSinusoidal2, HammerAito, HammerAito2, Lambert, Lambert2, Mercator, Mercator2, SIN, SIN2, STG, STG2, TAN, TAN2, and XYTransform.

Definition at line 50 of file TransformBase.cxx.

Referenced by CompositePlotter::getAspectRatio().

virtual 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 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 isLinear (  )  const [pure virtual]

Implemented in LinearTransform, and LogTransform.

Referenced by XYZTransform::isLinearInZ(), and BinaryTransform::isLinearInZ().

const Range & limits (  )  const [virtual]

Returns a Range whose values are the limits on the coordinate.

Definition at line 28 of file UnaryTransform.cxx.

References UnaryTransform::m_limits.

Referenced by XYZTransform::limitX(), XYTransform::limitX(), XYZTransform::limitY(), XYTransform::limitY(), XYZTransform::limitZ(), and BinaryTransform::limitZ().

const string & name (  )  const [inherited]

Returns the name of the Transform.

Definition at line 45 of file TransformBase.cxx.

References TransformBase::m_name.

Referenced by BinaryTransform::BinaryTransform(), TransformXML::createElement(), DisplayController::getLog(), DisplayController::setLog(), Inspector::updateTransformTab(), and XYTransform::XYTransform().

virtual const std::vector< AxisTick >& 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 transform ( std::vector< double > &  x  )  const [pure virtual]

Transforms each element of the vector x.

Implemented in LinearTransform, and LogTransform.

virtual void 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 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 m_limits [protected]

The valid Range of the transform.

Definition at line 41 of file UnaryTransform.h.

Referenced by UnaryTransform::limits().

std::string m_name [protected, inherited]

Name of the Transform.

Definition at line 42 of file TransformBase.h.

Referenced by AIR::AIR(), AIR2::AIR2(), ARC::ARC(), ARC2::ARC2(), BinaryTransform::BinaryTransform(), Cartesian::Cartesian(), Cartesian2::Cartesian2(), GlobalSinusoidal::GlobalSinusoidal(), GlobalSinusoidal2::GlobalSinusoidal2(), HammerAito::HammerAito(), HammerAito2::HammerAito2(), Lambert::Lambert(), Lambert2::Lambert2(), LinearTransform::LinearTransform(), LogTransform::LogTransform(), Mercator::Mercator(), Mercator2::Mercator2(), TransformBase::name(), SIN::SIN(), SIN2::SIN2(), STG::STG(), STG2::STG2(), TAN::TAN(), TAN2::TAN2(), TransformBase::TransformBase(), XYTransform::XYTransform(), XYZTransform::XYZTransform(), and XYZTransformBase::XYZTransformBase().


The documentation for this class was generated from the following files:
Generated for HippoDraw Class Library by doxygen