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

Extract histogram data (binned values) from any dataset. More...

#include <vtkExtractHistogram.h>

Inheritance diagram for vtkExtractHistogram:
Inheritance graph
[legend]

Public Types

typedef vtkTableAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetComponent (int)
 Controls which input data component should be binned, for input arrays with more-than-one component. More...
 
virtual int GetComponent ()
 Controls which input data component should be binned, for input arrays with more-than-one component. More...
 
virtual void SetBinCount (int)
 Controls the number of bins N in the output histogram data. More...
 
virtual int GetBinCount ()
 Controls the number of bins N in the output histogram data. More...
 
virtual void SetCustomBinRanges (double, double)
 Get/Set custom bin ranges to use. More...
 
void SetCustomBinRanges (double [2])
 Get/Set custom bin ranges to use. More...
 
virtual double * GetCustomBinRanges ()
 Get/Set custom bin ranges to use. More...
 
virtual void GetCustomBinRanges (double &, double &)
 Get/Set custom bin ranges to use. More...
 
virtual void GetCustomBinRanges (double [2])
 Get/Set custom bin ranges to use. More...
 
virtual void SetUseCustomBinRanges (bool)
 When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...
 
virtual bool GetUseCustomBinRanges ()
 When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...
 
virtual void UseCustomBinRangesOn ()
 When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...
 
virtual void UseCustomBinRangesOff ()
 When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...
 
virtual void SetCalculateAverages (int)
 This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. More...
 
virtual int GetCalculateAverages ()
 This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. More...
 
virtual void CalculateAveragesOn ()
 This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. More...
 
virtual void CalculateAveragesOff ()
 This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. More...
 

Static Public Member Functions

static vtkExtractHistogramNew ()
 
static int IsTypeOf (const char *type)
 
static vtkExtractHistogramSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkExtractHistogram ()
 
 ~vtkExtractHistogram ()
 
virtual bool GetInputArrayRange (vtkInformationVector **inputVector, double range[2])
 Returns the data range for the input array to process. More...
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual bool InitializeBinExtents (vtkInformationVector **inputVector, vtkDoubleArray *bin_extents, double &min, double &max)
 
void BinAnArray (vtkDataArray *src, vtkIntArray *vals, double min, double max, vtkFieldData *field)
 
void FillBinExtents (vtkDoubleArray *bin_extents, double min, double max)
 

Protected Attributes

double CustomBinRanges [2]
 
bool UseCustomBinRanges
 
int Component
 
int BinCount
 
int CalculateAverages
 
vtkEHInternals * Internal
 

Detailed Description

Extract histogram data (binned values) from any dataset.

vtkExtractHistogram accepts any vtkDataSet as input and produces a vtkPolyData containing histogram data as output. The output vtkPolyData will have contain a vtkDoubleArray named "bin_extents" which contains the boundaries between each histogram bin, and a vtkUnsignedLongArray named "bin_values" which will contain the value for each bin.

Definition at line 38 of file vtkExtractHistogram.h.

Member Typedef Documentation

§ Superclass

typedef vtkTableAlgorithm vtkExtractHistogram::Superclass

Definition at line 42 of file vtkExtractHistogram.h.

Constructor & Destructor Documentation

§ vtkExtractHistogram()

vtkExtractHistogram::vtkExtractHistogram ( )
protected

§ ~vtkExtractHistogram()

vtkExtractHistogram::~vtkExtractHistogram ( )
protected

Member Function Documentation

§ New()

static vtkExtractHistogram* vtkExtractHistogram::New ( )
static

§ GetClassName()

virtual const char* vtkExtractHistogram::GetClassName ( )
virtual

Reimplemented in vtkPExtractHistogram.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented in vtkPExtractHistogram.

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetComponent()

virtual void vtkExtractHistogram::SetComponent ( int  )
virtual

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

§ GetComponent()

virtual int vtkExtractHistogram::GetComponent ( )
virtual

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

§ SetBinCount()

virtual void vtkExtractHistogram::SetBinCount ( int  )
virtual

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

§ GetBinCount()

virtual int vtkExtractHistogram::GetBinCount ( )
virtual

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

§ SetCustomBinRanges() [1/2]

virtual void vtkExtractHistogram::SetCustomBinRanges ( double  ,
double   
)
virtual

Get/Set custom bin ranges to use.

These are used only when UseCustomBinRanges is set to true.

§ SetCustomBinRanges() [2/2]

void vtkExtractHistogram::SetCustomBinRanges ( double  [2])

Get/Set custom bin ranges to use.

These are used only when UseCustomBinRanges is set to true.

§ GetCustomBinRanges() [1/3]

virtual double* vtkExtractHistogram::GetCustomBinRanges ( )
virtual

Get/Set custom bin ranges to use.

These are used only when UseCustomBinRanges is set to true.

§ GetCustomBinRanges() [2/3]

virtual void vtkExtractHistogram::GetCustomBinRanges ( double &  ,
double &   
)
virtual

Get/Set custom bin ranges to use.

These are used only when UseCustomBinRanges is set to true.

§ GetCustomBinRanges() [3/3]

virtual void vtkExtractHistogram::GetCustomBinRanges ( double  [2])
virtual

Get/Set custom bin ranges to use.

These are used only when UseCustomBinRanges is set to true.

§ SetUseCustomBinRanges()

virtual void vtkExtractHistogram::SetUseCustomBinRanges ( bool  )
virtual

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

By default, set to false.

§ GetUseCustomBinRanges()

virtual bool vtkExtractHistogram::GetUseCustomBinRanges ( )
virtual

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

By default, set to false.

§ UseCustomBinRangesOn()

virtual void vtkExtractHistogram::UseCustomBinRangesOn ( )
virtual

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

By default, set to false.

§ UseCustomBinRangesOff()

virtual void vtkExtractHistogram::UseCustomBinRangesOff ( )
virtual

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

By default, set to false.

§ SetCalculateAverages()

virtual void vtkExtractHistogram::SetCalculateAverages ( int  )
virtual

This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin.

False by default.

§ GetCalculateAverages()

virtual int vtkExtractHistogram::GetCalculateAverages ( )
virtual

This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin.

False by default.

§ CalculateAveragesOn()

virtual void vtkExtractHistogram::CalculateAveragesOn ( )
virtual

This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin.

False by default.

§ CalculateAveragesOff()

virtual void vtkExtractHistogram::CalculateAveragesOff ( )
virtual

This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin.

False by default.

§ GetInputArrayRange()

virtual bool vtkExtractHistogram::GetInputArrayRange ( vtkInformationVector **  inputVector,
double  range[2] 
)
protectedvirtual

Returns the data range for the input array to process.

This method is not called with this->UseCustomBinRanges is true. Returns true is range could be determined correctly, otherwise returns false and range is set to {VTK_DOUBLE_MAX, VTK_DOUBLE_MIN}. When returning true, the actual data range is returned (without any extra padding).

Reimplemented in vtkPExtractHistogram.

§ FillInputPortInformation()

virtual int vtkExtractHistogram::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

§ RequestData()

virtual int vtkExtractHistogram::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Reimplemented in vtkPExtractHistogram.

§ InitializeBinExtents()

virtual bool vtkExtractHistogram::InitializeBinExtents ( vtkInformationVector **  inputVector,
vtkDoubleArray *  bin_extents,
double &  min,
double &  max 
)
protectedvirtual

§ BinAnArray()

void vtkExtractHistogram::BinAnArray ( vtkDataArray *  src,
vtkIntArray *  vals,
double  min,
double  max,
vtkFieldData *  field 
)
protected

§ FillBinExtents()

void vtkExtractHistogram::FillBinExtents ( vtkDoubleArray *  bin_extents,
double  min,
double  max 
)
protected

Member Data Documentation

§ CustomBinRanges

double vtkExtractHistogram::CustomBinRanges[2]
protected

Definition at line 120 of file vtkExtractHistogram.h.

§ UseCustomBinRanges

bool vtkExtractHistogram::UseCustomBinRanges
protected

Definition at line 121 of file vtkExtractHistogram.h.

§ Component

int vtkExtractHistogram::Component
protected

Definition at line 122 of file vtkExtractHistogram.h.

§ BinCount

int vtkExtractHistogram::BinCount
protected

Definition at line 123 of file vtkExtractHistogram.h.

§ CalculateAverages

int vtkExtractHistogram::CalculateAverages
protected

Definition at line 124 of file vtkExtractHistogram.h.

§ Internal

vtkEHInternals* vtkExtractHistogram::Internal
protected

Definition at line 126 of file vtkExtractHistogram.h.


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