vtkExtractHistogram Class Reference

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

#include <vtkExtractHistogram.h>

Inheritance diagram for vtkExtractHistogram:

Collaboration diagram for vtkExtractHistogram:

Public Types
typedef vtkTableAlgorithm	Superclass
Public Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision
enum	DesiredOutputPrecision
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
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	SetCenterBinsAroundMinAndMax (bool)
	Get/Set if first and last bins must be centered around the min and max data. More...
virtual bool	GetCenterBinsAroundMinAndMax ()
	Get/Set if first and last bins must be centered around the min and max data. More...
virtual void	CenterBinsAroundMinAndMaxOn ()
	Get/Set if first and last bins must be centered around the min and max data. More...
virtual void	CenterBinsAroundMinAndMaxOff ()
	Get/Set if first and last bins must be centered around the min and max 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...
Public Member Functions inherited from vtkTableAlgorithm
vtkTableAlgorithm *	NewInstance () const
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkTable *	GetOutput ()
vtkTable *	GetOutput (int index)
void	SetInputData (vtkDataObject *obj)
void	SetInputData (int index, vtkDataObject *obj)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkTable *	GetOutput ()
vtkTable *	GetOutput (int index)
void	SetInputData (vtkDataObject *obj)
void	SetInputData (int index, vtkDataObject *obj)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual int	Update (int port, vtkInformationVector *requests)
virtual int	Update (vtkInformation *requests)
virtual int	UpdateExtent (const int extents[6])
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
void	SetUpdateExtent (int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
void	Register (vtkObjectBase *o) VTK_OVERRIDE
void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
void	Register (vtkObjectBase *o) VTK_OVERRIDE
void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkExtractHistogram *	New ()
static int	IsTypeOf (const char *type)
static vtkExtractHistogram *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkTableAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkExtractHistogram ()
	~vtkExtractHistogram () override
virtual bool	GetInputArrayRange (vtkInformationVector **inputVector, double range[2])
	Returns the data range for the input array to process. More...
int	FillInputPortInformation (int port, vtkInformation *info) override
int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
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 Member Functions inherited from vtkTableAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTableAlgorithm ()
	~vtkTableAlgorithm ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetErrorCode (unsigned long)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	CustomBinRanges [2]
bool	CenterBinsAroundMinAndMax
bool	UseCustomBinRanges
int	Component
int	BinCount
int	CalculateAverages
vtkEHInternals *	Internal
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
	SINGLE_PRECISION
	DOUBLE_PRECISION
	DEFAULT_PRECISION
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 ( )

overrideprotected

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 from vtkTableAlgorithm.

Reimplemented in vtkPExtractHistogram.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPExtractHistogram.

SetComponent()

virtual void vtkExtractHistogram::SetComponent ( int  )

virtual

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

Setting this to the number of components will compute the histogram of the magnitude (L2 norm) of the tuple.

GetComponent()

virtual int vtkExtractHistogram::GetComponent ( )

virtual

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

Setting this to the number of components will compute the histogram of the magnitude (L2 norm) of the tuple.

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.

SetCenterBinsAroundMinAndMax()

virtual void vtkExtractHistogram::SetCenterBinsAroundMinAndMax ( bool  )

virtual

Get/Set if first and last bins must be centered around the min and max data.

This is only used when UseCustomBinRanges is set to false. Default is false.

GetCenterBinsAroundMinAndMax()

virtual bool vtkExtractHistogram::GetCenterBinsAroundMinAndMax ( )

virtual

Get/Set if first and last bins must be centered around the min and max data.

This is only used when UseCustomBinRanges is set to false. Default is false.

CenterBinsAroundMinAndMaxOn()

virtual void vtkExtractHistogram::CenterBinsAroundMinAndMaxOn ( )

virtual

Get/Set if first and last bins must be centered around the min and max data.

This is only used when UseCustomBinRanges is set to false. Default is false.

CenterBinsAroundMinAndMaxOff()

virtual void vtkExtractHistogram::CenterBinsAroundMinAndMaxOff ( )

virtual

Get/Set if first and last bins must be centered around the min and max data.

This is only used when UseCustomBinRanges is set to false. Default is false.

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()

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

overrideprotectedvirtual

Reimplemented from vtkTableAlgorithm.

RequestData()

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

overrideprotectedvirtual

Reimplemented from vtkTableAlgorithm.

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 132 of file vtkExtractHistogram.h.

CenterBinsAroundMinAndMax

bool vtkExtractHistogram::CenterBinsAroundMinAndMax

protected

Definition at line 133 of file vtkExtractHistogram.h.

UseCustomBinRanges

bool vtkExtractHistogram::UseCustomBinRanges

protected

Definition at line 134 of file vtkExtractHistogram.h.

Component

int vtkExtractHistogram::Component

protected

Definition at line 135 of file vtkExtractHistogram.h.

BinCount

int vtkExtractHistogram::BinCount

protected

Definition at line 136 of file vtkExtractHistogram.h.

CalculateAverages

int vtkExtractHistogram::CalculateAverages

protected

Definition at line 137 of file vtkExtractHistogram.h.

Internal

vtkEHInternals* vtkExtractHistogram::Internal

protected

Definition at line 139 of file vtkExtractHistogram.h.

---

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

• /home/paraview/VTKExtensions/Misc/vtkExtractHistogram.h