VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageHistogram Class Reference

Compute the histogram for an image. More...

#include <vtkImageHistogram.h>

Inheritance diagram for vtkImageHistogram:
[legend]
Collaboration diagram for vtkImageHistogram:
[legend]

Public Types

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)
 
vtkImageHistogramNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetStencilConnection (vtkAlgorithmOutput *algOutput)
 
vtkIdTypeArrayGetHistogram ()
 
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)
 
vtkImageStencilDataGetStencil ()
 
virtual void SetGenerateHistogramImage (int)
 
virtual void GenerateHistogramImageOn ()
 
virtual void GenerateHistogramImageOff ()
 
virtual int GetGenerateHistogramImage ()
 
virtual void SetHistogramImageSize (int, int)
 
void SetHistogramImageSize (int[2])
 
virtual intGetHistogramImageSize ()
 
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 ()
 
- Public Member Functions inherited from vtkThreadedImageAlgorithm
vtkThreadedImageAlgorithmNewInstance () 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
vtkImageAlgorithmNewInstance () const
 
vtkImageDataGetOutput ()
 
vtkImageDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkImageDataGetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 
virtual void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformationGetInputInformation (int port, int index)
 
vtkInformationGetOutputInformation (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 vtkInformationGetInformation ()
 
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)
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
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])
 
intGetUpdateExtent ()
 
intGetUpdateExtent (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 vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
vtkCommandGetCommand (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 vtkImageHistogramNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageHistogramSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkThreadedImageAlgorithm
static int IsTypeOf (const char *type)
 
static vtkThreadedImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static int IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
virtual int RequestUpdateExtent (vtkInformation *vtkNotUsed(request), vtkInformationVector **inInfo, vtkInformationVector *vtkNotUsed(outInfo))
 
virtual int RequestInformation (vtkInformation *vtkNotUsed(request), vtkInformationVector **inInfo, vtkInformationVector *vtkNotUsed(outInfo))
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
void ComputeImageScalarRange (vtkImageData *data, double range[2])
 
- 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 vtkImageDataAllocateOutputData (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 vtkExecutiveCreateDefaultExecutive ()
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (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

int ActiveComponent
 
int AutomaticBinning
 
int MaximumNumberOfBins
 
int HistogramImageSize [2]
 
int HistogramImageScale
 
int GenerateHistogramImage
 
int NumberOfBins
 
double BinOrigin
 
double BinSpacing
 
vtkIdTypeArrayHistogram
 
vtkIdType Total
 
vtkIdTypeThreadOutput [VTK_MAX_THREADS]
 
int ThreadBinRange [VTK_MAX_THREADS][2]
 
- Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreaderThreader
 
int NumberOfThreads
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
virtual void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id)
 
 vtkImageHistogram ()
 
 ~vtkImageHistogram ()
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Compute the histogram for an image.

vtkImageHistogram generates a histogram from its input, and optionally produces a 2D black-and-white image of the histogram as its output. Unlike the class vtkImageAccumulate, a multi-component image does not result in a multi-dimensional histogram. Instead, the resulting histogram will be the sum of the histograms of each of the individual components, unless SetActiveComponent is used to choose a single component.

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:
vtkImageHistogram (Tests)

Definition at line 42 of file vtkImageHistogram.h.

Member Typedef Documentation

Definition at line 46 of file vtkImageHistogram.h.

Member Enumeration Documentation

anonymous enum

Scale types for the histogram image.

Enumerator
Linear 
Log 
Sqrt 

Definition at line 52 of file vtkImageHistogram.h.

Constructor & Destructor Documentation

vtkImageHistogram::vtkImageHistogram ( )
protected

This is part of the executive, but is public so that it can be accessed by non-member functions.

vtkImageHistogram::~vtkImageHistogram ( )
protected

This is part of the executive, but is public so that it can be accessed by non-member functions.

Member Function Documentation

static vtkImageHistogram* vtkImageHistogram::New ( )
static
static int vtkImageHistogram::IsTypeOf ( const char *  type)
static
virtual int vtkImageHistogram::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 vtkThreadedImageAlgorithm.

Reimplemented in vtkImageHistogramStatistics.

static vtkImageHistogram* vtkImageHistogram::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkImageHistogram::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkThreadedImageAlgorithm.

Reimplemented in vtkImageHistogramStatistics.

vtkImageHistogram* vtkImageHistogram::NewInstance ( ) const
void vtkImageHistogram::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 vtkThreadedImageAlgorithm.

Reimplemented in vtkImageHistogramStatistics.

virtual void vtkImageHistogram::SetActiveComponent ( int  )
virtual

Set the component for which to generate a histogram. The default value is -1, which produces a histogram that is the sum of the histograms of the individual components.

virtual int vtkImageHistogram::GetActiveComponent ( )
virtual

Set the component for which to generate a histogram. The default value is -1, which produces a histogram that is the sum of the histograms of the individual components.

virtual void vtkImageHistogram::SetAutomaticBinning ( int  )
virtual

If this is On, then the histogram binning will be done automatically. For char and unsigned char data, there will be 256 bins with unit spacing. For data of type short and larger, there will be between 256 and MaximumNumberOfBins, depending on the range of the data, and the BinOrigin will be set to zero if no negative values are present, or to the smallest negative value if negative values are present. For float data, the MaximumNumberOfBins will always be used. The BinOrigin and BinSpacing will be set so that they provide a mapping from bin index to scalar value.

virtual void vtkImageHistogram::AutomaticBinningOn ( )
virtual

If this is On, then the histogram binning will be done automatically. For char and unsigned char data, there will be 256 bins with unit spacing. For data of type short and larger, there will be between 256 and MaximumNumberOfBins, depending on the range of the data, and the BinOrigin will be set to zero if no negative values are present, or to the smallest negative value if negative values are present. For float data, the MaximumNumberOfBins will always be used. The BinOrigin and BinSpacing will be set so that they provide a mapping from bin index to scalar value.

virtual void vtkImageHistogram::AutomaticBinningOff ( )
virtual

If this is On, then the histogram binning will be done automatically. For char and unsigned char data, there will be 256 bins with unit spacing. For data of type short and larger, there will be between 256 and MaximumNumberOfBins, depending on the range of the data, and the BinOrigin will be set to zero if no negative values are present, or to the smallest negative value if negative values are present. For float data, the MaximumNumberOfBins will always be used. The BinOrigin and BinSpacing will be set so that they provide a mapping from bin index to scalar value.

virtual int vtkImageHistogram::GetAutomaticBinning ( )
virtual

If this is On, then the histogram binning will be done automatically. For char and unsigned char data, there will be 256 bins with unit spacing. For data of type short and larger, there will be between 256 and MaximumNumberOfBins, depending on the range of the data, and the BinOrigin will be set to zero if no negative values are present, or to the smallest negative value if negative values are present. For float data, the MaximumNumberOfBins will always be used. The BinOrigin and BinSpacing will be set so that they provide a mapping from bin index to scalar value.

virtual void vtkImageHistogram::SetMaximumNumberOfBins ( int  )
virtual

The maximum number of bins to use when AutomaticBinning is On. When AutomaticBinning is On, the size of the output histogram will be set to the full range of the input data values, unless the full range is greater than this value. By default, the max value is 65536, which is large enough to capture the full range of 16-bit integers.

virtual int vtkImageHistogram::GetMaximumNumberOfBins ( )
virtual

The maximum number of bins to use when AutomaticBinning is On. When AutomaticBinning is On, the size of the output histogram will be set to the full range of the input data values, unless the full range is greater than this value. By default, the max value is 65536, which is large enough to capture the full range of 16-bit integers.

virtual void vtkImageHistogram::SetNumberOfBins ( int  )
virtual

The number of bins in histogram (default 256). This is automatically computed unless AutomaticBinning is Off.

virtual int vtkImageHistogram::GetNumberOfBins ( )
virtual

The number of bins in histogram (default 256). This is automatically computed unless AutomaticBinning is Off.

virtual void vtkImageHistogram::SetBinOrigin ( double  )
virtual

The value for the center of the first bin (default 0). This is automatically computed unless AutomaticBinning is Off.

virtual double vtkImageHistogram::GetBinOrigin ( )
virtual

The value for the center of the first bin (default 0). This is automatically computed unless AutomaticBinning is Off.

virtual void vtkImageHistogram::SetBinSpacing ( double  )
virtual

The bin spacing (default 1). This is automatically computed unless AutomaticBinning is Off.

virtual double vtkImageHistogram::GetBinSpacing ( )
virtual

The bin spacing (default 1). This is automatically computed unless AutomaticBinning is Off.

void vtkImageHistogram::SetStencilData ( vtkImageStencilData stencil)

Use a stencil to compute the histogram for just a part of the image.

vtkImageStencilData* vtkImageHistogram::GetStencil ( )

Use a stencil to compute the histogram for just a part of the image.

void vtkImageHistogram::SetStencilConnection ( vtkAlgorithmOutput algOutput)

Equivalent to SetInputConnection(1, algOutput).

virtual void vtkImageHistogram::SetGenerateHistogramImage ( int  )
virtual

If this is On, then a histogram image will be produced as the output. Regardless of this setting, the histogram is always available as a vtkIdTypeArray from the GetHistogram method.

virtual void vtkImageHistogram::GenerateHistogramImageOn ( )
virtual

If this is On, then a histogram image will be produced as the output. Regardless of this setting, the histogram is always available as a vtkIdTypeArray from the GetHistogram method.

virtual void vtkImageHistogram::GenerateHistogramImageOff ( )
virtual

If this is On, then a histogram image will be produced as the output. Regardless of this setting, the histogram is always available as a vtkIdTypeArray from the GetHistogram method.

virtual int vtkImageHistogram::GetGenerateHistogramImage ( )
virtual

If this is On, then a histogram image will be produced as the output. Regardless of this setting, the histogram is always available as a vtkIdTypeArray from the GetHistogram method.

virtual void vtkImageHistogram::SetHistogramImageSize ( int  ,
int   
)
virtual

Set the size of the histogram image that is produced as output. The default is 256 by 256.

void vtkImageHistogram::SetHistogramImageSize ( int  [2])

Set the size of the histogram image that is produced as output. The default is 256 by 256.

virtual int* vtkImageHistogram::GetHistogramImageSize ( )
virtual

Set the size of the histogram image that is produced as output. The default is 256 by 256.

virtual void vtkImageHistogram::GetHistogramImageSize ( int ,
int  
)
virtual

Set the size of the histogram image that is produced as output. The default is 256 by 256.

virtual void vtkImageHistogram::GetHistogramImageSize ( int  [2])
virtual

Set the size of the histogram image that is produced as output. The default is 256 by 256.

virtual void vtkImageHistogram::SetHistogramImageScale ( int  )
virtual

Set the scale to use for the histogram image. The default is a linear scale, but sqrt and log provide better visualization.

void vtkImageHistogram::SetHistogramImageScaleToLinear ( )
inline

Set the scale to use for the histogram image. The default is a linear scale, but sqrt and log provide better visualization.

Definition at line 143 of file vtkImageHistogram.h.

void vtkImageHistogram::SetHistogramImageScaleToLog ( )
inline

Set the scale to use for the histogram image. The default is a linear scale, but sqrt and log provide better visualization.

Definition at line 145 of file vtkImageHistogram.h.

void vtkImageHistogram::SetHistogramImageScaleToSqrt ( )
inline

Set the scale to use for the histogram image. The default is a linear scale, but sqrt and log provide better visualization.

Definition at line 147 of file vtkImageHistogram.h.

virtual int vtkImageHistogram::GetHistogramImageScale ( )
virtual

Set the scale to use for the histogram image. The default is a linear scale, but sqrt and log provide better visualization.

const char* vtkImageHistogram::GetHistogramImageScaleAsString ( )

Set the scale to use for the histogram image. The default is a linear scale, but sqrt and log provide better visualization.

vtkIdTypeArray* vtkImageHistogram::GetHistogram ( )

Get the histogram as a vtkIdTypeArray. You must call Update() before calling this method.

vtkIdType vtkImageHistogram::GetTotal ( )
inline

Get the total count of the histogram. This will be the number of voxels times the number of components.

Definition at line 159 of file vtkImageHistogram.h.

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

This is part of the executive, but is public so that it can be accessed by non-member functions.

Reimplemented from vtkThreadedImageAlgorithm.

virtual int vtkImageHistogram::RequestUpdateExtent ( vtkInformation vtkNotUsedrequest,
vtkInformationVector **  inInfo,
vtkInformationVector vtkNotUsedoutInfo 
)
protectedvirtual
virtual int vtkImageHistogram::RequestInformation ( vtkInformation vtkNotUsedrequest,
vtkInformationVector **  inInfo,
vtkInformationVector vtkNotUsedoutInfo 
)
protectedvirtual
virtual int vtkImageHistogram::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkThreadedImageAlgorithm.

Reimplemented in vtkImageHistogramStatistics.

virtual int vtkImageHistogram::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

These method should be reimplemented by subclasses that have more than a single input or single output. See vtkAlgorithm for more information.

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageHistogram::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

These method should be reimplemented by subclasses that have more than a single input or single output. See vtkAlgorithm for more information.

Reimplemented from vtkImageAlgorithm.

void vtkImageHistogram::ComputeImageScalarRange ( vtkImageData data,
double  range[2] 
)
protected

Compute the range of the data. The GetScalarRange() function of vtkImageData only computes the range of the first component, but this filter requires the range for all components.

Member Data Documentation

int vtkImageHistogram::ActiveComponent
protected

Definition at line 192 of file vtkImageHistogram.h.

int vtkImageHistogram::AutomaticBinning
protected

Definition at line 193 of file vtkImageHistogram.h.

int vtkImageHistogram::MaximumNumberOfBins
protected

Definition at line 194 of file vtkImageHistogram.h.

int vtkImageHistogram::HistogramImageSize[2]
protected

Definition at line 196 of file vtkImageHistogram.h.

int vtkImageHistogram::HistogramImageScale
protected

Definition at line 197 of file vtkImageHistogram.h.

int vtkImageHistogram::GenerateHistogramImage
protected

Definition at line 198 of file vtkImageHistogram.h.

int vtkImageHistogram::NumberOfBins
protected

Definition at line 200 of file vtkImageHistogram.h.

double vtkImageHistogram::BinOrigin
protected

Definition at line 201 of file vtkImageHistogram.h.

double vtkImageHistogram::BinSpacing
protected

Definition at line 202 of file vtkImageHistogram.h.

vtkIdTypeArray* vtkImageHistogram::Histogram
protected

Definition at line 204 of file vtkImageHistogram.h.

vtkIdType vtkImageHistogram::Total
protected

Definition at line 205 of file vtkImageHistogram.h.

vtkIdType* vtkImageHistogram::ThreadOutput[VTK_MAX_THREADS]
protected

Definition at line 207 of file vtkImageHistogram.h.

int vtkImageHistogram::ThreadBinRange[VTK_MAX_THREADS][2]
protected

Definition at line 208 of file vtkImageHistogram.h.


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