OpenStudioCore:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
openstudio::MatrixFloodPlotData Class Reference

#include <FloodPlot.hpp>

+ Inheritance diagram for openstudio::MatrixFloodPlotData:

Public Types

typedef std::shared_ptr< const
MatrixFloodPlotData
ConstPtr
 
typedef std::vector< ConstPtrConstVec
 
typedef std::weak_ptr< const
MatrixFloodPlotData
ConstWeakPtr
 
typedef std::shared_ptr
< MatrixFloodPlotData
Ptr
 
typedef std::vector< PtrVec
 
typedef std::weak_ptr
< MatrixFloodPlotData
WeakPtr
 
- Public Types inherited from openstudio::FloodPlotData
typedef std::shared_ptr< const
FloodPlotData
ConstPtr
 
typedef std::vector< ConstPtrConstVec
 
typedef std::weak_ptr< const
FloodPlotData
ConstWeakPtr
 
typedef std::shared_ptr
< FloodPlotData
Ptr
 
typedef std::vector< PtrVec
 
typedef std::weak_ptr
< FloodPlotData
WeakPtr
 

Public Member Functions

void colorMapRange (QwtDoubleInterval colorMapRange)
 range of values for which to show the colormap More...
 
QwtDoubleInterval colorMapRange ()
 range of values for which to show the colormap More...
 
virtual MatrixFloodPlotDatacopy () const
 must provide copy More...
 
void interpMethod (InterpMethod interpMethod)
 set the interp method, defaults to Nearest More...
 
 MatrixFloodPlotData (const Matrix &matrix)
 constructor More...
 
 MatrixFloodPlotData (const Matrix &matrix, QwtDoubleInterval colorMapRange)
 constructor and color map range More...
 
 MatrixFloodPlotData (const Vector &xVector, const Vector &yVector, const Matrix &matrix)
 constructor with x and y vectors More...
 
 MatrixFloodPlotData (const Vector &xVector, const Vector &yVector, const Matrix &matrix, const InterpMethod interp)
 constructor with x and y vectors and interpolation method More...
 
 MatrixFloodPlotData (const std::vector< double > &xVector, const std::vector< double > &yVector, const std::vector< double > &matrix)
 constructor with x and y vectors More...
 
 MatrixFloodPlotData (const std::vector< double > &xVector, const std::vector< double > &yVector, const std::vector< double > &matrix, const InterpMethod interp)
 constructor with x and y vectors and interpolation method More...
 
 MatrixFloodPlotData (const Vector &xVector, const Vector &yVector, const Matrix &matrix, QwtDoubleInterval colorMapRange)
 constructor with x and y vectors and color map range More...
 
double maxValue () const
 maxValue More...
 
void maxValue (double max)
 maxValue setter More...
 
double maxX () const
 maxX More...
 
double maxY () const
 maxY More...
 
double meanValue () const
 meanValue More...
 
double minValue () const
 minValue More...
 
void minValue (double min)
 minValue setter More...
 
double minX () const
 minX More...
 
double minY () const
 minY More...
 
QwtDoubleInterval range () const
 must provide range of values - colormap range not data range More...
 
double stdDevValue () const
 stdDevValue More...
 
double sumValue () const
 sumValue More...
 
std::string units () const
 units for plotting on axes or scaling More...
 
double value (double x, double y) const
 get the value at point x, y More...
 
virtual ~MatrixFloodPlotData ()
 virtual destructor More...
 
- Public Member Functions inherited from openstudio::FloodPlotData
virtual ~FloodPlotData ()
 virtual destructor More...
 

Static Public Member Functions

static Ptr create (const Matrix &matrix)
 create More...
 
static Ptr create (const Matrix &matrix, QwtDoubleInterval &colorMapRange)
 
static Ptr create (const Vector &xVector, const Vector &yVector, const Matrix &matrix)
 create with x and y vectors More...
 
static Ptr create (const Vector &xVector, const Vector &yVector, const Matrix &matrix, const InterpMethod interp)
 
static Ptr create (const Vector &xVector, const Vector &yVector, const Matrix &matrix, QwtDoubleInterval &colorMapRange)
 
static Ptr create (const std::vector< double > &xVector, const std::vector< double > &yVector, const std::vector< double > &matrix)
 create with std::vectors More...
 
static Ptr create (const std::vector< double > &xVector, const std::vector< double > &yVector, const std::vector< double > &matrix, const InterpMethod interp)
 

Additional Inherited Members

- Protected Member Functions inherited from openstudio::FloodPlotData
 FloodPlotData ()
 

Detailed Description

MatrixFloodPlotData converts a Matrix into flood plot data.

Member Typedef Documentation

Constructor & Destructor Documentation

openstudio::MatrixFloodPlotData::MatrixFloodPlotData ( const Matrix &  matrix)

constructor

openstudio::MatrixFloodPlotData::MatrixFloodPlotData ( const Matrix &  matrix,
QwtDoubleInterval  colorMapRange 
)

constructor and color map range

openstudio::MatrixFloodPlotData::MatrixFloodPlotData ( const Vector &  xVector,
const Vector &  yVector,
const Matrix &  matrix 
)

constructor with x and y vectors

openstudio::MatrixFloodPlotData::MatrixFloodPlotData ( const Vector &  xVector,
const Vector &  yVector,
const Matrix &  matrix,
const InterpMethod  interp 
)

constructor with x and y vectors and interpolation method

openstudio::MatrixFloodPlotData::MatrixFloodPlotData ( const std::vector< double > &  xVector,
const std::vector< double > &  yVector,
const std::vector< double > &  matrix 
)

constructor with x and y vectors

openstudio::MatrixFloodPlotData::MatrixFloodPlotData ( const std::vector< double > &  xVector,
const std::vector< double > &  yVector,
const std::vector< double > &  matrix,
const InterpMethod  interp 
)

constructor with x and y vectors and interpolation method

openstudio::MatrixFloodPlotData::MatrixFloodPlotData ( const Vector &  xVector,
const Vector &  yVector,
const Matrix &  matrix,
QwtDoubleInterval  colorMapRange 
)

constructor with x and y vectors and color map range

virtual openstudio::MatrixFloodPlotData::~MatrixFloodPlotData ( )
inlinevirtual

virtual destructor

Member Function Documentation

void openstudio::MatrixFloodPlotData::colorMapRange ( QwtDoubleInterval  colorMapRange)
inlinevirtual

range of values for which to show the colormap

Implements openstudio::FloodPlotData.

QwtDoubleInterval openstudio::MatrixFloodPlotData::colorMapRange ( )
inlinevirtual

range of values for which to show the colormap

Implements openstudio::FloodPlotData.

virtual MatrixFloodPlotData* openstudio::MatrixFloodPlotData::copy ( ) const
virtual

must provide copy

Implements openstudio::FloodPlotData.

static Ptr openstudio::MatrixFloodPlotData::create ( const Matrix &  matrix)
inlinestatic

create

static Ptr openstudio::MatrixFloodPlotData::create ( const Matrix &  matrix,
QwtDoubleInterval &  colorMapRange 
)
inlinestatic
static Ptr openstudio::MatrixFloodPlotData::create ( const Vector &  xVector,
const Vector &  yVector,
const Matrix &  matrix 
)
inlinestatic

create with x and y vectors

static Ptr openstudio::MatrixFloodPlotData::create ( const Vector &  xVector,
const Vector &  yVector,
const Matrix &  matrix,
const InterpMethod  interp 
)
inlinestatic
static Ptr openstudio::MatrixFloodPlotData::create ( const Vector &  xVector,
const Vector &  yVector,
const Matrix &  matrix,
QwtDoubleInterval &  colorMapRange 
)
inlinestatic
static Ptr openstudio::MatrixFloodPlotData::create ( const std::vector< double > &  xVector,
const std::vector< double > &  yVector,
const std::vector< double > &  matrix 
)
inlinestatic

create with std::vectors

static Ptr openstudio::MatrixFloodPlotData::create ( const std::vector< double > &  xVector,
const std::vector< double > &  yVector,
const std::vector< double > &  matrix,
const InterpMethod  interp 
)
inlinestatic
void openstudio::MatrixFloodPlotData::interpMethod ( InterpMethod  interpMethod)

set the interp method, defaults to Nearest

double openstudio::MatrixFloodPlotData::maxValue ( ) const
inlinevirtual

maxValue

Implements openstudio::FloodPlotData.

void openstudio::MatrixFloodPlotData::maxValue ( double  max)
inlinevirtual

maxValue setter

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::maxX ( ) const
virtual

maxX

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::maxY ( ) const
virtual

maxY

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::meanValue ( ) const
virtual

meanValue

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::minValue ( ) const
inlinevirtual

minValue

Implements openstudio::FloodPlotData.

void openstudio::MatrixFloodPlotData::minValue ( double  min)
inlinevirtual

minValue setter

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::minX ( ) const
virtual

minX

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::minY ( ) const
virtual

minY

Implements openstudio::FloodPlotData.

QwtDoubleInterval openstudio::MatrixFloodPlotData::range ( ) const
inlinevirtual

must provide range of values - colormap range not data range

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::stdDevValue ( ) const
virtual

stdDevValue

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::sumValue ( ) const
virtual

sumValue

Implements openstudio::FloodPlotData.

std::string openstudio::MatrixFloodPlotData::units ( ) const
inlinevirtual

units for plotting on axes or scaling

Implements openstudio::FloodPlotData.

double openstudio::MatrixFloodPlotData::value ( double  x,
double  y 
) const
virtual

get the value at point x, y

Implements openstudio::FloodPlotData.