Cut1DPlotter Class Reference

#include <Cut1DPlotter.h>

Inheritance diagram for Cut1DPlotter:

[legend]Collaboration diagram for Cut1DPlotter:

[legend]List of all members.

Detailed Description

A Plotter class that plots one-dimensional TupleCut values.

It servers two purposes: to display the accepted range of the cut and to maintain the cut itself. This class adds the cut acceptance range to the background of the inherited XyPlotter drawing. It maintains a list of DataRep objects which are the target of the cut. If the cut parameters change, it sets the target DataRep objects dirty so that they will re-display themselves. It contains a single TupleCut object and is the public interface for setting its properties.

Author:: Paul_Kunz@slac.stanford.edu

Definition at line 31 of file Cut1DPlotter.h.

Public Types

typedef void(hippodraw::Observer::* Action )(const Observable *)

The member function of the Observer that is called.

typedef std::list< hippodraw::Observer * > ObserverList_t

The type of STL container to maintain list of Observer objects.

Public Member Functions

virtual int activePlotIndex () const

Returns the index of the active DataRep object.

virtual ProjectorBase * activeProjector () const

Returns the active projector.

void addCutTarget (DataRep *)

Adds a DataRep to the list of targeted.

virtual void addDataRep (DataRep *rep)

Adds a data representation.

virtual void addDataRepStacked (DataRep *rep)

Adds the DataRep object to the plotter.

void addObserver (hippodraw::Observer *)

Adds an Observer to the Observer list.

virtual void addValues (const std::vector< double > &v)

Adds data values to the plot.

virtual void autoScale ()

Sets the Range on each axis that has the auto range flag set to include all the data.

virtual void checkAxisScaling ()

Check if Axis needs to be scaled or not.

void clearCutTargets ()

Removes all cut targets.

PlotterBase * clone ()

This clone function returns an object of its own kind which is a copy of this object at this moment.

virtual NTuple * createNTuple () const

Creates an NTuple representation of the plotted data.

virtual NTuple * createPickTuple ()

Creates a NTuple for a PickTable.

int currentView () const

Return the current view index.

Cut1DPlotter (const Cut1DPlotter &plotter)

The copy constructor.

Cut1DPlotter ()

This default constructor.

void deleteView (int index)

Delete a view by index.

virtual void drawCrossHairs (ViewBase *view)

Draws cross-hairs.

virtual void drawIn (ViewBase *view)

Starts the drawing in view view.

virtual void drawProjValues (ViewBase *view)

Draws the projected values.

virtual bool errorDisplay (hippodraw::Axes::Type axis) const

Returns the state of error bar display on specified axis.

void fillCutList (std::vector< const TupleCut * > &cuts) const

Fills the cuts vector with the TupleCuts contained by the DataRep objects.

virtual void fillPickedPoint (double mx, double my, std::vector< double > &picked) const

Fills the picked data point.

virtual double getAspectRatio () const

Returns the aspect ratio.

virtual AxisModelBase * getAxisModel (hippodraw::Axes::Type axis) const

Returns the AxisModelBase derived class for the specified axis.

double getBinWidth (const std::string &axis) const

Returns the bin width.

virtual double getBinWidth (hippodraw::Axes::Type) const

Returns the bins with of the target DataRep object.

virtual bool getCurrentRangeSaved ()

Returns current_range_saved member t.

const Color & getCutColor () const

Get the color of the accepted region.

virtual const std::string & getCutLabel () const

Returns the label for the Cut.

const std::vector< TupleCut > & getCuts () const

Returns the list of TupleCut objects used by this plotter.

const std::list< DataRep * > & getCutTargets () const

Get the list of targets.

virtual DataRep * getDataRep (int index) const

Returns the DataRep object at index.

virtual double getHighRangeOnX () const

Returns the high end of the X axis range.

virtual const std::string & getInternalLabel (hippodraw::Axes::Type axis) const

Returns the internal label.

virtual const std::string & getInternalTitle () const

Returns the internal title.

virtual const std::string & getLabel (hippodraw::Axes::Type) const

Returns the label for the specified axis.

virtual double getLowRangeOnX () const

Returns the low end of the X axis range.

HippoRectangle getMarginRect () const

Returns the margin space where drawing takes place.

virtual int getNumberOfEntries () const

Returns the number of entries in the contained DataRep.

virtual int getNumDataReps () const

Returns the number of DataRep objects contained by the plotter.

int getNumOfEntries () const

Returns the number of entries in the contained DataRep.

const ObserverList_t & getObservers () const

Returns the list of observers.

double getOffset (const std::string &axis) const

Returns the offset on designated axis, similarly to getBinWidth.

virtual double getOffset (hippodraw::Axes::Type axis) const

Returns the offset on designated axis, similarly to getBinWidth.

virtual int getParentDataRepIndex () const

Returns the index of the parent DataRep.

virtual PlotterBase * getParentPlotter () const

Returns the parent plotter.

virtual double getPosRange (hippodraw::Axes::Type axis) const

Returns the smallest positive number from the data.

virtual ProjectorBase * getProjector (int i) const

Returns the i-th projector.

virtual const Range & getRange (hippodraw::Axes::Type axis, bool scaled) const

Returns the range on the specified axis.

virtual DataRep * getTarget () const

Returns the selected DataRep.

const std::string & getTitle () const

Gets the title to be displayed.

virtual TransformBase * getTransform () const

Returns the transform object used by the plotter.

const HippoRectangle & getUserRect () const

Returns the data space rectangle.

virtual const BinToColor * getValueRep () const

Returns the value to color representation.

virtual double getZValue (double x, double y, bool scaled=true) const

Get the z value at the specified point (x,y).

bool hasAutoScaled () const

Returns true if the axes have already been auto-scaled.

virtual bool hasAxis (hippodraw::Axes::Type axis) const

Returns true if the plotter has an axis of specified type.

virtual bool hasNTupleBindings () const

Returns true as a CutPlotter always has ntuple bindings.

virtual bool hasZoomY () const

Returns true if the plotter has zoom feature on the Y axis otherwise it returns false.

virtual int indexOf (const DataRep *) const

Returns the index of the selected DataRep object.

virtual bool isAutoRanging (hippodraw::Axes::Type axis) const

Returns true if auto-ranging is enabled, otherwise returns false.

bool isTarget (DataRep *) const

Returns true if specified DataRep is a target of this cut.

bool isTargetable () const

Returns true if receiving object is target-able.

FontBase * labelFont (hippodraw::Axes::Type axes) const

What font is being used to override the default while drawing axis label.

virtual double marginToInvertedUserY (double y) const

Converts from inverted view coordinate to data coordinate, without taking into account transforms or scaling.

virtual double marginToUserX (double x) const

Converts from view coordinate to data coordinate, without taking into account transforms or scaling.

virtual void marginToUserXY (double mx, double my, bool scaled, double &ux, double &uy) const

Converts from the drawing space to the data space.

virtual double marginToUserY (double y) const

Converts from view coordinate to data coordinate, without taking into account transforms or scaling.

virtual void matrixTranspose (bool yes)

Transpose the X and Y axis of matrix representation.

const std::string & name () const

Returns the name of the plotter.

int nextView (bool stepForward=true)

Cycle through each set of plot ranges, thereby changing the view with each call.

virtual void notifyObservers () const

Notifies Observer objects of a change.

int numViews () const

Return the number of stored views.

virtual int plotterId () const

The unique ID number of this plotter.

void prepareMarginRect (ViewBase *view)

Prepares the margin rectangle.

virtual void removeDataRep (DataRep *rep)

Removes the DataRep object from the plotter.

void removeFromTarget (DataRep *rep)

Remove this cut from one of its target rep.

void removeObserver (hippodraw::Observer *)

Removes an Observer from the Observer list.

virtual const Color & repColor () const

Returns the color used for the representation.

virtual RepBase * representation () const

Returns the representation used by the plotter.

virtual void reset ()

Resets the bins.

int saveView (const std::vector< double > &range_values)

Save the current set of plot ranges which define a "view" for this plot.

int saveViewAtIndex (const std::vector< double > &range_values, unsigned int i)

Save the current set of plot ranges which define a "view" for this plot.at the position i.

virtual DataRep * selectedDataRep () const

Returns the selected DataRep.

void setActive (bool yes)

Sets the cut as active.

virtual void setActivePlot (int index, bool redraw)

Sets the active plot.

void setAspectRatio (double ratio)

Sets the aspect ratio.

virtual void setAutoRanging (const std::string &axis, bool flag)

Sets the auto-ranging.

virtual void setAutoRanging (hippodraw::Axes::Type axis, bool flag)

Sets the auto-ranging.

virtual void setAutoRanging (bool flag)

Sets the auto-ranging status for all axes to flag.

virtual void setAutoTicks (const std::string &, bool on)

Sets automatic ticks on or off.

virtual void setAutoTicks (hippodraw::Axes::Type axis, bool yes)

Sets automatic generation of axis ticks.

virtual void setAutoTicksOnX (bool yes)

Sets automatic generation of axis ticks on X axis.

virtual void setAxisBinding (const std::string &axis, const std::string &label)

Sets the axis binding of both the Cut and its DataRep.

virtual void setAxisModel (AxisModelBase *, hippodraw::Axes::Type)

Sets the AxisModel on the specified axis.

virtual void setBinWidth (const std::string &axis, double width)

Sets the bin width.

virtual void setBinWidth (hippodraw::Axes::Type axis, double width)

Sets the bin width.

void setCrossX (double val)

Set the crossX value.

void setCrossY (double val)

Set the crossY value.

virtual void setCurrentRangeSaved (bool flag)

Sets current_range_saved member to flag.

void setCutColor (const Color &)

Sets the color of the cut acceptance region.

virtual void setCutEnabled (unsigned int i, bool yes=true)

Sets the TupleCut object index by i to be enabled.

virtual void setCutInverted (unsigned int i, bool yes=true)

Sets the TupleCut object indexed by i to be inverted.

virtual void setCutRange (double low, double high)

Sets the Range on the X axis.

virtual void setCutRangeAt (const Range &range, unsigned int index)

Sets the Range of the cut.

void setCutRangeFull ()

Sets the cut Range to include the full range of data.

void setCutRepresentation (RepBase *rep)

Sets the cut representation.

void setCuts (const std::vector< const TupleCut * > &cuts)

Sets the TupleCut objects to be used by this plotter.

void setEnabled (bool yes=true)

Sets the state of the cut's enabled status.

virtual void setEnableZ (bool yes=true)

Sets the display of the Z axis on.

virtual void setErrorDisplay (hippodraw::Axes::Type axis, bool)

Sets the display of the error bars on or off.

virtual void setHighRange (hippodraw::Axes::Type axis, int parm, bool dragging)

Sets the high end of the Range of data displayed.

virtual void setLabel (const std::string &axis, const std::string &label)

Sets the label of specified axis to label.

virtual void setLabel (hippodraw::Axes::Type, const std::string &value)

Sets the label of the specified axis to value.

void setLabelFont (FontBase *font, hippodraw::Axes::Type axes)

Set the font to be used to override the default while drawing axis label.

virtual void setLowRange (hippodraw::Axes::Type axis, int parm, bool dragging)

Sets the low end of the Range of data displayed.

void setNTuple (const DataSource *ntuple)

Sets the ntuple for the Cut and its DataRep object.

virtual void setNumberOfBins (const std::string &axis, unsigned int number)

Sets the number of bins.

virtual void setNumberOfBins (hippodraw::Axes::Type axis, unsigned int number)

Sets the number of bins.

virtual void setOffset (const std::string &axis, double offset)

Sets the bin offset.

virtual void setOffset (hippodraw::Axes::Type axis, double offset)

Sets the offset.

virtual void setOffsets (double xoffset, double yoffset)

Sets the offsets on the x and y axis.

virtual void setParentDataRepIndex (int index)

Sets the index of the parent DataRep.

virtual void setParentPlotter (PlotterBase *plotter)

Sets the parent plotter.

void setRange (const std::string &axis, double low, double high)

Sets the range on the specified axis.

virtual void setRange (hippodraw::Axes::Type axis, const Range &range, bool scaled=false, bool adjust_width=true)

Sets the range on the specified axis.

virtual void setRepColor (const Color &)

Sets the representation's color.

virtual void setRepresentation (RepBase *pointrep)

Sets the representation.

virtual void setScaling (hippodraw::Axes::Type axis, bool on=true)

Sets the scaling attribute of the AxisModelBase object.

virtual void setTicks (const std::string &axis, const std::vector< double > &values, const std::vector< std::string > &labels)

Sets the ticks on specified axis.

virtual void setTicks (hippodraw::Axes::Type axis, const std::vector< AxisTick > &ticks)

Sets the ticks for the specified axis.

virtual void setTicksOnX (const std::vector< double > &values, const std::vector< std::string > &labels)

Sets the ticks for the X axis.

void setTitle (const std::string &title)

Sets the title to be displayed.

void setTitleFont (FontBase *font)

Set the font to be used to override the default while drawing title.

virtual void setTransform (TransformBase *)

Sets the transform object and redraws.

virtual void setValueRep (BinToColor *rep)

Sets the object that will do the value to color transform, if any.

void setView (int index)

Set the view by index.

const FontBase * titleFont () const

What font is being used to override the default while drawing title of plot.

void toggleActivePlot ()

Toggles the active DataRep, if 2 or more are contained by the plotter.

virtual void toggleInverted ()

Reverse the meaning of the cut Range.

virtual void update ()

Updates the plotter.

virtual void update (const Observable *object)

Responds to the update message from one of its Observable objects.

virtual float userToInvertedMarginY (double y) const

Converts the user Y coordinate into the top-left based margin Y coordinate.

virtual float userToMarginColor (double c) const

Converts the user Z coordinate into the margin color (X) coordinate.

virtual float userToMarginX (double x) const

Converts the user X coordinate into the margin X coordinate.

virtual float userToMarginY (double y) const

Converts the user Y coordinate into the margin Y coordinate.

virtual bool wantsPixmap () const

Returns true.

virtual void willDelete (const Observable *observable)

Responds to willDelete message emitted from one of the Observers.

virtual ~Cut1DPlotter ()

The destructor.

Protected Types

typedef std::list< DataRep * > TargetList_t

The STL container type used for targets of the cut.

Protected Member Functions

void calcAxisRatios (const CompositePlotter *)

Calculates the ratio of view and data scales.

TupleCut * getCutAt (unsigned int i)

Returns the TupleCut object at position i.

void notifyObservers (Action action) const

An internal method to iterate over all observers and to send the message action.

void removeFromTargets ()

Removes this cut from all of its targets.

void updateTargets ()

Update the target DataRep when a change has been made in the TupleCut.

Protected Attributes

bool current_range_saved

Returns true if the current range on the axes have been saved.

double m_aspect_ratio

The aspect ratio.

AxisRepBase * m_axis_rep

The axes model graphical representation.

double m_crossX

The x position of the cross hair.

double m_crossY

The y position of the cross hair.

int m_currentView

Index of the current view.

DataRep * m_datarep

A pointer to the data representation that holds the cuts.

HippoRectangle m_margin_rect

The rectangle area in which the projected points are plotted.

std::string m_name

The name of the type of plotter.

int m_parent_datarep_index

Parent DataRep index.

PlotterBase * m_parent_plotter

Parent plotter.

CompositePlotter * m_plotter

The currently active plotter that draws the data points.

int m_plotterId

A unique plotter id.

TargetList_t m_targets

A list of DataRep objects which have this cut applied.

std::string m_title

The main label; the title of the plot.

HippoRectangle m_user_rect

The abstract data space.

std::vector< std::vector<
double > > m_views

A vector of x and y ranges to be used as a circular buffer allowing one to cycle through the saved plot "views".

double m_z_ratio

The conversion ratio from the user coordinate system to the view's coordinate system along the color axis.

Static Protected Attributes

static int s_plotters

Reference count for creating plotter ids.

Member Typedef Documentation

typedef void( hippodraw::Observer::* Observable::Action)(const Observable *) [inherited]

The member function of the Observer that is called.

Definition at line 83 of file Observable.h.

typedef std::list< hippodraw::Observer * > Observable::ObserverList_t [inherited]

The type of STL container to maintain list of Observer objects.

Definition at line 46 of file Observable.h.

typedef std::list< DataRep * > CutPlotter::TargetList_t [protected, inherited]

The STL container type used for targets of the cut.

Definition at line 58 of file CutPlotter.h.

Constructor & Destructor Documentation

Cut1DPlotter::Cut1DPlotter ( )

This default constructor.

Definition at line 33 of file Cut1DPlotter.cxx.
Referenced by clone().

Cut1DPlotter::Cut1DPlotter ( const Cut1DPlotter & plotter )

The copy constructor.

Definition at line 38 of file Cut1DPlotter.cxx.

Cut1DPlotter::~Cut1DPlotter ( ) [virtual]

The destructor.

Definition at line 43 of file Cut1DPlotter.cxx.

Member Function Documentation

int XyPlotter::activePlotIndex ( ) const [virtual, inherited]

Returns the index of the active DataRep object.

Reimplemented from PlotterBase.
Definition at line 303 of file XyPlotter.cxx.
References XyPlotter::m_active_index.

ProjectorBase * XyPlotter::activeProjector ( ) const [virtual, inherited]

Returns the active projector.

Reimplemented from PlotterBase.
Definition at line 649 of file XyPlotter.cxx.
References XyPlotter::m_plotter.
Referenced by XyPlotter::createNTuple().

void CutPlotter::addCutTarget ( DataRep * ) [inherited]

Adds a DataRep to the list of targeted.

Definition at line 215 of file CutPlotter.cxx.
References Observable::addObserver(), and CutPlotter::m_targets.
Referenced by CutController::connectDataRep(), PlotterBaseXML::getCutTargets(), and CutController::linkCutAndRep().

void Cut1DPlotter::addDataRep ( DataRep * rep ) [virtual]

Adds a data representation.
Adds the data representation that will display the cut.
Reimplemented from XyPlotter.
Definition at line 54 of file Cut1DPlotter.cxx.
References XyPlotter::addDataRep(), CutPlotter::getCuts(), and CutPlotter::m_datarep.
Referenced by CutController::createCut().

void XyPlotter::addDataRepStacked ( DataRep * rep ) [virtual, inherited]

Adds the DataRep object to the plotter.
Adds the DataRep object to the plotter by sharing the current X axis, but with its own Y axis.
Definition at line 324 of file XyPlotter.cxx.
References XyPlotter::addDataRep(), XyPlotter::getAxisModel(), XyPlotter::m_active_index, XyPlotter::m_plotter, XyPlotter::m_plotters, Observable::notifyObservers(), XyPlotter::setAxisModel(), and hippodraw::Axes::X.

void Observable::addObserver ( hippodraw::Observer * ) [inherited]

Adds an Observer to the Observer list.

Definition at line 49 of file Observable.cxx.
References Observable::m_list.
Referenced by CutPlotter::addCutTarget(), XyPlotter::addDataRep(), FunctionRep::FunctionRep(), BinningProjector::normalizeTo(), DataRepController::setAxisBindings(), DisplayController::setNTuple(), CutPlotter::setNTuple(), and TextPlotter::setParentDataRep().

void XyPlotter::addValues ( const std::vector< double > & v ) [virtual, inherited]

Adds data values to the plot.
This method is provided as a convenience when the plotter contains a single DataRep that responds to addValues. For example a static histogram would respond to it.
Reimplemented from PlotterBase.
Definition at line 817 of file XyPlotter.cxx.
References XyPlotter::m_plotter.

void XyPlotter::autoScale ( ) [virtual, inherited]

Sets the Range on each axis that has the auto range flag set to include all the data.
This function scrolls through all the points plotters, asking for their preferred ranges. It then sets the range to be the union of all of those.
Reimplemented from PlotterBase.
Definition at line 349 of file XyPlotter.cxx.
References XyPlotter::m_plotter, and Observable::notifyObservers().
Referenced by XyPlotter::checkAutoScale(), and CutPlotter::setAxisBinding().

void XyPlotter::calcAxisRatios ( const CompositePlotter * ) [protected, inherited]

Calculates the ratio of view and data scales.
Calculates and set the appropriate data members the ratio of the view and data scales.
Definition at line 580 of file XyPlotter.cxx.
References HippoRectangle::getDepth(), HippoRectangle::getHeight(), HippoRectangle::getWidth(), XyPlotter::hasAxis(), PlotterBase::m_margin_rect, XyPlotter::m_plotter, PlotterBase::m_user_rect, XyPlotter::m_x_ratio, XyPlotter::m_y_ratio, XyPlotter::m_z_ratio, and hippodraw::Axes::Z.
Referenced by XyPlotter::drawIn(), and XyPlotter::drawProjValues().

void XyPlotter::checkAxisScaling ( ) [virtual, inherited]

Check if Axis needs to be scaled or not.

Reimplemented from PlotterBase.
Definition at line 633 of file XyPlotter.cxx.
References XyPlotter::m_plotter.

void CutPlotter::clearCutTargets ( ) [inherited]

Removes all cut targets.

Definition at line 210 of file CutPlotter.cxx.
References CutPlotter::m_targets.

PlotterBase * Cut1DPlotter::clone ( ) [virtual]

This clone function returns an object of its own kind which is a copy of this object at this moment.

Reimplemented from XyPlotter.
Definition at line 47 of file Cut1DPlotter.cxx.
References Cut1DPlotter().

NTuple * XyPlotter::createNTuple ( ) const [virtual, inherited]

Creates an NTuple representation of the plotted data.
Derived classes should create a representation appropriate for their plotting. The NTuple should contain the coordinates, the error on the coordinates, the values and the error on the values.
Implements PlotterBase.
Definition at line 191 of file XyPlotter.cxx.
References XyPlotter::activeProjector(), XyPlotter::getLabel(), XyPlotter::hasAxis(), XyPlotter::m_plotter, hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

NTuple * XyPlotter::createPickTuple ( ) [virtual, inherited]

Creates a NTuple for a PickTable.
Creates an NTuple appropriate for a PickTable for this plotter. For plotters derived from this class the first three column labels and subsequent labels are as follows

"Item number"

The X axis label.

The Y axis label.

For 2D plots with Y axis scaling, the 4th label is "Density"

For 3D plots the 4th label is the Z axis label.

For 3D plots with Z axis scaling, the 5th label is "Density"

See also:
fillPickTuple.

Reimplemented from PlotterBase.
Definition at line 444 of file XyPlotter.cxx.
References PlotterBase::getTitle(), XyPlotter::m_plotter, PlotterBase::name(), and PlotterBase::setTitle().

int PlotterBase::currentView ( ) const [inherited]

Return the current view index.

Definition at line 829 of file PlotterBase.cxx.
References PlotterBase::m_currentView.
Referenced by QtDisplay::currentView().

void PlotterBase::deleteView ( int index ) [inherited]

Delete a view by index.

Definition at line 812 of file PlotterBase.cxx.
References PlotterBase::m_views, and PlotterBase::setView().
Referenced by QtDisplay::deleteView().

void XyPlotter::drawCrossHairs ( ViewBase * view ) [virtual, inherited]

Draws cross-hairs.
Draws cross-hairs at the mouse hot spot. The drawing is done at the X and Y position set by setCrossX and setCrossY.
Reimplemented from PlotterBase.
Definition at line 177 of file XyPlotter.cxx.
References AxisRepBase::drawCrossHairs(), XyPlotter::getTransform(), XyPlotter::m_axis_rep, PlotterBase::m_crossX, and PlotterBase::m_crossY.

void XyPlotter::drawIn ( ViewBase * view ) [virtual, inherited]

Starts the drawing in view view.
This is the initial method that is called.
Implements PlotterBase.
Definition at line 155 of file XyPlotter.cxx.
References AxisRepBase::beginPlot(), XyPlotter::calcAxisRatios(), XyPlotter::checkAutoScale(), XyPlotter::drawProjValues(), AxisRepBase::drawTitle(), PlotterBase::getTitle(), XyPlotter::m_active_index, XyPlotter::m_axis_rep, XyPlotter::m_plotter, XyPlotter::m_plotters, PlotterBase::m_title, PlotterBase::m_user_rect, XyPlotter::prepareMarginRect(), and XyPlotter::prepareToDraw().

void XyPlotter::drawProjValues ( ViewBase * view ) [virtual, inherited]

Draws the projected values.
This implementation invokes drawProjValues on each of the DataRep objects in the composite. If multiple DataRep objects exist in the composite and one is selected (active), it is the one that is drawn last.
Definition at line 593 of file XyPlotter.cxx.
References XyPlotter::calcAxisRatios(), and XyPlotter::m_plotters.
Referenced by XyPlotter::drawIn().

bool XyPlotter::errorDisplay ( hippodraw::Axes::Type axis ) const [virtual, inherited]

Returns the state of error bar display on specified axis.

Implements PlotterBase.
Definition at line 559 of file XyPlotter.cxx.
References XyPlotter::m_plotter.

void XyPlotter::fillCutList ( std::vector< const TupleCut * > & cuts ) const [virtual, inherited]

Fills the cuts vector with the TupleCuts contained by the DataRep objects.

Reimplemented from PlotterBase.
Definition at line 931 of file XyPlotter.cxx.
References XyPlotter::m_plotters.
Referenced by XyPlotter::getCutAt().

void XyPlotter::fillPickedPoint ( double mx,

double my,

std::vector< double > & picked

) const [virtual, inherited]

Fills the picked data point.
Fills the vector picked with the picked data set. The vector will be cleared before insertion of coordinates. The resulting size of the vector depends on the type of DataRep in use and the contents is as follows.

2D plots without Y axis scaling: 0., X, Y

2D plots with Y axis scaling: 1., X, Y-scaled, Y

3D plots without Z axis scaling: 2., X, Y, Z

3D plots with Z axis scaling: 3., X, Y, Z-scaled, Z

The first item is used to identify the type of picked point.
See also:
createPickNTuple.

Reimplemented from PlotterBase.
Definition at line 459 of file XyPlotter.cxx.
References XyPlotter::m_plotter, XyPlotter::marginToInvertedUserY(), and XyPlotter::marginToUserX().

double XyPlotter::getAspectRatio ( ) const [virtual, inherited]

Returns the aspect ratio.
The aspect ratio is the ratio of the width to the height that should be used when drawing the plotter. If the aspect ratio has been set to a non-zero value, the return that ratio. Otherwise, return the aspect ratio preferred by the contained TransformBase object.
Reimplemented from PlotterBase.
Definition at line 496 of file XyPlotter.cxx.
References PlotterBase::m_aspect_ratio, XyPlotter::m_plotters, and num_util::size().
Referenced by XyPlotter::prepareMarginRect().

AxisModelBase * XyPlotter::getAxisModel ( hippodraw::Axes::Type axis ) const [virtual, inherited]

Returns the AxisModelBase derived class for the specified axis.

Reimplemented from PlotterBase.
Definition at line 538 of file XyPlotter.cxx.
References XyPlotter::m_plotter.
Referenced by XyPlotter::addDataRepStacked(), and XyPlotter::checkAutoScale().

double PlotterBase::getBinWidth ( const std::string & axis ) const [inherited]

Returns the bin width.
The implementation in the base class converts the string to an hippodraw::Axes::Type and calls the virtual function getBinWidth ( hippodraw::Axes::Type );. It is declared as a convenience to the developer since bin width is a common attribute.
Definition at line 428 of file PlotterBase.cxx.
References hippodraw::Axes::convert(), PlotterBase::getBinWidth(), and num_util::type().

double XyPlotter::getBinWidth ( hippodraw::Axes::Type ) const [virtual, inherited]

Returns the bins with of the target DataRep object.

Reimplemented from Plot


Public Types
typedef void(hippodraw::Observer::*	Action )(const Observable *)
	The member function of the Observer that is called.
typedef std::list< hippodraw::Observer * >	ObserverList_t
	The type of STL container to maintain list of Observer objects.
Public Member Functions
virtual int	activePlotIndex () const
	Returns the index of the active DataRep object.
virtual ProjectorBase *	activeProjector () const
	Returns the active projector.
void	addCutTarget (DataRep *)
	Adds a DataRep to the list of targeted.
virtual void	addDataRep (DataRep *rep)
	Adds a data representation.
virtual void	addDataRepStacked (DataRep *rep)
	Adds the DataRep object to the plotter.
void	addObserver (hippodraw::Observer *)
	Adds an Observer to the Observer list.
virtual void	addValues (const std::vector< double > &v)
	Adds data values to the plot.
virtual void	autoScale ()
	Sets the Range on each axis that has the auto range flag set to include all the data.
virtual void	checkAxisScaling ()
	Check if Axis needs to be scaled or not.
void	clearCutTargets ()
	Removes all cut targets.
PlotterBase *	clone ()
	This clone function returns an object of its own kind which is a copy of this object at this moment.
virtual NTuple *	createNTuple () const
	Creates an NTuple representation of the plotted data.
virtual NTuple *	createPickTuple ()
	Creates a NTuple for a PickTable.
int	currentView () const
	Return the current view index.
	Cut1DPlotter (const Cut1DPlotter &plotter)
	The copy constructor.
	Cut1DPlotter ()
	This default constructor.
void	deleteView (int index)
	Delete a view by index.
virtual void	drawCrossHairs (ViewBase *view)
	Draws cross-hairs.
virtual void	drawIn (ViewBase *view)
	Starts the drawing in view `view`.
virtual void	drawProjValues (ViewBase *view)
	Draws the projected values.
virtual bool	errorDisplay (hippodraw::Axes::Type axis) const
	Returns the state of error bar display on specified axis.
void	fillCutList (std::vector< const TupleCut * > &cuts) const
	Fills the cuts vector with the TupleCuts contained by the DataRep objects.
virtual void	fillPickedPoint (double mx, double my, std::vector< double > &picked) const
	Fills the picked data point.
virtual double	getAspectRatio () const
	Returns the aspect ratio.
virtual AxisModelBase *	getAxisModel (hippodraw::Axes::Type axis) const
	Returns the AxisModelBase derived class for the specified axis.
double	getBinWidth (const std::string &axis) const
	Returns the bin width.
virtual double	getBinWidth (hippodraw::Axes::Type) const
	Returns the bins with of the target DataRep object.
virtual bool	getCurrentRangeSaved ()
	Returns current_range_saved member t.
const Color &	getCutColor () const
	Get the color of the accepted region.
virtual const std::string &	getCutLabel () const
	Returns the label for the Cut.
const std::vector< TupleCut > &	getCuts () const
	Returns the list of TupleCut objects used by this plotter.
const std::list< DataRep * > &	getCutTargets () const
	Get the list of targets.
virtual DataRep *	getDataRep (int index) const
	Returns the DataRep object at index.
virtual double	getHighRangeOnX () const
	Returns the high end of the X axis range.
virtual const std::string &	getInternalLabel (hippodraw::Axes::Type axis) const
	Returns the internal label.
virtual const std::string &	getInternalTitle () const
	Returns the internal title.
virtual const std::string &	getLabel (hippodraw::Axes::Type) const
	Returns the label for the specified axis.
virtual double	getLowRangeOnX () const
	Returns the low end of the X axis range.
HippoRectangle	getMarginRect () const
	Returns the margin space where drawing takes place.
virtual int	getNumberOfEntries () const
	Returns the number of entries in the contained DataRep.
virtual int	getNumDataReps () const
	Returns the number of DataRep objects contained by the plotter.
int	getNumOfEntries () const
	Returns the number of entries in the contained DataRep.
const ObserverList_t &	getObservers () const
	Returns the list of observers.
double	getOffset (const std::string &axis) const
	Returns the offset on designated axis, similarly to getBinWidth.
virtual double	getOffset (hippodraw::Axes::Type axis) const
	Returns the offset on designated axis, similarly to getBinWidth.
virtual int	getParentDataRepIndex () const
	Returns the index of the parent DataRep.
virtual PlotterBase *	getParentPlotter () const
	Returns the parent plotter.
virtual double	getPosRange (hippodraw::Axes::Type axis) const
	Returns the smallest positive number from the data.
virtual ProjectorBase *	getProjector (int i) const
	Returns the i-th projector.
virtual const Range &	getRange (hippodraw::Axes::Type axis, bool scaled) const
	Returns the range on the specified axis.
virtual DataRep *	getTarget () const
	Returns the selected DataRep.
const std::string &	getTitle () const
	Gets the title to be displayed.
virtual TransformBase *	getTransform () const
	Returns the transform object used by the plotter.
const HippoRectangle &	getUserRect () const
	Returns the data space rectangle.
virtual const BinToColor *	getValueRep () const
	Returns the value to color representation.
virtual double	getZValue (double x, double y, bool scaled=true) const
	Get the z value at the specified point (x,y).
bool	hasAutoScaled () const
	Returns true if the axes have already been auto-scaled.
virtual bool	hasAxis (hippodraw::Axes::Type axis) const
	Returns `true` if the plotter has an axis of specified type.
virtual bool	hasNTupleBindings () const
	Returns `true` as a CutPlotter always has ntuple bindings.
virtual bool	hasZoomY () const
	Returns `true` if the plotter has zoom feature on the Y axis otherwise it returns false.
virtual int	indexOf (const DataRep *) const
	Returns the index of the selected DataRep object.
virtual bool	isAutoRanging (hippodraw::Axes::Type axis) const
	Returns `true` if auto-ranging is enabled, otherwise returns `false`.
bool	isTarget (DataRep *) const
	Returns `true` if specified DataRep is a target of this cut.
bool	isTargetable () const
	Returns `true` if receiving object is target-able.
FontBase *	labelFont (hippodraw::Axes::Type axes) const
	What font is being used to override the default while drawing axis label.
virtual double	marginToInvertedUserY (double y) const
	Converts from inverted view coordinate to data coordinate, without taking into account transforms or scaling.
virtual double	marginToUserX (double x) const
	Converts from view coordinate to data coordinate, without taking into account transforms or scaling.
virtual void	marginToUserXY (double mx, double my, bool scaled, double &ux, double &uy) const
	Converts from the drawing space to the data space.
virtual double	marginToUserY (double y) const
	Converts from view coordinate to data coordinate, without taking into account transforms or scaling.
virtual void	matrixTranspose (bool yes)
	Transpose the X and Y axis of matrix representation.
const std::string &	name () const
	Returns the name of the plotter.
int	nextView (bool stepForward=true)
	Cycle through each set of plot ranges, thereby changing the view with each call.
virtual void	notifyObservers () const
	Notifies Observer objects of a change.
int	numViews () const
	Return the number of stored views.
virtual int	plotterId () const
	The unique ID number of this plotter.
void	prepareMarginRect (ViewBase *view)
	Prepares the margin rectangle.
virtual void	removeDataRep (DataRep *rep)
	Removes the DataRep object from the plotter.
void	removeFromTarget (DataRep *rep)
	Remove this cut from one of its target rep.
void	removeObserver (hippodraw::Observer *)
	Removes an Observer from the Observer list.
virtual const Color &	repColor () const
	Returns the color used for the representation.
virtual RepBase *	representation () const
	Returns the representation used by the plotter.
virtual void	reset ()
	Resets the bins.
int	saveView (const std::vector< double > &range_values)
	Save the current set of plot ranges which define a "view" for this plot.
int	saveViewAtIndex (const std::vector< double > &range_values, unsigned int i)
	Save the current set of plot ranges which define a "view" for this plot.at the position i.
virtual DataRep *	selectedDataRep () const
	Returns the selected DataRep.
void	setActive (bool yes)
	Sets the cut as active.
virtual void	setActivePlot (int index, bool redraw)
	Sets the active plot.
void	setAspectRatio (double ratio)
	Sets the aspect ratio.
virtual void	setAutoRanging (const std::string &axis, bool flag)
	Sets the auto-ranging.
virtual void	setAutoRanging (hippodraw::Axes::Type axis, bool flag)
	Sets the auto-ranging.
virtual void	setAutoRanging (bool flag)
	Sets the auto-ranging status for all axes to flag.
virtual void	setAutoTicks (const std::string &, bool on)
	Sets automatic ticks on or off.
virtual void	setAutoTicks (hippodraw::Axes::Type axis, bool yes)
	Sets automatic generation of axis ticks.
virtual void	setAutoTicksOnX (bool yes)
	Sets automatic generation of axis ticks on X axis.
virtual void	setAxisBinding (const std::string &axis, const std::string &label)
	Sets the axis binding of both the Cut and its DataRep.
virtual void	setAxisModel (AxisModelBase *, hippodraw::Axes::Type)
	Sets the AxisModel on the specified axis.
virtual void	setBinWidth (const std::string &axis, double width)
	Sets the bin width.
virtual void	setBinWidth (hippodraw::Axes::Type axis, double width)
	Sets the bin width.
void	setCrossX (double val)
	Set the crossX value.
void	setCrossY (double val)
	Set the crossY value.
virtual void	setCurrentRangeSaved (bool flag)
	Sets current_range_saved member to flag.
void	setCutColor (const Color &)
	Sets the color of the cut acceptance region.
virtual void	setCutEnabled (unsigned int i, bool yes=true)
	Sets the TupleCut object index by i to be enabled.
virtual void	setCutInverted (unsigned int i, bool yes=true)
	Sets the TupleCut object indexed by i to be inverted.
virtual void	setCutRange (double low, double high)
	Sets the Range on the X axis.
virtual void	setCutRangeAt (const Range &range, unsigned int index)
	Sets the Range of the cut.
void	setCutRangeFull ()
	Sets the cut Range to include the full range of data.
void	setCutRepresentation (RepBase *rep)
	Sets the cut representation.
void	setCuts (const std::vector< const TupleCut * > &cuts)
	Sets the TupleCut objects to be used by this plotter.
void	setEnabled (bool yes=true)
	Sets the state of the cut's enabled status.
virtual void	setEnableZ (bool yes=true)
	Sets the display of the Z axis on.
virtual void	setErrorDisplay (hippodraw::Axes::Type axis, bool)
	Sets the display of the error bars on or off.
virtual void	setHighRange (hippodraw::Axes::Type axis, int parm, bool dragging)
	Sets the high end of the Range of data displayed.
virtual void	setLabel (const std::string &axis, const std::string &label)
	Sets the label of specified axis to label.
virtual void	setLabel (hippodraw::Axes::Type, const std::string &value)
	Sets the label of the specified axis to value.
void	setLabelFont (FontBase *font, hippodraw::Axes::Type axes)
	Set the font to be used to override the default while drawing axis label.
virtual void	setLowRange (hippodraw::Axes::Type axis, int parm, bool dragging)
	Sets the low end of the Range of data displayed.
void	setNTuple (const DataSource *ntuple)
	Sets the ntuple for the Cut and its DataRep object.
virtual void	setNumberOfBins (const std::string &axis, unsigned int number)
	Sets the number of bins.
virtual void	setNumberOfBins (hippodraw::Axes::Type axis, unsigned int number)
	Sets the number of bins.
virtual void	setOffset (const std::string &axis, double offset)
	Sets the bin offset.
virtual void	setOffset (hippodraw::Axes::Type axis, double offset)
	Sets the offset.
virtual void	setOffsets (double xoffset, double yoffset)
	Sets the offsets on the x and y axis.
virtual void	setParentDataRepIndex (int index)
	Sets the index of the parent DataRep.
virtual void	setParentPlotter (PlotterBase *plotter)
	Sets the parent plotter.
void	setRange (const std::string &axis, double low, double high)
	Sets the range on the specified axis.
virtual void	setRange (hippodraw::Axes::Type axis, const Range &range, bool scaled=false, bool adjust_width=true)
	Sets the range on the specified axis.
virtual void	setRepColor (const Color &)
	Sets the representation's color.
virtual void	setRepresentation (RepBase *pointrep)
	Sets the representation.
virtual void	setScaling (hippodraw::Axes::Type axis, bool on=true)
	Sets the scaling attribute of the AxisModelBase object.
virtual void	setTicks (const std::string &axis, const std::vector< double > &values, const std::vector< std::string > &labels)
	Sets the ticks on specified axis.
virtual void	setTicks (hippodraw::Axes::Type axis, const std::vector< AxisTick > &ticks)
	Sets the ticks for the specified axis.
virtual void	setTicksOnX (const std::vector< double > &values, const std::vector< std::string > &labels)
	Sets the ticks for the X axis.
void	setTitle (const std::string &title)
	Sets the title to be displayed.
void	setTitleFont (FontBase *font)
	Set the font to be used to override the default while drawing title.
virtual void	setTransform (TransformBase *)
	Sets the transform object and redraws.
virtual void	setValueRep (BinToColor *rep)
	Sets the object that will do the value to color transform, if any.
void	setView (int index)
	Set the view by index.
const FontBase *	titleFont () const
	What font is being used to override the default while drawing title of plot.
void	toggleActivePlot ()
	Toggles the active DataRep, if 2 or more are contained by the plotter.
virtual void	toggleInverted ()
	Reverse the meaning of the cut Range.
virtual void	update ()
	Updates the plotter.
virtual void	update (const Observable *object)
	Responds to the update message from one of its Observable objects.
virtual float	userToInvertedMarginY (double y) const
	Converts the user Y coordinate into the top-left based margin Y coordinate.
virtual float	userToMarginColor (double c) const
	Converts the user Z coordinate into the margin color (X) coordinate.
virtual float	userToMarginX (double x) const
	Converts the user X coordinate into the margin X coordinate.
virtual float	userToMarginY (double y) const
	Converts the user Y coordinate into the margin Y coordinate.
virtual bool	wantsPixmap () const
	Returns `true`.
virtual void	willDelete (const Observable *observable)
	Responds to willDelete message emitted from one of the Observers.
virtual	~Cut1DPlotter ()
	The destructor.
Protected Types
typedef std::list< DataRep * >	TargetList_t
	The STL container type used for targets of the cut.
Protected Member Functions
void	calcAxisRatios (const CompositePlotter *)
	Calculates the ratio of view and data scales.
TupleCut *	getCutAt (unsigned int i)
	Returns the TupleCut object at position i.
void	notifyObservers (Action action) const
	An internal method to iterate over all observers and to send the message action.
void	removeFromTargets ()
	Removes this cut from all of its targets.
void	updateTargets ()
	Update the target DataRep when a change has been made in the TupleCut.
Protected Attributes
bool	current_range_saved
	Returns true if the current range on the axes have been saved.
double	m_aspect_ratio
	The aspect ratio.
AxisRepBase *	m_axis_rep
	The axes model graphical representation.
double	m_crossX
	The x position of the cross hair.
double	m_crossY
	The y position of the cross hair.
int	m_currentView
	Index of the current view.
DataRep *	m_datarep
	A pointer to the data representation that holds the cuts.
HippoRectangle	m_margin_rect
	The rectangle area in which the projected points are plotted.
std::string	m_name
	The name of the type of plotter.
int	m_parent_datarep_index
	Parent DataRep index.
PlotterBase *	m_parent_plotter
	Parent plotter.
CompositePlotter *	m_plotter
	The currently active plotter that draws the data points.
int	m_plotterId
	A unique plotter id.
TargetList_t	m_targets
	A list of DataRep objects which have this cut applied.
std::string	m_title
	The main label; the title of the plot.
HippoRectangle	m_user_rect
	The abstract data space.
std::vector< std::vector< double > >	m_views
	A vector of x and y ranges to be used as a circular buffer allowing one to cycle through the saved plot "views".
double	m_z_ratio
	The conversion ratio from the user coordinate system to the view's coordinate system along the color axis.
Static Protected Attributes
static int	s_plotters
	Reference count for creating plotter ids.