Image Component Library (ICL)
Public Member Functions | Public Attributes | List of all members
icl::qt::HistogrammWidget Struct Reference

Utility class used within the ICLWidget class. More...

#include <HistogrammWidget.h>

Inheritance diagram for icl::qt::HistogrammWidget:
icl::qt::PlotWidget icl::qt::LowLevelPlotWidget icl::qt::AbstractPlotWidget icl::qt::ThreadedUpdatableWidget icl::utils::Configurable

Public Member Functions

 HistogrammWidget (QWidget *parent)
 Base constructor with given parent widget. More...
 
void setFeatures (bool logOn, bool meanOn, bool medianOn, int selChannel)
 sets all features More...
 
void updateData (const ImageStatistics &s)
 updates the histogramms More...
 
- Public Member Functions inherited from icl::qt::PlotWidget
 PlotWidget (QWidget *parent=0)
 Constructor with given parent. More...
 
 ~PlotWidget ()
 Destrutor. More...
 
void lock ()
 locks the draw queue More...
 
void unlock ()
 unlocks the draw queue More...
 
virtual void clear ()
 clears the draw queue More...
 
void reset ()
 synonym for clear() More...
 
void label (const std::string &primitiveLabel)
 sets the legend label for the next scatter-, series- or bar-plot More...
 
void nolabel ()
 calls label("") More...
 
void color (int r, int g, int b, int a=255)
 sets the line color More...
 
template<class VectorType >
void color (const VectorType &c)
 convenience macro for types that provide and index operator [] More...
 
void nocolor ()
 sets a fully transparent line color More...
 
void pen (const QPen &pen)
 sets the line pen More...
 
void fill (int r, int g, int b, int a=255)
 sets the fill color for series- and bar-plots More...
 
template<class VectorType >
void fill (const VectorType &c)
 convenience macro for types that provide and index operator [] More...
 
void nofill ()
 sets a fully transparent fill color More...
 
void brush (const QBrush &brush)
 sets the fill brush More...
 
void sym (char s)
 sets the current symbol More...
 
void sym (char s, int symsize)
 sets the current symbol and the symbol size More...
 
void nosym ()
 resets the symbol to ' ' which means no symbols are shown More...
 
void linewidth (float width)
 sets the linewidth More...
 
void symsize (float size)
 sets the symbols size More...
 
template<class T >
ICLQt_API void scatter (const T *xs, const T *ys, int num, int xStride=1, int yStride=1, bool connect=false)
 adds a scatter plot with given x- and y-data pointer More...
 
void scatter (const std::vector< utils::Point32f > &ps, bool connect=false)
 adds a scatter plot from given vector of points More...
 
void scatter (const std::vector< utils::Point > &ps, bool connect=false)
 adds a scatter plot from given vector of points More...
 
template<class T >
void scatter (const math::FixedMatrix< T, 1, 2 > *ps, int num, bool connect=false)
 adds a scatter plot from given set of of fixed vectors More...
 
template<class T >
void scatter (const math::FixedMatrix< T, 2, 1 > *ps, int num, bool connect=false)
 
void scatter (const std::vector< math::FixedColVector< float, 2 > > &ps, bool connect=false)
 adds a scatter plot from given vector of fixed vectors More...
 
template<class T >
ICLQt_API void series (const T *data, int num, int stride=1)
 adds series data More...
 
template<class T >
void series (const std::vector< T > &data)
 adds series data from given std::vector More...
 
template<class T >
ICLQt_API void bars (const T *data, int num, int stride=1)
 adds bar plot data More...
 
template<class T >
void bars (const std::vector< T > &data)
 adds bar plot data from given std::vector More...
 
void line (const utils::Point32f &a, const utils::Point32f &b)
 draws a line annotation using the current color More...
 
void line (float x1, float y1, float x2, float y2)
 draws a line annotation given 4 coordinates More...
 
void linestrip (const std::vector< utils::Point32f > &ps, bool closedLoop=true)
 draws a line strip annotation More...
 
void linestrip (const std::vector< utils::Point > &ps, bool closedLoop=true)
 draws a line strip annotation More...
 
void linestrip (const utils::Point32f *ps, int num, bool closedLoop=true)
 draws a line strip annotation More...
 
void linestrip (const utils::Point *ps, int num, bool closedLoop=true)
 draws a line strip annotation More...
 
void linestrip (const float *xs, const float *ys, int num, bool closedLoop=true, int stride=1)
 draws a line strip annotation More...
 
void rect (const utils::Point32f &ul, const utils::Point32f &lr)
 draws a rectangle annotation with given upper left and lower right coordinate More...
 
void rect (const utils::Rect &r)
 draws a rectangle annotation More...
 
void rect (const utils::Rect32f &r)
 draws a rectangle annotation More...
 
void rect (float x, float y, float w, float h)
 draws a rectangle annotation More...
 
void circle (const utils::Point32f &c, float r)
 draws a circle annotation More...
 
void circle (float cx, float cy, float r)
 draws a circle annotation More...
 
void text (float x, float y, const std::string &text)
 draws a text annotation More...
 
void text (const utils::Point32f &p, const std::string &text)
 draws a text annotation More...
 
void grid (int nX, int nY, const float *xs, const float *ys, int stride=1)
 draws a grid-annoation More...
 
void grid (const utils::Array2D< utils::Point > &data)
 draws a grid-annoation More...
 
void grid (const utils::Array2D< utils::Point32f > &data)
 draws a grid-annoation More...
 
void grid (int nX, int nY, const float *xys)
 draws a grid-annoation More...
 
void grid (int nX, int nY, const utils::Point *ps)
 draws a grid-annoation More...
 
void grid (int nX, int nY, const utils::Point32f *ps)
 draws a grid-annoation More...
 
void grid (int nX, int nY, const std::vector< utils::Point32f > &ps)
 draws a grid-annoation More...
 
void grid (int nX, int nY, const std::vector< utils::Point > &ps)
 draws a grid-annoation More...
 
void grid (int nX, int nY, const std::vector< float > &xys)
 draws a grid-annoation More...
 
void grid (int nX, int nY, const std::vector< float > &xs, const std::vector< float > &ys)
 draws a grid-annoation More...
 
void draw (const utils::VisualizationDescription &d)
 draws a VisualizationDescription instance More...
 
void title (const std::string &title)
 sets the diagram title More...
 
void xlabel (const std::string &xlabel)
 sets the x-axis label More...
 
void ylabel (const std::string &ylabel)
 sets the y-axis label More...
 
- Public Member Functions inherited from icl::qt::LowLevelPlotWidget
 LowLevelPlotWidget (QWidget *parent=0)
 constructor More...
 
 ~LowLevelPlotWidget ()
 destructor More...
 
virtual utils::Rect32f getDataViewPort () const
 returns the data viewport More...
 
void addSeriesData (const float *data, int len, const AbstractPlotWidget::PenPtr &style=new AbstractPlotWidget::Pen(QColor(255, 0, 0)), const std::string &name="", int stride=1, bool deepCopy=true, bool passOwnerShip=false)
 adds series data More...
 
void addBarPlotData (const float *data, int len, const AbstractPlotWidget::PenPtr &style=new AbstractPlotWidget::Pen(QColor(255, 0, 0)), const std::string &name="", int stride=1, bool deepCopy=true, bool passOwnerShip=false)
 adds data for a bar plots More...
 
void addScatterData (char symbol, const float *xs, const float *ys, int num, const std::string &name="", int r=255, int g=0, int b=0, int size=5, bool connectingLine=false, int xStride=1, int yStride=1, bool filled=false, bool deepCopyData=true, bool passDataOwnerShip=false)
 adds a list of symbols More...
 
void clearScatterData ()
 clears the scatter data draw list More...
 
void clearSeriesData ()
 clears series data draw list More...
 
void clearBarPlotData ()
 clears the bar plot draw list More...
 
- Public Member Functions inherited from icl::qt::AbstractPlotWidget
void install (MouseHandler *h)
 adds a new mouse handler More...
 
void uninstall (MouseHandler *h)
 removes a mouse handler More...
 
 AbstractPlotWidget (QWidget *parent=0)
 Base constructor. More...
 
 ~AbstractPlotWidget ()
 destructor More...
 
virtual void paintEvent (QPaintEvent *evt)
 custom drawing More...
 
virtual void keyPressEvent (QKeyEvent *event)
 listens for F11 which enables the fullscreen mode More...
 
void renderTo (QPainter &p)
 renders the whole content using the given qpainter More...
 
void setBackground (const QBrush &bgBrush)
 sets the background brush More...
 
void setPen (PenType p, const QPen &pen)
 sets the pen for one of the widget compoments More...
 
void render ()
 updates the screen More...
 
void setDataViewPort (const utils::Rect32f &viewPort)
 sets the default dataviewport More...
 
void setDataViewPort (const utils::Range32f &xrange, const utils::Range32f &yrange)
 sets the default viewport More...
 
void lock () const
 locks drawing / data updates in subclasses More...
 
void unlock () const
 unlocks drawing / data updates in subclasses More...
 
void addAnnotations (const char type, const float *data, int num=1, const QPen &linePen=QColor(255, 0, 0), const QBrush &brush=Qt::NoBrush, const std::string &text="", const std::string &textDelim=",")
 adds an annotation to the data viewport More...
 
void clearAnnotations ()
 removes all existing annotations More...
 
void setBackgroundFunction (bgFunction f)
 sets the background function More...
 
void updateBackgroundFunction ()
 forces a repaint on the background function in the next rendering cycle More...
 
void removeBackgroundFunction ()
 removes the background function More...
 
- Public Member Functions inherited from icl::qt::ThreadedUpdatableWidget
 ThreadedUpdatableWidget (QWidget *parent=0)
 Base constructor. More...
 
void updateFromOtherThread ()
 call this function to update a widget's UI from an external thread More...
 
virtual bool event (QEvent *event)
 automatically called by Qt's event processing mechanism More...
 
- Public Member Functions inherited from icl::utils::Configurable
virtual ~Configurable ()
 virtual destructor More...
 
 Configurable (const Configurable &other)
 Copy constructor. More...
 
Configurableoperator= (const Configurable &other)
 Assignment operator. More...
 
void setConfigurableID (const std::string &ID)
 sets the ID of this configurable More...
 
const std::string & getConfigurableID () const
 returns the configurables static ID More...
 
bool isOrderedFlagSet () const
 returns whether the ordered flag is set More...
 
void deactivateProperty (const std::string &pattern)
 adds an additional deativation pattern More...
 
void deleteDeactivationPattern (const std::string &pattern)
 removed a formerly added deactivation pattern More...
 
std::vector< std::string > getPropertyListWithoutDeactivated () const
 this returns a filtered list of properties (using all filters added by deactivateProperty) More...
 
virtual void adaptProperty (const std::string &name, const std::string &newType, const std::string &newInfo, const std::string &newToolTip)
 this function can be used to adapt a specific property afterwards More...
 
void registerCallback (const Callback &cb)
 add a callback for changed properties More...
 
void removedCallback (const Callback &cb)
 removes a callback that was registered before More...
 
void syncChangesTo (Configurable *others, int num=1)
 this can be used to let this instance also apply property changes to others More...
 
virtual void setPropertyValue (const std::string &propertyName, const Any &value)
 sets a property value More...
 
virtual std::vector< std::string > getPropertyList () const
 returns a list of All properties, that can be set using setProperty More...
 
virtual bool supportsProperty (const std::string &propertyName) const
 base implementation for property check (seaches in the property list) More...
 
virtual void saveProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC) const
 writes all available properties into a file More...
 
virtual void loadProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC)
 reads a camera config file from disc More...
 
virtual std::string getPropertyType (const std::string &propertyName) const
 get type of property More...
 
virtual std::string getPropertyInfo (const std::string &propertyName) const
 get information of a properties valid values More...
 
virtual Any getPropertyValue (const std::string &propertyName) const
 returns the current value of a property or a parameter More...
 
virtual std::string getPropertyToolTip (const std::string &propertyName) const
 returns the tooltip description for a given property More...
 
virtual int getPropertyVolatileness (const std::string &propertyName) const
 Returns whether this property may be changed internally. More...
 

Public Attributes

bool logOn
 logarithmic mode More...
 
bool meanOn
 mean averaging More...
 
bool medianOn
 median filtering More...
 
int selChannel
 selected channel (or -1 for all) More...
 
std::vector< float > buf
 

Additional Inherited Members

- Public Types inherited from icl::qt::AbstractPlotWidget
enum  PenType {
  X_AXIS_PEN, Y_AXIS_PEN, X_TIC_PEN, Y_TIC_PEN,
  X_LABEL_PEN, Y_LABEL_PEN, X_GRID_PEN, Y_GRID_PEN,
  AXIS_NAME_PEN, NUM_PEN_TYPES
}
 different pen types More...
 
typedef utils::SmartPtr< PenPenPtr
 typedef for managed row-style pointers More...
 
typedef utils::Function< float, float, float > bgFunction
 function that is used to render a non-homo More...
 
- Public Types inherited from icl::utils::Configurable
typedef Function< void, const Property & > Callback
 Function type for changed properties. More...
 
- Static Public Member Functions inherited from icl::utils::Configurable
static std::string create_default_ID (const std::string &prefix)
 this function can be used in subclasses to create a default ID More...
 
static Configurableget (const std::string &id)
 returns configurable by given ID More...
 
static void register_configurable_type (const std::string &classname, Function< Configurable * > creator)
 registers a configurable type More...
 
static std::vector< std::string > get_registered_configurables ()
 returns a list of all registered configurable classnames More...
 
static Configurablecreate_configurable (const std::string &classname)
 creates a configurable by given name More...
 
- Static Public Attributes inherited from icl::utils::Configurable
static const std::vector< std::string > EMPTY_VEC
 used as shortcut – just an empty vector of std::strings More...
 
- Protected Member Functions inherited from icl::qt::LowLevelPlotWidget
virtual void drawLegend (QPainter &p, const utils::Rect &where, bool horizontal)
 internally used More...
 
virtual bool drawSeriesData (QPainter &p, const DrawState &state)
 draws the series data More...
 
virtual bool drawScatterData (QPainter &p, const DrawState &state)
 draws the sctter data More...
 
virtual bool drawBarPlotData (QPainter &p, const DrawState &state)
 draws the bar plot data More...
 
virtual bool drawData (QPainter &p)
 draws all the data More...
 
virtual utils::Range32f estimateDataXRange () const
 estimates the data xrange (for automatic viewport adaption) More...
 
virtual utils::Range32f estimateDataYRange () const
 estimates the data yrange (for automatic viewport adaption) More...
 
- Protected Member Functions inherited from icl::qt::AbstractPlotWidget
bool isZoomed () const
 returns whether the zoom is active More...
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 internally used More...
 
virtual void mouseMoveEvent (QMouseEvent *event)
 internally used More...
 
virtual void mousePressEvent (QMouseEvent *event)
 internally used More...
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 internally used More...
 
virtual void enterEvent (QEvent *event)
 internally used More...
 
virtual void leaveEvent (QEvent *event)
 internally used More...
 
void drawDefaultLedgend (QPainter &p, const utils::Rect &where, bool horizontal, const std::vector< std::string > &rowNames, const std::vector< PenPtr > &pens)
 draws a default ledgen into the given quad More...
 
float winToDrawX (int winX) const
 converts a window x coordinate to logical drawing coordinate More...
 
float winToDrawY (int winY) const
 converts a window y coordinate to logical drawing coordinate More...
 
utils::Point32f winToDraw (const utils::Point &p) const
 converts a window coordinates to logical drawing coordinates More...
 
int drawToWinX (float drawX) const
 convert logical drawing x coordinate to window coordinate More...
 
int drawToWinY (float drawY) const
 convert logical drawing y coordinate to window coordinate More...
 
utils::Point drawToWin (const utils::Point32f &p) const
 convert logical drawing coordinates to window coordinates More...
 
utils::Rect32f getDynamicDataViewPort () const
 returns the current data viewport w.r.t. the current zoom More...
 
- Protected Member Functions inherited from icl::utils::Configurable
void addProperty (const std::string &name, const std::string &type, const std::string &info, const Any &value=Any(), const int volatileness=0, const std::string &tooltip=std::string())
 This can be used by derived classes to store supported properties in the internal list. More...
 
void addChildConfigurable (Configurable *configurable, const std::string &childPrefix="")
 This adds another configurable as child. More...
 
void removeChildConfigurable (Configurable *configurable)
 removes the given child configurable More...
 
Propertyprop (const std::string &propertyName)
 this CAN be used e.g. to store a property value in internal property-list More...
 
const Propertyprop (const std::string &propertyName) const
 this CAN be used e.g. to store a property value in internal property-list More...
 
 Configurable (const std::string &ID="", bool ordered=true)
 create this configurable with given ID More...
 
void call_callbacks (const std::string &propertyName, const Configurable *caller) const
 calls all registered callbacks More...
 
- Static Protected Member Functions inherited from icl::qt::AbstractPlotWidget
template<char s>
static void draw_symbol (QPainter &p, int size, float x, float y)
 draws one of the Symbols (filled symbols are drawn by setting the QPainters brush manually) More...
 
- Protected Attributes inherited from icl::utils::Configurable
std::vector< Callbackcallbacks
 internally managed list of callbacks More...
 

Detailed Description

Utility class used within the ICLWidget class.

The HistogrammWidget is used in the 'info' tab of the ICLWidget's on screen display

Constructor & Destructor Documentation

◆ HistogrammWidget()

icl::qt::HistogrammWidget::HistogrammWidget ( QWidget *  parent)

Base constructor with given parent widget.

Member Function Documentation

◆ setFeatures()

void icl::qt::HistogrammWidget::setFeatures ( bool  logOn,
bool  meanOn,
bool  medianOn,
int  selChannel 
)

sets all features

◆ updateData()

void icl::qt::HistogrammWidget::updateData ( const ImageStatistics s)

updates the histogramms

Member Data Documentation

◆ buf

std::vector<float> icl::qt::HistogrammWidget::buf

◆ logOn

bool icl::qt::HistogrammWidget::logOn

logarithmic mode

◆ meanOn

bool icl::qt::HistogrammWidget::meanOn

mean averaging

◆ medianOn

bool icl::qt::HistogrammWidget::medianOn

median filtering

◆ selChannel

int icl::qt::HistogrammWidget::selChannel

selected channel (or -1 for all)


The documentation for this struct was generated from the following file: