VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | 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

enum  { Linear = 0, Log = 1, Sqrt = 2 }
 Scale types for the histogram image. More...
 
typedef vtkThreadedImageAlgorithm Superclass
 
- Public Types inherited from vtkThreadedImageAlgorithm
typedef vtkImageAlgorithm Superclass
 
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageHistogramNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetActiveComponent (int)
 Set the component for which to generate a histogram. More...
 
virtual int GetActiveComponent ()
 
virtual void SetAutomaticBinning (vtkTypeBool)
 If this is On, then the histogram binning will be done automatically. More...
 
virtual void AutomaticBinningOn ()
 
virtual void AutomaticBinningOff ()
 
virtual vtkTypeBool GetAutomaticBinning ()
 
virtual void SetMaximumNumberOfBins (int)
 The maximum number of bins to use when AutomaticBinning is On. More...
 
virtual int GetMaximumNumberOfBins ()
 
virtual void SetNumberOfBins (int)
 The number of bins in histogram (default 256). More...
 
virtual int GetNumberOfBins ()
 
virtual void SetBinOrigin (double)
 The value for the center of the first bin (default 0). More...
 
virtual double GetBinOrigin ()
 
virtual void SetBinSpacing (double)
 The bin spacing (default 1). More...
 
virtual double GetBinSpacing ()
 
void SetStencilData (vtkImageStencilData *stencil)
 Use a stencil to compute the histogram for just a part of the image. More...
 
vtkImageStencilDataGetStencil ()
 
void SetStencilConnection (vtkAlgorithmOutput *algOutput)
 Equivalent to SetInputConnection(1, algOutput). More...
 
virtual void SetGenerateHistogramImage (vtkTypeBool)
 If this is On, then a histogram image will be produced as the output. More...
 
virtual void GenerateHistogramImageOn ()
 
virtual void GenerateHistogramImageOff ()
 
virtual vtkTypeBool GetGenerateHistogramImage ()
 
virtual void SetHistogramImageSize (int, int)
 Set the size of the histogram image that is produced as output. More...
 
void SetHistogramImageSize (int[2])
 
virtual int * GetHistogramImageSize ()
 
virtual void GetHistogramImageSize (int &, int &)
 
virtual void GetHistogramImageSize (int[2])
 
virtual void SetHistogramImageScale (int)
 Set the scale to use for the histogram image. More...
 
void SetHistogramImageScaleToLinear ()
 
void SetHistogramImageScaleToLog ()
 
void SetHistogramImageScaleToSqrt ()
 
virtual int GetHistogramImageScale ()
 
const char * GetHistogramImageScaleAsString ()
 
vtkIdTypeArrayGetHistogram ()
 Get the histogram as a vtkIdTypeArray. More...
 
vtkIdType GetTotal ()
 Get the total count of the histogram. More...
 
void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id) override
 This is part of the executive, but is public so that it can be accessed by non-member functions. More...
 
- Public Member Functions inherited from vtkThreadedImageAlgorithm
vtkThreadedImageAlgorithmNewInstance () const
 
virtual void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId)
 
virtual bool GetEnableSMP ()
 Enable/Disable SMP for threading. More...
 
virtual void SetEnableSMP (bool)
 
virtual void SetMinimumPieceSize (int, int, int)
 The minimum piece size when volume is split for execution. More...
 
virtual void SetMinimumPieceSize (int[3])
 
virtual int * GetMinimumPieceSize ()
 
virtual void GetMinimumPieceSize (int &, int &, int &)
 
virtual void GetMinimumPieceSize (int[3])
 
virtual void SetDesiredBytesPerPiece (vtkIdType)
 The desired bytes per piece when volume is split for execution. More...
 
virtual vtkIdType GetDesiredBytesPerPiece ()
 
virtual void SetSplitMode (int)
 Set the method used to divide the volume into pieces. More...
 
void SetSplitModeToSlab ()
 
void SetSplitModeToBeam ()
 
void SetSplitModeToBlock ()
 
virtual int GetSplitMode ()
 
virtual void SetNumberOfThreads (int)
 Get/Set the number of threads to create when rendering. More...
 
virtual int GetNumberOfThreads ()
 
virtual int SplitExtent (int splitExt[6], int startExt[6], int num, int total)
 Putting this here until I merge graphics and imaging streaming. More...
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 
vtkImageDataGetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
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 ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImageHistogramNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageHistogramSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkThreadedImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkThreadedImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalDefaultEnableSMP (bool enable)
 Global Disable SMP for all derived Imaging filters. More...
 
static bool GetGlobalDefaultEnableSMP ()
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
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 ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageHistogram ()
 
 ~vtkImageHistogram () override
 
int RequestUpdateExtent (vtkInformation *vtkNotUsed(request), vtkInformationVector **inInfo, vtkInformationVector *vtkNotUsed(outInfo)) override
 
int RequestInformation (vtkInformation *vtkNotUsed(request), vtkInformationVector **inInfo, vtkInformationVector *vtkNotUsed(outInfo)) override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
void ComputeImageScalarRange (vtkImageData *data, double range[2])
 Compute the range of the data. More...
 
- Protected Member Functions inherited from vtkThreadedImageAlgorithm
 vtkThreadedImageAlgorithm ()
 
 ~vtkThreadedImageAlgorithm () override
 
virtual void SMPRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, vtkIdType begin, vtkIdType end, vtkIdType pieces, int extent[6])
 Execute ThreadedRequestData for the given set of pieces. More...
 
virtual void PrepareImageData (vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inDataObjects=nullptr, vtkImageData **outDataObjects=nullptr)
 Allocate space for output data and copy attributes from first input. More...
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections. More...
 
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Convenience method to copy the scalar type and number of components from the input data to the output data. More...
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 This is a convenience method that is implemented in many subclasses instead of RequestData. More...
 
virtual void ExecuteData (vtkDataObject *output)
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void Execute ()
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 Allocate the output data. More...
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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
 
vtkTypeBool AutomaticBinning
 
int MaximumNumberOfBins
 
int HistogramImageSize [2]
 
int HistogramImageScale
 
vtkTypeBool GenerateHistogramImage
 
int NumberOfBins
 
double BinOrigin
 
double BinSpacing
 
vtkIdTypeArrayHistogram
 
vtkIdType Total
 
vtkImageHistogramThreadData * ThreadData
 
vtkImageHistogramSMPThreadLocal * SMPThreadData
 
- Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreaderThreader
 
int NumberOfThreads
 
bool EnableSMP
 
int SplitMode
 
int SplitPath [3]
 
int SplitPathLength
 
int MinimumPieceSize [3]
 
vtkIdType DesiredBytesPerPiece
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkImageHistogramFunctor
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Protected Types inherited from vtkThreadedImageAlgorithm
enum  SplitModeEnum { SLAB = 0, BEAM = 1, BLOCK = 2 }
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkThreadedImageAlgorithm
static bool GlobalDefaultEnableSMP
 
- 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.

Definition at line 42 of file vtkImageHistogram.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkImageHistogram.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Scale types for the histogram image.

Enumerator
Linear 
Log 
Sqrt 

Definition at line 53 of file vtkImageHistogram.h.

Constructor & Destructor Documentation

◆ vtkImageHistogram()

vtkImageHistogram::vtkImageHistogram ( )
protected

◆ ~vtkImageHistogram()

vtkImageHistogram::~vtkImageHistogram ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageHistogram* vtkImageHistogram::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkImageHistogram::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageHistogram::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkThreadedImageAlgorithm.

Reimplemented in vtkImageHistogramStatistics.

◆ NewInstance()

vtkImageHistogram* vtkImageHistogram::NewInstance ( ) const

◆ PrintSelf()

void vtkImageHistogram::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetActiveComponent()

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.

◆ GetActiveComponent()

virtual int vtkImageHistogram::GetActiveComponent ( )
virtual

◆ SetAutomaticBinning()

virtual void vtkImageHistogram::SetAutomaticBinning ( vtkTypeBool  )
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.

◆ AutomaticBinningOn()

virtual void vtkImageHistogram::AutomaticBinningOn ( )
virtual

◆ AutomaticBinningOff()

virtual void vtkImageHistogram::AutomaticBinningOff ( )
virtual

◆ GetAutomaticBinning()

virtual vtkTypeBool vtkImageHistogram::GetAutomaticBinning ( )
virtual

◆ SetMaximumNumberOfBins()

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.

◆ GetMaximumNumberOfBins()

virtual int vtkImageHistogram::GetMaximumNumberOfBins ( )
virtual

◆ SetNumberOfBins()

virtual void vtkImageHistogram::SetNumberOfBins ( int  )
virtual

The number of bins in histogram (default 256).

This is automatically computed unless AutomaticBinning is Off.

◆ GetNumberOfBins()

virtual int vtkImageHistogram::GetNumberOfBins ( )
virtual

◆ SetBinOrigin()

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.

◆ GetBinOrigin()

virtual double vtkImageHistogram::GetBinOrigin ( )
virtual

◆ SetBinSpacing()

virtual void vtkImageHistogram::SetBinSpacing ( double  )
virtual

The bin spacing (default 1).

This is automatically computed unless AutomaticBinning is Off.

◆ GetBinSpacing()

virtual double vtkImageHistogram::GetBinSpacing ( )
virtual

◆ SetStencilData()

void vtkImageHistogram::SetStencilData ( vtkImageStencilData stencil)

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

◆ GetStencil()

vtkImageStencilData* vtkImageHistogram::GetStencil ( )

◆ SetStencilConnection()

void vtkImageHistogram::SetStencilConnection ( vtkAlgorithmOutput algOutput)

Equivalent to SetInputConnection(1, algOutput).

◆ SetGenerateHistogramImage()

virtual void vtkImageHistogram::SetGenerateHistogramImage ( vtkTypeBool  )
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.

◆ GenerateHistogramImageOn()

virtual void vtkImageHistogram::GenerateHistogramImageOn ( )
virtual

◆ GenerateHistogramImageOff()

virtual void vtkImageHistogram::GenerateHistogramImageOff ( )
virtual

◆ GetGenerateHistogramImage()

virtual vtkTypeBool vtkImageHistogram::GetGenerateHistogramImage ( )
virtual

◆ SetHistogramImageSize() [1/2]

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.

◆ SetHistogramImageSize() [2/2]

void vtkImageHistogram::SetHistogramImageSize ( int  [2])

◆ GetHistogramImageSize() [1/3]

virtual int* vtkImageHistogram::GetHistogramImageSize ( )
virtual

◆ GetHistogramImageSize() [2/3]

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

◆ GetHistogramImageSize() [3/3]

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

◆ SetHistogramImageScale()

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.

◆ SetHistogramImageScaleToLinear()

void vtkImageHistogram::SetHistogramImageScaleToLinear ( )
inline

Definition at line 166 of file vtkImageHistogram.h.

◆ SetHistogramImageScaleToLog()

void vtkImageHistogram::SetHistogramImageScaleToLog ( )
inline

Definition at line 167 of file vtkImageHistogram.h.

◆ SetHistogramImageScaleToSqrt()

void vtkImageHistogram::SetHistogramImageScaleToSqrt ( )
inline

Definition at line 168 of file vtkImageHistogram.h.

◆ GetHistogramImageScale()

virtual int vtkImageHistogram::GetHistogramImageScale ( )
virtual

◆ GetHistogramImageScaleAsString()

const char* vtkImageHistogram::GetHistogramImageScaleAsString ( )

◆ GetHistogram()

vtkIdTypeArray* vtkImageHistogram::GetHistogram ( )

Get the histogram as a vtkIdTypeArray.

You must call Update() before calling this method.

◆ GetTotal()

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 183 of file vtkImageHistogram.h.

◆ ThreadedRequestData()

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

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

Reimplemented from vtkThreadedImageAlgorithm.

◆ RequestUpdateExtent()

int vtkImageHistogram::RequestUpdateExtent ( vtkInformation vtkNotUsedrequest,
vtkInformationVector **  inInfo,
vtkInformationVector vtkNotUsedoutInfo 
)
overrideprotected

◆ RequestInformation()

int vtkImageHistogram::RequestInformation ( vtkInformation vtkNotUsedrequest,
vtkInformationVector **  inInfo,
vtkInformationVector vtkNotUsedoutInfo 
)
overrideprotected

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkThreadedImageAlgorithm.

Reimplemented in vtkImageHistogramStatistics.

◆ FillInputPortInformation()

int vtkImageHistogram::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkImageAlgorithm.

◆ FillOutputPortInformation()

int vtkImageHistogram::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

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.

◆ ComputeImageScalarRange()

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.

Friends And Related Function Documentation

◆ vtkImageHistogramFunctor

friend class vtkImageHistogramFunctor
friend

Definition at line 238 of file vtkImageHistogram.h.

Member Data Documentation

◆ ActiveComponent

int vtkImageHistogram::ActiveComponent
protected

Definition at line 213 of file vtkImageHistogram.h.

◆ AutomaticBinning

vtkTypeBool vtkImageHistogram::AutomaticBinning
protected

Definition at line 214 of file vtkImageHistogram.h.

◆ MaximumNumberOfBins

int vtkImageHistogram::MaximumNumberOfBins
protected

Definition at line 215 of file vtkImageHistogram.h.

◆ HistogramImageSize

int vtkImageHistogram::HistogramImageSize[2]
protected

Definition at line 217 of file vtkImageHistogram.h.

◆ HistogramImageScale

int vtkImageHistogram::HistogramImageScale
protected

Definition at line 218 of file vtkImageHistogram.h.

◆ GenerateHistogramImage

vtkTypeBool vtkImageHistogram::GenerateHistogramImage
protected

Definition at line 219 of file vtkImageHistogram.h.

◆ NumberOfBins

int vtkImageHistogram::NumberOfBins
protected

Definition at line 221 of file vtkImageHistogram.h.

◆ BinOrigin

double vtkImageHistogram::BinOrigin
protected

Definition at line 222 of file vtkImageHistogram.h.

◆ BinSpacing

double vtkImageHistogram::BinSpacing
protected

Definition at line 223 of file vtkImageHistogram.h.

◆ Histogram

vtkIdTypeArray* vtkImageHistogram::Histogram
protected

Definition at line 225 of file vtkImageHistogram.h.

◆ Total

vtkIdType vtkImageHistogram::Total
protected

Definition at line 226 of file vtkImageHistogram.h.

◆ ThreadData

vtkImageHistogramThreadData* vtkImageHistogram::ThreadData
protected

Definition at line 229 of file vtkImageHistogram.h.

◆ SMPThreadData

vtkImageHistogramSMPThreadLocal* vtkImageHistogram::SMPThreadData
protected

Definition at line 232 of file vtkImageHistogram.h.


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