vtkImageThresholdByPercentile Class Reference

#include <vtkImageThresholdByPercentile.h>

Inheritance diagram for vtkImageThresholdByPercentile:

[legend]Collaboration diagram for vtkImageThresholdByPercentile:

[legend]List of all members.

---

Detailed Description

Simple filter for thresholding an image based on lower and upper percentiles.

This is a simple image-image filter that performs thresholding of an image based on user supplied lower and upper percentile inputs and a scaling factor. The dimensionality may be set such that the thresholding is applied by 1D, 2D, or 3D. The output data type may be different than the input, but defaults to the same type.

See also:

vtkSimpleImageToImageFilter

Definition at line 47 of file vtkImageThresholdByPercentile.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkImageThresholdByPercentile, vtkSimpleImageToImageFilter)
virtual void	SetDimensionality (int)
virtual int	GetDimensionality ()
virtual void	SetUpperPercentile (double)
virtual double	GetUpperPercentile ()
virtual void	SetLowerPercentile (double)
virtual double	GetLowerPercentile ()
virtual void	SetScalingFactor (double)
virtual double	GetScalingFactor ()
virtual void	SetReplaceIn (int)
virtual int	GetReplaceIn ()
virtual void	ReplaceInOn ()
virtual void	ReplaceInOff ()
void	SetInValue (double val)
virtual double	GetInValue ()
virtual void	SetReplaceOut (int)
virtual int	GetReplaceOut ()
virtual void	ReplaceOutOn ()
virtual void	ReplaceOutOff ()
void	SetOutValue (double val)
virtual double	GetOutValue ()
virtual void	SetOutputScalarType (int)
virtual int	GetOutputScalarType ()
void	SetOutputScalarTypeToDouble ()
void	SetOutputScalarTypeToFloat ()
void	SetOutputScalarTypeToLong ()
void	SetOutputScalarTypeToUnsignedLong ()
void	SetOutputScalarTypeToInt ()
void	SetOutputScalarTypeToUnsignedInt ()
void	SetOutputScalarTypeToShort ()
void	SetOutputScalarTypeToUnsignedShort ()
void	SetOutputScalarTypeToChar ()
void	SetOutputScalarTypeToSignedChar ()
void	SetOutputScalarTypeToUnsignedChar ()
void	SetShiftDataByThreshodValue (int val)
virtual int	GetShiftDataByThreshodValue ()
virtual void	ShiftDataByThreshodValueOn ()
virtual void	ShiftDataByThreshodValueOff ()
Static Public Member Functions
static vtkImageThresholdByPercentile *	New ()
Protected Member Functions
	vtkImageThresholdByPercentile ()
	~vtkImageThresholdByPercentile ()
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	SimpleExecute (vtkImageData *input, vtkImageData *output)
Protected Attributes
double	UpperPercentile
double	LowerPercentile
double	ScalingFactor
int	ReplaceIn
double	InValue
int	ReplaceOut
double	OutValue
int	ShiftDataByThreshodValue
int	OutputScalarType
int	Dimensionality

---

Constructor & Destructor Documentation

vtkImageThresholdByPercentile::vtkImageThresholdByPercentile

(

)

[protected]

vtkImageThresholdByPercentile::~vtkImageThresholdByPercentile

(

)

[inline, protected]

Definition at line 154 of file vtkImageThresholdByPercentile.h.

---

Member Function Documentation

static vtkImageThresholdByPercentile* vtkImageThresholdByPercentile::New

(

)

[static]

Reimplemented from vtkAlgorithm.

vtkImageThresholdByPercentile::vtkTypeRevisionMacro	(	vtkImageThresholdByPercentile	,
		vtkSimpleImageToImageFilter
	)

virtual void vtkImageThresholdByPercentile::SetDimensionality

(

int

)

[virtual]

Dimensionality is the number of axes which are considered during execution.

virtual int vtkImageThresholdByPercentile::GetDimensionality

(

)

[virtual]

Dimensionality is the number of axes which are considered during execution.

virtual void vtkImageThresholdByPercentile::SetUpperPercentile

(

double

)

[virtual]

Set/Get the upper percentile used to calculate the threshold value. The value must be between 0 and 1 and greater than the lower percentile. The default value is 0.98

virtual double vtkImageThresholdByPercentile::GetUpperPercentile

(

)

[virtual]

Set/Get the upper percentile used to calculate the threshold value. The value must be between 0 and 1 and greater than the lower percentile. The default value is 0.98

virtual void vtkImageThresholdByPercentile::SetLowerPercentile

(

double

)

[virtual]

Set/Get the lower percentile used to calculate the threshold value. The value must be between 0 and 1 and less than the upper percentile. The default value is 0.02

virtual double vtkImageThresholdByPercentile::GetLowerPercentile

(

)

[virtual]

Set/Get the lower percentile used to calculate the threshold value. The value must be between 0 and 1 and less than the upper percentile. The default value is 0.02

virtual void vtkImageThresholdByPercentile::SetScalingFactor

(

double

)

[virtual]

Set/Get the scaling factor. The default value is 0.1 (works well for brain images)

virtual double vtkImageThresholdByPercentile::GetScalingFactor

(

)

[virtual]

Set/Get the scaling factor. The default value is 0.1 (works well for brain images)

virtual void vtkImageThresholdByPercentile::SetReplaceIn

(

int

)

[virtual]

Determines whether to replace the pixel in range with InValue

virtual int vtkImageThresholdByPercentile::GetReplaceIn

(

)

[virtual]

Determines whether to replace the pixel in range with InValue

virtual void vtkImageThresholdByPercentile::ReplaceInOn

(

)

[virtual]

Determines whether to replace the pixel in range with InValue

virtual void vtkImageThresholdByPercentile::ReplaceInOff

(

)

[virtual]

Determines whether to replace the pixel in range with InValue

void vtkImageThresholdByPercentile::SetInValue

(

double

val

)

Replace the in range pixels with this value.

virtual double vtkImageThresholdByPercentile::GetInValue

(

)

[virtual]

Replace the in range pixels with this value.

virtual void vtkImageThresholdByPercentile::SetReplaceOut

(

int

)

[virtual]

Determines whether to replace the pixel out of range with OutValue

virtual int vtkImageThresholdByPercentile::GetReplaceOut

(

)

[virtual]

Determines whether to replace the pixel out of range with OutValue

virtual void vtkImageThresholdByPercentile::ReplaceOutOn

(

)

[virtual]

Determines whether to replace the pixel out of range with OutValue

virtual void vtkImageThresholdByPercentile::ReplaceOutOff

(

)

[virtual]

Determines whether to replace the pixel out of range with OutValue

void vtkImageThresholdByPercentile::SetOutValue

(

double

val

)

Replace the in range pixels with this value.

virtual double vtkImageThresholdByPercentile::GetOutValue

(

)

[virtual]

Replace the in range pixels with this value.

virtual void vtkImageThresholdByPercentile::SetOutputScalarType

(

int

)

[virtual]

Set the desired output scalar type to cast to

virtual int vtkImageThresholdByPercentile::GetOutputScalarType

(

)

[virtual]

Set the desired output scalar type to cast to

void vtkImageThresholdByPercentile::SetOutputScalarTypeToDouble

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 117 of file vtkImageThresholdByPercentile.h.

References VTK_DOUBLE.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToFloat

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 119 of file vtkImageThresholdByPercentile.h.

References VTK_FLOAT.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToLong

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 121 of file vtkImageThresholdByPercentile.h.

References VTK_LONG.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToUnsignedLong

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 123 of file vtkImageThresholdByPercentile.h.

References VTK_UNSIGNED_LONG.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToInt

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 125 of file vtkImageThresholdByPercentile.h.

References VTK_INT.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToUnsignedInt

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 127 of file vtkImageThresholdByPercentile.h.

References VTK_UNSIGNED_INT.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToShort

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 129 of file vtkImageThresholdByPercentile.h.

References VTK_SHORT.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToUnsignedShort

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 131 of file vtkImageThresholdByPercentile.h.

References VTK_UNSIGNED_SHORT.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToChar

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 133 of file vtkImageThresholdByPercentile.h.

References VTK_CHAR.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToSignedChar

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 135 of file vtkImageThresholdByPercentile.h.

References VTK_SIGNED_CHAR.

void vtkImageThresholdByPercentile::SetOutputScalarTypeToUnsignedChar

(

)

[inline]

Set the desired output scalar type to cast to

Definition at line 137 of file vtkImageThresholdByPercentile.h.

References VTK_UNSIGNED_CHAR.

void vtkImageThresholdByPercentile::SetShiftDataByThreshodValue

(

int

val

)

Determines whether to shift data by threshold value (default is off). Setting this to "On" also implies setting ReplaceIn to "On" with the in value determined by the threshold value.

virtual int vtkImageThresholdByPercentile::GetShiftDataByThreshodValue

(

)

[virtual]

Determines whether to shift data by threshold value (default is off). Setting this to "On" also implies setting ReplaceIn to "On" with the in value determined by the threshold value.

virtual void vtkImageThresholdByPercentile::ShiftDataByThreshodValueOn

(

)

[virtual]

Determines whether to shift data by threshold value (default is off). Setting this to "On" also implies setting ReplaceIn to "On" with the in value determined by the threshold value.

virtual void vtkImageThresholdByPercentile::ShiftDataByThreshodValueOff

(

)

[virtual]

Determines whether to shift data by threshold value (default is off). Setting this to "On" also implies setting ReplaceIn to "On" with the in value determined by the threshold value.

virtual int vtkImageThresholdByPercentile::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			[protected, virtual]

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageThresholdByPercentile::SimpleExecute	(	vtkImageData *	input,
		vtkImageData *	output
	)			[protected, virtual]

Implements vtkSimpleImageToImageFilter.

---

Member Data Documentation

double vtkImageThresholdByPercentile::UpperPercentile [protected]

Definition at line 154 of file vtkImageThresholdByPercentile.h.

double vtkImageThresholdByPercentile::LowerPercentile [protected]

Definition at line 157 of file vtkImageThresholdByPercentile.h.

double vtkImageThresholdByPercentile::ScalingFactor [protected]

Definition at line 158 of file vtkImageThresholdByPercentile.h.

int vtkImageThresholdByPercentile::ReplaceIn [protected]

Definition at line 159 of file vtkImageThresholdByPercentile.h.

double vtkImageThresholdByPercentile::InValue [protected]

Definition at line 160 of file vtkImageThresholdByPercentile.h.

int vtkImageThresholdByPercentile::ReplaceOut [protected]

Definition at line 161 of file vtkImageThresholdByPercentile.h.

double vtkImageThresholdByPercentile::OutValue [protected]

Definition at line 162 of file vtkImageThresholdByPercentile.h.

int vtkImageThresholdByPercentile::ShiftDataByThreshodValue [protected]

Definition at line 163 of file vtkImageThresholdByPercentile.h.

int vtkImageThresholdByPercentile::OutputScalarType [protected]

Definition at line 165 of file vtkImageThresholdByPercentile.h.

int vtkImageThresholdByPercentile::Dimensionality [protected]

Definition at line 166 of file vtkImageThresholdByPercentile.h.

---

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

• dox/Imaging/vtkImageThresholdByPercentile.h

---