Compute statistics for an image. More...

#include <vtkImageHistogramStatistics.h>

Inheritance diagram for vtkImageHistogramStatistics:

Collaboration diagram for vtkImageHistogramStatistics:

Public Types
typedef vtkImageHistogram	Superclass

Public Types inherited from vtkImageHistogram
typedef vtkThreadedImageAlgorithm	Superclass

enum	{ Linear = 0, Log = 1, Sqrt = 2 }

Public Types inherited from vtkThreadedImageAlgorithm
typedef vtkImageAlgorithm	Superclass

Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkImageHistogramStatistics *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

double	GetMinimum ()

double	GetMaximum ()

double	GetMean ()

double	GetMedian ()

double	GetStandardDeviation ()


virtual void	SetAutoRangePercentiles (double, double)

void	SetAutoRangePercentiles (double[2])

virtual double *	GetAutoRangePercentiles ()

virtual void	GetAutoRangePercentiles (double &, double &)

virtual void	GetAutoRangePercentiles (double[2])


virtual void	SetAutoRangeExpansionFactors (double, double)

void	SetAutoRangeExpansionFactors (double[2])

virtual double *	GetAutoRangeExpansionFactors ()

virtual void	GetAutoRangeExpansionFactors (double &, double &)

virtual void	GetAutoRangeExpansionFactors (double[2])


virtual double *	GetAutoRange ()

virtual void	GetAutoRange (double &, double &)

virtual void	GetAutoRange (double[2])

Public Member Functions inherited from vtkImageHistogram
vtkImageHistogram *	NewInstance () const

void	SetStencilConnection (vtkAlgorithmOutput *algOutput)

vtkIdTypeArray *	GetHistogram ()

vtkIdType	GetTotal ()

virtual void	SetActiveComponent (int)

virtual int	GetActiveComponent ()

virtual void	SetAutomaticBinning (int)

virtual void	AutomaticBinningOn ()

virtual void	AutomaticBinningOff ()

virtual int	GetAutomaticBinning ()

virtual void	SetMaximumNumberOfBins (int)

virtual int	GetMaximumNumberOfBins ()

virtual void	SetNumberOfBins (int)

virtual int	GetNumberOfBins ()

virtual void	SetBinOrigin (double)

virtual double	GetBinOrigin ()

virtual void	SetBinSpacing (double)

virtual double	GetBinSpacing ()

void	SetStencilData (vtkImageStencilData *stencil)

vtkImageStencilData *	GetStencil ()

virtual void	SetGenerateHistogramImage (int)

virtual void	GenerateHistogramImageOn ()

virtual void	GenerateHistogramImageOff ()

virtual int	GetGenerateHistogramImage ()

virtual void	SetHistogramImageSize (int, int)

void	SetHistogramImageSize (int[2])

virtual int *	GetHistogramImageSize ()

virtual void	GetHistogramImageSize (int &, int &)

virtual void	GetHistogramImageSize (int[2])

virtual void	SetHistogramImageScale (int)

void	SetHistogramImageScaleToLinear ()

void	SetHistogramImageScaleToLog ()

void	SetHistogramImageScaleToSqrt ()

virtual int	GetHistogramImageScale ()

const char *	GetHistogramImageScaleAsString ()

virtual void	ThreadedRequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector, vtkImageData *inData, vtkImageData outData, int ext[6], int id)

Public Member Functions inherited from vtkThreadedImageAlgorithm
vtkThreadedImageAlgorithm *	NewInstance () const

virtual void	ThreadedExecute (vtkImageData inData, vtkImageData outData, int extent[6], int threadId)

virtual void	SetNumberOfThreads (int)

virtual int	GetNumberOfThreads ()

virtual int	SplitExtent (int splitExt[6], int startExt[6], int num, int total)

Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const

vtkImageData *	GetOutput ()

vtkImageData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetInput ()

vtkImageData *	GetImageDataInput (int port)

virtual void	AddInputData (vtkDataObject *)

virtual void	AddInputData (int, vtkDataObject *)

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

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

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

void	SetUpdateExtent (int extent[6])

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
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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 )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkImageHistogramStatistics *	New ()

static int	IsTypeOf (const char *type)

static vtkImageHistogramStatistics *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkImageHistogram
static vtkImageHistogram *	New ()

static int	IsTypeOf (const char *type)

static vtkImageHistogram *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkThreadedImageAlgorithm
static int	IsTypeOf (const char *type)

static vtkThreadedImageAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkImageAlgorithm
static int	IsTypeOf (const char *type)

static vtkImageAlgorithm *	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 int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImageHistogramStatistics ()

	~vtkImageHistogramStatistics ()

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkImageHistogram
virtual int	RequestUpdateExtent (vtkInformation vtkNotUsed(request), vtkInformationVector inInfo, vtkInformationVector vtkNotUsed(outInfo))

virtual int	RequestInformation (vtkInformation vtkNotUsed(request), vtkInformationVector inInfo, vtkInformationVector vtkNotUsed(outInfo))

virtual int	FillInputPortInformation (int port, vtkInformation *info)

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

void	ComputeImageScalarRange (vtkImageData *data, double range[2])

	vtkImageHistogram ()

	~vtkImageHistogram ()

Protected Member Functions inherited from vtkThreadedImageAlgorithm
	vtkThreadedImageAlgorithm ()

	~vtkThreadedImageAlgorithm ()

Protected Member Functions inherited from vtkImageAlgorithm
	vtkImageAlgorithm ()

	~vtkImageAlgorithm ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual void	CopyInputArrayAttributesToOutput (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	ExecuteDataWithInformation (vtkDataObject output, vtkInformation outInfo)

virtual void	ExecuteData (vtkDataObject *output)

virtual void	Execute ()

virtual void	AllocateOutputData (vtkImageData out, vtkInformation outInfo, int *uExtent)

virtual vtkImageData *	AllocateOutputData (vtkDataObject out, vtkInformation outInfo)

virtual void	CopyAttributeData (vtkImageData in, vtkImageData out, vtkInformationVector **inputVector)

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

virtual void	ReportReferences (vtkGarbageCollector *)

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)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

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	Minimum

double	Maximum

double	Mean

double	StandardDeviation

double	Median

double	AutoRange [2]

double	AutoRangePercentiles [2]

double	AutoRangeExpansionFactors [2]

Protected Attributes inherited from vtkImageHistogram
int	ActiveComponent

int	AutomaticBinning

int	MaximumNumberOfBins

int	HistogramImageSize [2]

int	HistogramImageScale

int	GenerateHistogramImage

int	NumberOfBins

double	BinOrigin

double	BinSpacing

vtkIdTypeArray *	Histogram

vtkIdType	Total

vtkIdType *	ThreadOutput [VTK_MAX_THREADS]

int	ThreadBinRange [VTK_MAX_THREADS][2]

Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreader *	Threader

int	NumberOfThreads

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

Compute statistics for an image.

vtkImageHistogramStatistics computes statistics such as mean, median, and standard deviation. These statistics are computed from the histogram of the image, rather than from the image itself, because this is more efficient than computing the statistics while traversing the pixels. If the input image is of type float or double, then the precision of the Mean, Median, and StandardDeviation will depend on the number of histogram bins. By default, 65536 bins are used for float data, giving at least 16 bits of precision.

Thanks:: Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.

Tests:: vtkImageHistogramStatistics (Tests)

Definition at line 43 of file vtkImageHistogramStatistics.h.

Member Typedef Documentation

typedef vtkImageHistogram vtkImageHistogramStatistics::Superclass

Definition at line 47 of file vtkImageHistogramStatistics.h.

Constructor & Destructor Documentation

vtkImageHistogramStatistics::vtkImageHistogramStatistics ( )

protected

vtkImageHistogramStatistics::~vtkImageHistogramStatistics ( )

protected

Member Function Documentation

static vtkImageHistogramStatistics* vtkImageHistogramStatistics::New ( )

static

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

static

virtual int vtkImageHistogramStatistics::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageHistogram.

static vtkImageHistogramStatistics* vtkImageHistogramStatistics::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkImageHistogramStatistics::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageHistogram.

vtkImageHistogramStatistics* vtkImageHistogramStatistics::NewInstance ( ) const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageHistogram.

double vtkImageHistogramStatistics::GetMinimum ( )

inline

Get the minimum value present in the image. This value is computed when Update() is called.

Definition at line 53 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::GetMaximum ( )

inline

Get the maximum value present in the image. This value is computed when Update() is called.

Definition at line 57 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::GetMean ( )

inline

Get the mean value of the image. This value is computed when Update() is called.

Definition at line 61 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::GetMedian ( )

inline

Get the median value. This is computed when Update() is called.

Definition at line 64 of file vtkImageHistogramStatistics.h.

double vtkImageHistogramStatistics::GetStandardDeviation ( )

inline

Get the standard deviation of the values in the image. This is computed when Update() is called.

Definition at line 68 of file vtkImageHistogramStatistics.h.

virtual void vtkImageHistogramStatistics::SetAutoRangePercentiles	(	double	,
		double
	)

virtual