svkImageStatistics Class Reference

#include <svkImageStatistics.h>

Inheritance diagram for svkImageStatistics:

Public Types
enum	svkImageStatisticsParameter {   INPUT_IMAGE = 0, INPUT_ROI, NUM_BINS, BIN_SIZE,   AUTO_ADJUST_BIN_SIZE, IGNORE_NEGATIVE_NUMBERS, START_BIN, SMOOTH_BINS,   COMPUTE_HISTOGRAM, COMPUTE_MEAN, COMPUTE_MAX, COMPUTE_MIN,   COMPUTE_STDEV, COMPUTE_VOLUME, COMPUTE_MODE, COMPUTE_MEDIAN,   COMPUTE_QUANTILES, COMPUTE_SUM, COMPUTE_MOMENT_2, COMPUTE_MOMENT_3,   COMPUTE_MOMENT_4, COMPUTE_VARIANCE, COMPUTE_SAMPLE_KURTOSIS, COMPUTE_SAMPLE_SKEWNESS,   COMPUTE_POPULATION_KURTOSIS, COMPUTE_POPULATION_SKEWNESS, NORMALIZATION_METHOD, NORMALIZATION_ROI_INDEX,   OUTPUT_FILE_NAME }
enum	svkNormalizationOptions { NONE = 0, MODE, MEAN }

Public Member Functions
	vtkTypeMacro (svkImageStatistics, svkGenericAlgorithmWithPortMapper)
vtkXMLDataElement *	GetOutput ()
	This will grab the output object as the correct data type to avoid casting. More...
Public Member Functions inherited from svkGenericAlgorithmWithPortMapper
	vtkTypeMacro (svkGenericAlgorithmWithPortMapper, vtkAlgorithm)
void	SetInputPortsFromXML (vtkXMLDataElement *element)
	Uses port mapper to parse an XML element and convert it into input port data objects. More...
svkAlgorithmPortMapper *	GetPortMapper ()
	Get the internal XML interpreter. More...
void	PrintSelf (ostream &os, vtkIndent indent)
	Prints all input parameters set. More...

Static Public Member Functions
static svkImageStatistics *	New ()

Protected Member Functions
	svkImageStatistics ()
	Constructor. More...
	~svkImageStatistics ()
	Destructor. More...
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Does the computation of the statistics. More...
void	ComputeAccumulateStatistics (svkMriImageData *image, svkMriImageData *roi, double binSize, vtkDataArray *maskedPixels, vtkXMLDataElement *result, double normalization=0)
void	ComputeOrderStatistics (svkMriImageData *image, svkMriImageData *roi, vtkDataArray *maskedPixels, vtkXMLDataElement *result)
void	ComputeDescriptiveStatistics (svkMriImageData *image, svkMriImageData *roi, vtkDataArray *maskedPixels, vtkXMLDataElement *result)
void	ComputeSmoothStatistics (svkMriImageData *image, svkMriImageData *roi, double binSize, vtkDataArray *maskedPixel, vtkXMLDataElement *results, double normalization=0)
void	AddHistogramTag (vtkDataArray *histogram, double binSize, double startBin, int numBins, int smoothBins, vtkXMLDataElement *results)
Protected Member Functions inherited from svkGenericAlgorithmWithPortMapper
	svkGenericAlgorithmWithPortMapper ()
	~svkGenericAlgorithmWithPortMapper ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	All ports must be initialized using the svkAlgorithmPortMapper BEFORE this method is called. More...
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	All ports must be initialized using the svkAlgorithmPortMapper BEFORE this method is called. More...
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Calls RequestData when the correct request comes through. More...

Additional Inherited Members
Protected Attributes inherited from svkGenericAlgorithmWithPortMapper
svkAlgorithmPortMapper *	portMapper
	The port mapper used to set the input port parameters. More...

Detailed Description

The purpose of this class is to take in an XML element that defines a set of ROI's, a set of images, filters to apply to the ROI's/images, and a set of statistics to be computed. Then statistics for every combination will be computed using svkImageStatistics and an XML data element will be output containing the results of the computation.

TODO: Should this be converted into an svkImageAlgorithmWithPortMapper?

Member Enumeration Documentation

enum svkImageStatisticsParameter

Enumerator
INPUT_IMAGE
INPUT_ROI
NUM_BINS
BIN_SIZE
AUTO_ADJUST_BIN_SIZE
IGNORE_NEGATIVE_NUMBERS
START_BIN
SMOOTH_BINS
COMPUTE_HISTOGRAM
COMPUTE_MEAN
COMPUTE_MAX
COMPUTE_MIN
COMPUTE_STDEV
COMPUTE_VOLUME
COMPUTE_MODE
COMPUTE_MEDIAN
COMPUTE_QUANTILES
COMPUTE_SUM
COMPUTE_MOMENT_2
COMPUTE_MOMENT_3
COMPUTE_MOMENT_4
COMPUTE_VARIANCE
COMPUTE_SAMPLE_KURTOSIS
COMPUTE_SAMPLE_SKEWNESS
COMPUTE_POPULATION_KURTOSIS
COMPUTE_POPULATION_SKEWNESS
NORMALIZATION_METHOD
NORMALIZATION_ROI_INDEX
OUTPUT_FILE_NAME

enum svkNormalizationOptions

Enumerator
NONE
MODE
MEAN

Constructor & Destructor Documentation

svkImageStatistics ( )

protected

Constructor.

References svkImageStatistics::AUTO_ADJUST_BIN_SIZE, svkImageStatistics::BIN_SIZE, svkImageStatistics::COMPUTE_HISTOGRAM, svkImageStatistics::COMPUTE_MAX, svkImageStatistics::COMPUTE_MEAN, svkImageStatistics::COMPUTE_MEDIAN, svkImageStatistics::COMPUTE_MIN, svkImageStatistics::COMPUTE_MODE, svkImageStatistics::COMPUTE_MOMENT_2, svkImageStatistics::COMPUTE_MOMENT_3, svkImageStatistics::COMPUTE_MOMENT_4, svkImageStatistics::COMPUTE_POPULATION_KURTOSIS, svkImageStatistics::COMPUTE_POPULATION_SKEWNESS, svkImageStatistics::COMPUTE_QUANTILES, svkImageStatistics::COMPUTE_SAMPLE_KURTOSIS, svkImageStatistics::COMPUTE_SAMPLE_SKEWNESS, svkImageStatistics::COMPUTE_STDEV, svkImageStatistics::COMPUTE_SUM, svkImageStatistics::COMPUTE_VARIANCE, svkImageStatistics::COMPUTE_VOLUME, svkGenericAlgorithmWithPortMapper::GetPortMapper(), svkImageStatistics::IGNORE_NEGATIVE_NUMBERS, svkAlgorithmPortMapper::InitializeInputPort(), svkAlgorithmPortMapper::InitializeOutputPort(), svkImageStatistics::INPUT_IMAGE, svkImageStatistics::INPUT_ROI, svkImageStatistics::NORMALIZATION_METHOD, svkImageStatistics::NORMALIZATION_ROI_INDEX, svkImageStatistics::NUM_BINS, svkImageStatistics::OUTPUT_FILE_NAME, svkImageStatistics::SMOOTH_BINS, svkImageStatistics::START_BIN, svkAlgorithmPortMapper::SVK_BOOL, svkAlgorithmPortMapper::SVK_DOUBLE, svkAlgorithmPortMapper::SVK_INT, svkAlgorithmPortMapper::SVK_MR_IMAGE_DATA, svkAlgorithmPortMapper::SVK_STRING, and svkAlgorithmPortMapper::SVK_XML.

~svkImageStatistics ( )

protected

Destructor.

Member Function Documentation

void AddHistogramTag ( vtkDataArray *  histogram, double  binSize, double  startBin, int  numBins, int  smoothBins, vtkXMLDataElement *  results  )

protected

Inserts the histogram tag into the result

References svkTypeUtils::IntToString().

Referenced by svkImageStatistics::ComputeSmoothStatistics().

void ComputeAccumulateStatistics ( svkMriImageData *  image, svkMriImageData *  roi, double  binSize, vtkDataArray *  maskedPixels, vtkXMLDataElement *  results, double  normalization = 0  )

protected

Computes basic statistics using vtkImageAccumulate.

References svkImageStatistics::COMPUTE_MAX, svkImageStatistics::COMPUTE_MEAN, svkImageStatistics::COMPUTE_MIN, svkImageStatistics::COMPUTE_STDEV, svkImageStatistics::COMPUTE_SUM, svkImageStatistics::COMPUTE_VOLUME, svkXMLUtils::CreateNestedXMLDataElement(), svkAlgorithmPortMapper::GetDoubleInputPortValue(), svkAlgorithmPortMapper::GetIntInputPortValue(), svkGenericAlgorithmWithPortMapper::GetPortMapper(), svkInt::GetValue(), svkDouble::GetValue(), svkImageStatistics::NUM_BINS, and svkImageStatistics::START_BIN.

Referenced by svkImageStatistics::RequestData().

void ComputeDescriptiveStatistics ( svkMriImageData *  image, svkMriImageData *  roi, vtkDataArray *  maskedPixels, vtkXMLDataElement *  results  )

protected

Computes statistics using the vtkDescriptiveStatistics class.

References svkImageStatistics::COMPUTE_MOMENT_2, svkImageStatistics::COMPUTE_MOMENT_3, svkImageStatistics::COMPUTE_MOMENT_4, svkImageStatistics::COMPUTE_POPULATION_KURTOSIS, svkImageStatistics::COMPUTE_POPULATION_SKEWNESS, svkImageStatistics::COMPUTE_SAMPLE_KURTOSIS, svkImageStatistics::COMPUTE_SAMPLE_SKEWNESS, svkImageStatistics::COMPUTE_VARIANCE, and svkXMLUtils::CreateNestedXMLDataElement().

Referenced by svkImageStatistics::RequestData().

void ComputeOrderStatistics ( svkMriImageData *  image, svkMriImageData *  roi, vtkDataArray *  maskedPixels, vtkXMLDataElement *  results  )

protected

Computes statistics using the vtkOrderStatistics class.

References svkImageStatistics::COMPUTE_MEDIAN, svkImageStatistics::COMPUTE_QUANTILES, svkXMLUtils::CreateNestedXMLDataElement(), and svkStatistics::GetMaskedPixels().

void ComputeSmoothStatistics ( svkMriImageData *  image, svkMriImageData *  roi, double  binSize, vtkDataArray *  maskedPixels, vtkXMLDataElement *  results, double  normalization = 0  )

protected

Do smooth computation.

References svkImageStatistics::AddHistogramTag(), svkImageStatistics::COMPUTE_HISTOGRAM, svkImageStatistics::COMPUTE_MEDIAN, svkImageStatistics::COMPUTE_MODE, svkImageStatistics::COMPUTE_QUANTILES, svkStatistics::ComputeModeFromHistogram(), svkStatistics::ComputeQuantilesFromHistogram(), svkXMLUtils::CreateNestedXMLDataElement(), svkAlgorithmPortMapper::GetDoubleInputPortValue(), svkStatistics::GetHistogram(), svkAlgorithmPortMapper::GetIntInputPortValue(), svkStatistics::GetMaskedPixels(), svkGenericAlgorithmWithPortMapper::GetPortMapper(), svkInt::GetValue(), svkDouble::GetValue(), svkImageStatistics::NUM_BINS, svkImageStatistics::SMOOTH_BINS, and svkImageStatistics::START_BIN.

Referenced by svkImageStatistics::RequestData().

vtkXMLDataElement * GetOutput

(

)

This will grab the output object as the correct data type to avoid casting.

References svkXML::GetValue().

Referenced by svkImageStatistics::RequestData().

static svkImageStatistics* New ( )

static

Referenced by svkImageAlgorithmPipeline::InitializeAlgorithmForTag().

int RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

Does the computation of the statistics.

RequestData pass the input through the algorithm, and copies the dcos and header to the output.

Implements svkGenericAlgorithmWithPortMapper.

References svkDataValidator::AreDataGeometriesSame(), svkImageStatistics::AUTO_ADJUST_BIN_SIZE, svkImageStatistics::BIN_SIZE, svkImageStatistics::ComputeAccumulateStatistics(), svkImageStatistics::ComputeDescriptiveStatistics(), svkImageStatistics::ComputeSmoothStatistics(), svkXMLUtils::CreateNestedXMLDataElement(), svkStatistics::GetAutoAdjustedBinSize(), svkImageData::GetDcmHeader(), svkAlgorithmPortMapper::GetDoubleInputPortValue(), svkAlgorithmPortMapper::GetIntInputPortValue(), svkStatistics::GetMaskedPixels(), svkAlgorithmPortMapper::GetMRImageInputPortValue(), svkImageStatistics::GetOutput(), svkGenericAlgorithmWithPortMapper::GetPortMapper(), svkAlgorithmPortMapper::GetStringInputPortValue(), svkDcmHeader::GetStringValue(), svkInt::GetValue(), svkString::GetValue(), svkDouble::GetValue(), svkImageStatistics::IGNORE_NEGATIVE_NUMBERS, svkImageStatistics::INPUT_IMAGE, svkImageStatistics::INPUT_ROI, svkImageStatistics::MEAN, svkImageStatistics::MODE, svkDataValidator::New(), svkImageStatistics::NONE, svkImageStatistics::NORMALIZATION_METHOD, svkImageStatistics::NORMALIZATION_ROI_INDEX, svkImageStatistics::NUM_BINS, svkImageStatistics::OUTPUT_FILE_NAME, svkDataValidator::resultInfo, svkImageStatistics::START_BIN, and svkTypeUtils::StringToDouble().

vtkTypeMacro	(	svkImageStatistics	,
		svkGenericAlgorithmWithPortMapper
	)

---

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

• svkImageStatistics.h
• svkImageStatistics.cc