ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVHistogramChartRepresentation Class Reference

representation for "Histogram View". More...

#include <vtkPVHistogramChartRepresentation.h>

Inheritance diagram for vtkPVHistogramChartRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkPVHistogramChartRepresentation:
Collaboration graph
[legend]

Public Types

typedef vtkXYChartRepresentation Superclass
 
- Public Types inherited from vtkXYChartRepresentation
typedef vtkChartRepresentation Superclass
 
- Public Types inherited from vtkChartRepresentation
typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetHistogramColor (double r, double g, double b)
 Sets the color for the histograms. More...
 
void SetUseColorMapping (bool colorMapping)
 Sets the histogram to be color mapped by the scalar. More...
 
void SetLookupTable (vtkScalarsToColors *lut)
 Sets the lookup table that is used for color mapping by the scalar. More...
 
void SetHistogramLineStyle (int style)
 Set the line style for the histogram. More...
 
virtual vtkDataObject * TransformInputData (vtkInformationVector **inputVector, vtkDataObject *data)
 Method to be overrided to transform input data to a vtkTable. More...
 
virtual bool MapSelectionToInput (vtkSelection *)
 Overridden to transform id-based selection produced by the histogram view to a threshold-based selection. More...
 
virtual bool MapSelectionToView (vtkSelection *sel)
 Inverse of MapSelectionToInput(). More...
 
void SetComponent (int)
 Controls which input data component should be binned, for input arrays with more-than-one component. More...
 
int GetComponent ()
 Controls which input data component should be binned, for input arrays with more-than-one component. More...
 
void SetBinCount (int)
 Controls the number of bins N in the output histogram data. More...
 
int GetBinCount ()
 Controls the number of bins N in the output histogram data. More...
 
void SetCustomBinRanges (double min, double max)
 Get/Set custom bin ranges to use. More...
 
double * GetCustomBinRanges ()
 Get/Set custom bin ranges to use. More...
 
void SetUseCustomBinRanges (bool)
 When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...
 
bool GetUseCustomBinRanges ()
 When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Overload the vtkAlgorithm method to update after the change. More...
 
- Public Member Functions inherited from vtkXYChartRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetVisibility (bool visible)
 Set visibility of the representation. More...
 
void SetChartTypeToLine ()
 
void SetChartTypeToPoints ()
 
void SetChartTypeToBar ()
 
void SetChartTypeToStacked ()
 
void SetChartTypeToBag ()
 
void SetChartTypeToFunctionalBag ()
 
void SetChartTypeToArea ()
 
vtkChartXY * GetChart ()
 Returns the vtkChartXY instance from the view to which this representation is added. More...
 
void ClearSeriesVisibilities ()
 
void ClearLineThicknesses ()
 
void ClearLineStyles ()
 
void ClearColors ()
 
void ClearAxisCorners ()
 
void ClearMarkerStyles ()
 
void ClearLabels ()
 
virtual void SetSelectionColor (double, double, double)
 
virtual void SetSelectionColor (double [3])
 
virtual double * GetSelectionColor ()
 
virtual void GetSelectionColor (double &, double &, double &)
 
virtual void GetSelectionColor (double [3])
 
virtual bool Export (vtkCSVExporter *exporter)
 Called by vtkPVContextView::Export() to export the representation's data to a CSV file. More...
 
virtual void SetChartType (int)
 Get/Set the chart type, defaults to line chart. More...
 
virtual int GetChartType ()
 Get/Set the chart type, defaults to line chart. More...
 
virtual void SetXAxisSeriesName (const char *)
 Set the series to use as the X-axis. More...
 
virtual char * GetXAxisSeriesName ()
 Set the series to use as the X-axis. More...
 
virtual void SetUseIndexForXAxis (bool)
 Set whether the index should be used for the x axis. More...
 
virtual bool GetUseIndexForXAxis ()
 Set whether the index should be used for the x axis. More...
 
void SetSeriesVisibility (const char *seriesname, bool visible)
 Set/Clear the properties for Y series/columns. More...
 
void SetLineThickness (const char *name, int value)
 Set/Clear the properties for Y series/columns. More...
 
void SetLineStyle (const char *name, int value)
 Set/Clear the properties for Y series/columns. More...
 
void SetColor (const char *name, double r, double g, double b)
 Set/Clear the properties for Y series/columns. More...
 
void SetAxisCorner (const char *name, int corner)
 Set/Clear the properties for Y series/columns. More...
 
void SetMarkerStyle (const char *name, int style)
 Set/Clear the properties for Y series/columns. More...
 
void SetLabel (const char *name, const char *label)
 Set/Clear the properties for Y series/columns. More...
 
void SetUseColorMapping (const char *name, bool useColorMapping)
 Set/Clear the properties for Y series/columns. More...
 
void SetLookupTable (const char *name, vtkScalarsToColors *lut)
 Set/Clear the properties for Y series/columns. More...
 
const char * GetLabel (const char *name) const
 Set/Clear the properties for Y series/columns. More...
 
virtual void SetSeriesLabelPrefix (const char *)
 Get/Set the series label prefix. More...
 
virtual char * GetSeriesLabelPrefix ()
 Get/Set the series label prefix. More...
 
- Public Member Functions inherited from vtkChartRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetSelectionRepresentation (vtkChartSelectionRepresentation *)
 These must only be set during initialization before adding the representation to any views or calling Update(). More...
 
virtual void MarkModified ()
 This needs to be called on all instances of vtkGeometryRepresentation when the input is modified. More...
 
void SetCompositeDataSetIndex (unsigned int)
 
void AddCompositeDataSetIndex (unsigned int)
 
void ResetCompositeDataSetIndices ()
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Override because of internal selection representations that need to be initialized as well. More...
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
virtual vtkStdString GetDefaultSeriesLabel (const vtkStdString &tableName, const vtkStdString &columnName)
 Method to provide the default name given the name of a table and a column in that table. More...
 
virtual bool Export (vtkCSVExporter *vtkNotUsed(exporter))
 Called by vtkPVContextView::Export() to export the representation's data to a CSV file. More...
 
void SetFieldAssociation (int)
 Set the field association for arrays to use. More...
 
virtual int GetFieldAssociation ()
 Set the field association for arrays to use. More...
 
virtual void SetFlattenTable (int)
 Flatten the table, i.e. More...
 
virtual int GetFlattenTable ()
 Flatten the table, i.e. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned int GetUniqueIdentifier ()
 Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...
 
virtual bool GetVisibility ()
 
virtual vtkDataObject * GetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetForcedCacheKey (double val)
 Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...
 
virtual void SetForceUseCache (bool val)
 
bool GetUsingCacheForUpdate ()
 Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...
 
virtual bool GetNeedUpdate ()
 
virtual vtkAlgorithmOutput * GetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port, int conn)
 
vtkView * GetView () const
 Provides access to the view. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Set whether the UpdateTime is valid. More...
 
virtual void SetUseCache (bool)
 
virtual void SetCacheKey (double val)
 
virtual double GetCacheKey ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool GetUseCache ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 

Static Public Member Functions

static vtkPVHistogramChartRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVHistogramChartRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkXYChartRepresentation
static vtkXYChartRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkXYChartRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkChartRepresentation
static vtkChartRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkChartRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVHistogramChartRepresentation ()
 
 ~vtkPVHistogramChartRepresentation ()
 
virtual void PrepareForRendering ()
 This method is called before actual render if this->MTime was modified since the last time this method was called. More...
 
- Protected Member Functions inherited from vtkXYChartRepresentation
 vtkXYChartRepresentation ()
 
 ~vtkXYChartRepresentation ()
 
virtual bool RemoveFromView (vtkView *view)
 Overridden to remove all plots from the view. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Subclasses should override this to connect inputs to the internal pipeline as necessary. More...
 
- Protected Member Functions inherited from vtkChartRepresentation
 vtkChartRepresentation ()
 
 ~vtkChartRepresentation ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool IsCached (double cache_key)
 Overridden to check with the vtkPVCacheKeeper to see if the key is cached. More...
 
vtkTable * GetLocalOutput ()
 Convenience method to get the first vtkTable from LocalOutput, if any. More...
 
bool GetLocalOutput (MapOfTables &tables)
 Convenience method to get all vtkTable instances with their associated names. More...
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

vtkPExtractHistogramExtractHistogram
 
- Protected Attributes inherited from vtkXYChartRepresentation
vtkInternalsInternals
 
- Protected Attributes inherited from vtkChartRepresentation
int FieldAssociation
 
vtkPVCacheKeeperCacheKeeper
 
vtkWeakPointer< vtkPVContextViewContextView
 
bool EnableServerSideRendering
 
int FlattenTable
 
vtkSmartPointer< vtkMultiBlockDataSet > LocalOutput
 
std::set< unsigned int > CompositeIndices
 
vtkWeakPointer< vtkChartSelectionRepresentationSelectionRepresentation
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Additional Inherited Members

- Protected Types inherited from vtkChartRepresentation
typedef std::map< std::string, vtkSmartPointer< vtkTable > > MapOfTables
 

Detailed Description

representation for "Histogram View".

vtkPVHistogramChartRepresentation is the vtkPVDataRepresentation subclass for showing an data in the "Histogram View". The representation pipeline extracts histogram from the input dataset and then shows that in the view.

Definition at line 35 of file vtkPVHistogramChartRepresentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 40 of file vtkPVHistogramChartRepresentation.h.

Constructor & Destructor Documentation

§ vtkPVHistogramChartRepresentation()

vtkPVHistogramChartRepresentation::vtkPVHistogramChartRepresentation ( )
protected

§ ~vtkPVHistogramChartRepresentation()

vtkPVHistogramChartRepresentation::~vtkPVHistogramChartRepresentation ( )
protected

Member Function Documentation

§ New()

static vtkPVHistogramChartRepresentation* vtkPVHistogramChartRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtkPVHistogramChartRepresentation::GetClassName ( )
virtual

Reimplemented from vtkXYChartRepresentation.

§ IsTypeOf()

static int vtkPVHistogramChartRepresentation::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkPVHistogramChartRepresentation::IsA ( const char *  type)
virtual

Reimplemented from vtkXYChartRepresentation.

§ SafeDownCast()

static vtkPVHistogramChartRepresentation* vtkPVHistogramChartRepresentation::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

void vtkPVHistogramChartRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ SetComponent()

void vtkPVHistogramChartRepresentation::SetComponent ( int  )

Controls which input data component should be binned, for input arrays with more-than-one component.

§ GetComponent()

int vtkPVHistogramChartRepresentation::GetComponent ( )

Controls which input data component should be binned, for input arrays with more-than-one component.

§ SetBinCount()

void vtkPVHistogramChartRepresentation::SetBinCount ( int  )

Controls the number of bins N in the output histogram data.

§ GetBinCount()

int vtkPVHistogramChartRepresentation::GetBinCount ( )

Controls the number of bins N in the output histogram data.

§ SetCustomBinRanges()

void vtkPVHistogramChartRepresentation::SetCustomBinRanges ( double  min,
double  max 
)

Get/Set custom bin ranges to use.

These are used only when UseCustomBinRanges is set to true.

§ GetCustomBinRanges()

double* vtkPVHistogramChartRepresentation::GetCustomBinRanges ( )

Get/Set custom bin ranges to use.

These are used only when UseCustomBinRanges is set to true.

§ SetUseCustomBinRanges()

void vtkPVHistogramChartRepresentation::SetUseCustomBinRanges ( bool  )

When set to true, CustomBinRanges will be used instead of using the full range for the selected array.

By default, set to false.

§ GetUseCustomBinRanges()

bool vtkPVHistogramChartRepresentation::GetUseCustomBinRanges ( )

When set to true, CustomBinRanges will be used instead of using the full range for the selected array.

By default, set to false.

§ SetHistogramColor()

void vtkPVHistogramChartRepresentation::SetHistogramColor ( double  r,
double  g,
double  b 
)

Sets the color for the histograms.

§ SetUseColorMapping()

void vtkPVHistogramChartRepresentation::SetUseColorMapping ( bool  colorMapping)

Sets the histogram to be color mapped by the scalar.

§ SetLookupTable()

void vtkPVHistogramChartRepresentation::SetLookupTable ( vtkScalarsToColors *  lut)

Sets the lookup table that is used for color mapping by the scalar.

§ SetHistogramLineStyle()

void vtkPVHistogramChartRepresentation::SetHistogramLineStyle ( int  style)

Set the line style for the histogram.

§ TransformInputData()

virtual vtkDataObject* vtkPVHistogramChartRepresentation::TransformInputData ( vtkInformationVector **  inputVector,
vtkDataObject *  data 
)
virtual

Method to be overrided to transform input data to a vtkTable.

Reimplemented from vtkChartRepresentation.

§ SetInputArrayToProcess()

virtual void vtkPVHistogramChartRepresentation::SetInputArrayToProcess ( int  idx,
int  port,
int  connection,
int  fieldAssociation,
const char *  name 
)
virtual

Overload the vtkAlgorithm method to update after the change.

§ MapSelectionToInput()

virtual bool vtkPVHistogramChartRepresentation::MapSelectionToInput ( vtkSelection *  )
virtual

Overridden to transform id-based selection produced by the histogram view to a threshold-based selection.

Reimplemented from vtkChartRepresentation.

§ MapSelectionToView()

virtual bool vtkPVHistogramChartRepresentation::MapSelectionToView ( vtkSelection *  sel)
virtual

Inverse of MapSelectionToInput().

Reimplemented from vtkChartRepresentation.

§ PrepareForRendering()

virtual void vtkPVHistogramChartRepresentation::PrepareForRendering ( )
protectedvirtual

This method is called before actual render if this->MTime was modified since the last time this method was called.

Subclasses should override to update "appearance" related changes that don't affect data. When this method is called, you're assured that this->ContextView is valid. Note that this method will not be called if this->GetVisibility() returns false, this subclasses should also override SetVisibility() to hide "actors" and such.

Reimplemented from vtkXYChartRepresentation.

Member Data Documentation

§ ExtractHistogram

vtkPExtractHistogram* vtkPVHistogramChartRepresentation::ExtractHistogram
protected

Definition at line 130 of file vtkPVHistogramChartRepresentation.h.


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