VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageAccumulate Class Reference

Generalized histograms up to 3 dimensions. More...

#include <vtkImageAccumulate.h>

Inherits vtkImageAlgorithm.

Public Types

typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImageAccumulateNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetComponentSpacing (double, double, double)
 
virtual void SetComponentSpacing (double[3])
 
virtual double * GetComponentSpacing ()
 
virtual void GetComponentSpacing (double &, double &, double &)
 
virtual void GetComponentSpacing (double[3])
 
virtual void SetComponentOrigin (double, double, double)
 
virtual void SetComponentOrigin (double[3])
 
virtual double * GetComponentOrigin ()
 
virtual void GetComponentOrigin (double &, double &, double &)
 
virtual void GetComponentOrigin (double[3])
 
void SetComponentExtent (int extent[6])
 
void SetComponentExtent (int minX, int maxX, int minY, int maxY, int minZ, int maxZ)
 
void GetComponentExtent (int extent[6])
 
int * GetComponentExtent ()
 
void SetStencilData (vtkImageStencilData *stencil)
 
vtkImageStencilDataGetStencil ()
 
virtual void SetReverseStencil (int)
 
virtual void ReverseStencilOn ()
 
virtual void ReverseStencilOff ()
 
virtual int GetReverseStencil ()
 
virtual double * GetMin ()
 
virtual void GetMin (double &, double &, double &)
 
virtual void GetMin (double[3])
 
virtual double * GetMax ()
 
virtual void GetMax (double &, double &, double &)
 
virtual void GetMax (double[3])
 
virtual double * GetMean ()
 
virtual void GetMean (double &, double &, double &)
 
virtual void GetMean (double[3])
 
virtual double * GetStandardDeviation ()
 
virtual void GetStandardDeviation (double &, double &, double &)
 
virtual void GetStandardDeviation (double[3])
 
virtual vtkIdType GetVoxelCount ()
 
virtual void SetIgnoreZero (int)
 
virtual int GetIgnoreZero ()
 
virtual void IgnoreZeroOn ()
 
virtual void IgnoreZeroOff ()
 

Static Public Member Functions

static vtkImageAccumulateNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageAccumulateSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkImageAccumulate ()
 
 ~vtkImageAccumulate ()
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 

Protected Attributes

double ComponentSpacing [3]
 
double ComponentOrigin [3]
 
int ComponentExtent [6]
 
int IgnoreZero
 
double Min [3]
 
double Max [3]
 
double Mean [3]
 
double StandardDeviation [3]
 
vtkIdType VoxelCount
 
int ReverseStencil
 

Detailed Description

Generalized histograms up to 3 dimensions.

vtkImageAccumulate - This filter divides component space into discrete bins. It then counts the number of pixels associated with each bin. The dimensionality of the output depends on how many components the input pixels have. An input images with N components per pixels will result in an N-dimensional histogram, where N can be 1, 2, or 3. The input can be any type, but the output is always int. Some statistics are computed on the pixel values at the same time. The SetStencil and ReverseStencil functions allow the statistics to be computed on an arbitrary portion of the input data. See the documentation for vtkImageStencilData for more information.

This filter also supports ignoring pixels with value equal to 0. Using this option with vtkImageMask may result in results being slightly off since 0 could be a valid value from your input.

Examples:
vtkImageAccumulate (Examples)
Tests:
vtkImageAccumulate (Tests)

Definition at line 50 of file vtkImageAccumulate.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkImageAccumulate::Superclass

Definition at line 54 of file vtkImageAccumulate.h.

Constructor & Destructor Documentation

vtkImageAccumulate::vtkImageAccumulate ( )
protected
vtkImageAccumulate::~vtkImageAccumulate ( )
protected

Member Function Documentation

static vtkImageAccumulate* vtkImageAccumulate::New ( )
static
static int vtkImageAccumulate::IsTypeOf ( const char *  type)
static
virtual int vtkImageAccumulate::IsA ( const char *  type)
virtual
static vtkImageAccumulate* vtkImageAccumulate::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkImageAccumulate::NewInstanceInternal ( ) const
protectedvirtual
vtkImageAccumulate* vtkImageAccumulate::NewInstance ( ) const
void vtkImageAccumulate::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkImageAccumulate::SetComponentSpacing ( double  ,
double  ,
double   
)
virtual

Set/Get - The component spacing is the dimension of each bin. This ends up being the spacing of the output "image". If the number of input scalar components are less than three, then some of these spacing values are ignored. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this spacing should be set to 100, 0, 0. Initial value is (1.0,1.0,1.0).

virtual void vtkImageAccumulate::SetComponentSpacing ( double  [3])
virtual

Set/Get - The component spacing is the dimension of each bin. This ends up being the spacing of the output "image". If the number of input scalar components are less than three, then some of these spacing values are ignored. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this spacing should be set to 100, 0, 0. Initial value is (1.0,1.0,1.0).

virtual double* vtkImageAccumulate::GetComponentSpacing ( )
virtual

Set/Get - The component spacing is the dimension of each bin. This ends up being the spacing of the output "image". If the number of input scalar components are less than three, then some of these spacing values are ignored. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this spacing should be set to 100, 0, 0. Initial value is (1.0,1.0,1.0).

virtual void vtkImageAccumulate::GetComponentSpacing ( double &  ,
double &  ,
double &   
)
virtual

Set/Get - The component spacing is the dimension of each bin. This ends up being the spacing of the output "image". If the number of input scalar components are less than three, then some of these spacing values are ignored. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this spacing should be set to 100, 0, 0. Initial value is (1.0,1.0,1.0).

virtual void vtkImageAccumulate::GetComponentSpacing ( double  [3])
virtual

Set/Get - The component spacing is the dimension of each bin. This ends up being the spacing of the output "image". If the number of input scalar components are less than three, then some of these spacing values are ignored. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this spacing should be set to 100, 0, 0. Initial value is (1.0,1.0,1.0).

virtual void vtkImageAccumulate::SetComponentOrigin ( double  ,
double  ,
double   
)
virtual

Set/Get - The component origin is the location of bin (0, 0, 0). Note that if the Component extent does not include the value (0,0,0), then this origin bin will not actually be in the output. The origin of the output ends up being the same as the componenet origin. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this origin should be set to 1000, 0, 0. Initial value is (0.0,0.0,0.0).

virtual void vtkImageAccumulate::SetComponentOrigin ( double  [3])
virtual

Set/Get - The component origin is the location of bin (0, 0, 0). Note that if the Component extent does not include the value (0,0,0), then this origin bin will not actually be in the output. The origin of the output ends up being the same as the componenet origin. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this origin should be set to 1000, 0, 0. Initial value is (0.0,0.0,0.0).

virtual double* vtkImageAccumulate::GetComponentOrigin ( )
virtual

Set/Get - The component origin is the location of bin (0, 0, 0). Note that if the Component extent does not include the value (0,0,0), then this origin bin will not actually be in the output. The origin of the output ends up being the same as the componenet origin. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this origin should be set to 1000, 0, 0. Initial value is (0.0,0.0,0.0).

virtual void vtkImageAccumulate::GetComponentOrigin ( double &  ,
double &  ,
double &   
)
virtual

Set/Get - The component origin is the location of bin (0, 0, 0). Note that if the Component extent does not include the value (0,0,0), then this origin bin will not actually be in the output. The origin of the output ends up being the same as the componenet origin. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this origin should be set to 1000, 0, 0. Initial value is (0.0,0.0,0.0).

virtual void vtkImageAccumulate::GetComponentOrigin ( double  [3])
virtual

Set/Get - The component origin is the location of bin (0, 0, 0). Note that if the Component extent does not include the value (0,0,0), then this origin bin will not actually be in the output. The origin of the output ends up being the same as the componenet origin. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this origin should be set to 1000, 0, 0. Initial value is (0.0,0.0,0.0).

void vtkImageAccumulate::SetComponentExtent ( int  extent[6])

Set/Get - The component extent sets the number/extent of the bins. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this extent should be set to 0, 9, 0, 0, 0, 0. The extent specifies inclusive min/max values. This implies that the top extent should be set to the number of bins - 1. Initial value is (0,255,0,0,0,0)

void vtkImageAccumulate::SetComponentExtent ( int  minX,
int  maxX,
int  minY,
int  maxY,
int  minZ,
int  maxZ 
)

Set/Get - The component extent sets the number/extent of the bins. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this extent should be set to 0, 9, 0, 0, 0, 0. The extent specifies inclusive min/max values. This implies that the top extent should be set to the number of bins - 1. Initial value is (0,255,0,0,0,0)

void vtkImageAccumulate::GetComponentExtent ( int  extent[6])

Set/Get - The component extent sets the number/extent of the bins. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this extent should be set to 0, 9, 0, 0, 0, 0. The extent specifies inclusive min/max values. This implies that the top extent should be set to the number of bins - 1. Initial value is (0,255,0,0,0,0)

int* vtkImageAccumulate::GetComponentExtent ( )
inline

Set/Get - The component extent sets the number/extent of the bins. For a 1D histogram with 10 bins spanning the values 1000 to 2000, this extent should be set to 0, 9, 0, 0, 0, 0. The extent specifies inclusive min/max values. This implies that the top extent should be set to the number of bins - 1. Initial value is (0,255,0,0,0,0)

Definition at line 89 of file vtkImageAccumulate.h.

void vtkImageAccumulate::SetStencilData ( vtkImageStencilData stencil)

Use a stencil to specify which voxels to accumulate. Backcompatible methods. It set and get the stencil on input port 1. Initial value is NULL.

vtkImageStencilData* vtkImageAccumulate::GetStencil ( )

Use a stencil to specify which voxels to accumulate. Backcompatible methods. It set and get the stencil on input port 1. Initial value is NULL.

virtual void vtkImageAccumulate::SetReverseStencil ( int  )
virtual

Reverse the stencil. Initial value is false.

virtual void vtkImageAccumulate::ReverseStencilOn ( )
virtual

Reverse the stencil. Initial value is false.

virtual void vtkImageAccumulate::ReverseStencilOff ( )
virtual

Reverse the stencil. Initial value is false.

virtual int vtkImageAccumulate::GetReverseStencil ( )
virtual

Reverse the stencil. Initial value is false.

virtual double* vtkImageAccumulate::GetMin ( )
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::GetMin ( double &  ,
double &  ,
double &   
)
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::GetMin ( double  [3])
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual double* vtkImageAccumulate::GetMax ( )
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::GetMax ( double &  ,
double &  ,
double &   
)
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::GetMax ( double  [3])
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual double* vtkImageAccumulate::GetMean ( )
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::GetMean ( double &  ,
double &  ,
double &   
)
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::GetMean ( double  [3])
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual double* vtkImageAccumulate::GetStandardDeviation ( )
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::GetStandardDeviation ( double &  ,
double &  ,
double &   
)
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::GetStandardDeviation ( double  [3])
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual vtkIdType vtkImageAccumulate::GetVoxelCount ( )
virtual

Get the statistics information for the data. The values only make sense after the execution of the filter. Initial values are 0.

virtual void vtkImageAccumulate::SetIgnoreZero ( int  )
virtual

Should the data with value 0 be ignored? Initial value is false.

virtual int vtkImageAccumulate::GetIgnoreZero ( )
virtual

Should the data with value 0 be ignored? Initial value is false.

virtual void vtkImageAccumulate::IgnoreZeroOn ( )
virtual

Should the data with value 0 be ignored? Initial value is false.

virtual void vtkImageAccumulate::IgnoreZeroOff ( )
virtual

Should the data with value 0 be ignored? Initial value is false.

virtual int vtkImageAccumulate::RequestUpdateExtent ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkImageAccumulate::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkImageAccumulate::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual
virtual int vtkImageAccumulate::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Member Data Documentation

double vtkImageAccumulate::ComponentSpacing[3]
protected

Definition at line 129 of file vtkImageAccumulate.h.

double vtkImageAccumulate::ComponentOrigin[3]
protected

Definition at line 130 of file vtkImageAccumulate.h.

int vtkImageAccumulate::ComponentExtent[6]
protected

Definition at line 131 of file vtkImageAccumulate.h.

int vtkImageAccumulate::IgnoreZero
protected

Definition at line 143 of file vtkImageAccumulate.h.

double vtkImageAccumulate::Min[3]
protected

Definition at line 144 of file vtkImageAccumulate.h.

double vtkImageAccumulate::Max[3]
protected

Definition at line 145 of file vtkImageAccumulate.h.

double vtkImageAccumulate::Mean[3]
protected

Definition at line 146 of file vtkImageAccumulate.h.

double vtkImageAccumulate::StandardDeviation[3]
protected

Definition at line 147 of file vtkImageAccumulate.h.

vtkIdType vtkImageAccumulate::VoxelCount
protected

Definition at line 148 of file vtkImageAccumulate.h.

int vtkImageAccumulate::ReverseStencil
protected

Definition at line 150 of file vtkImageAccumulate.h.


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