ComputeAverageMap Class Reference

Computes the average of a series of images and writes the output. More...

#include <cbicaITKComputeAverageMap.h>

Inheritance diagram for ComputeAverageMap:

Collaboration diagram for ComputeAverageMap:

Public Member Functions
	ComputeAverageMap ()
	Default Constructor.
	ComputeAverageMap (const std::vector< std::string > &inputFiles, const std::string &output)
	Actual Constructor. More...
	ComputeAverageMap (const std::vector< std::string > &inputFiles, const std::string &output, const bool verbose)
	Actual Constructor. More...
	ComputeAverageMap (const std::vector< std::string > &inputFiles, const std::string &output, const std::string &prefix)
	Actual Constructor. More...
	ComputeAverageMap (const std::vector< std::string > &inputFiles, const std::string &output, const bool verbose, const std::string &prefix)
	Actual Constructor. More...
void	SetParameters (const std::vector< std::string > &inputFileNames, const std::string &output, const std::string &prefix)
	Set the object parameters for the default () constructor. More...
virtual	~ComputeAverageMap ()
	The Destructor.

Protected Member Functions
template<typename PixelType , unsigned int Dimension>
void	computeMeanDTIRunner (std::vector< std::string > &inpFiles, std::string &outputBase)
	Main mean algorithm for DTI images.
template<typename PixelType , unsigned int Dimension>
void	computeMeanRunner (std::vector< std::string > &inpFiles, std::string &outputBase)
	Main mean algorithm.
void	initializeClass (const std::vector< std::string > &inputFileNames, const std::string &output, const std::string &prefix)
	Checks the input and throws exception if there is an issue. More...
void	runAlgorithm ()
	Runs the algorithm.

Protected Attributes
itk::ImageIOBase::IOComponentType	m_componentType
std::string	m_componentType_asString
std::string	m_extension
std::vector< std::string >	m_inputFiles
std::vector< FileNameParts >	m_inputFiles_parts
std::vector< std::string >	m_outputBaseNames
std::string	m_outputDir
std::vector< std::string >	m_outputFiles
itk::ImageIOBase::IOPixelType	m_pixelType
std::string	m_pixelType_asString
std::string	m_prefix
std::string	m_suffix

Detailed Description

Computes the average of a series of images and writes the output.

Constructor & Destructor Documentation

ComputeAverageMap() [1/4]

ComputeAverageMap ( const std::vector< std::string > &  inputFiles, const std::string &  output  )

explicit

Actual Constructor.

Parameters

inputFiles	A vector of strings containing file names
output	The directory/file in which to write the files

ComputeAverageMap() [2/4]

ComputeAverageMap ( const std::vector< std::string > &  inputFiles, const std::string &  output, const bool  verbose  )

explicit

Actual Constructor.

Parameters

inputFiles	A vector of strings containing file names
output	The directory/file in which to write the files
verbose	A boolean to show verbose output

ComputeAverageMap() [3/4]

ComputeAverageMap ( const std::vector< std::string > &  inputFiles, const std::string &  output, const std::string &  prefix  )

explicit

Actual Constructor.

Parameters

inputFiles	A vector of strings containing file names
output	The directory/file in which to write the files
prefix	A string which is a prefix for all written files

ComputeAverageMap() [4/4]

ComputeAverageMap ( const std::vector< std::string > &  inputFiles, const std::string &  output, const bool  verbose, const std::string &  prefix  )

explicit

Actual Constructor.

Parameters

inputFiles	A vector of strings containing file names
output	The directory/file in which to write the files
verbose	A boolean to show verbose output
prefix	A string which is a prefix for all written files

Member Function Documentation

initializeClass()

void initializeClass ( const std::vector< std::string > &  inputFileNames, const std::string &  output, const std::string &  prefix  )

inlineprotectedinherited

Checks the input and throws exception if there is an issue.

This verifies the input image file and throws an exception if there is an issue. For variable (but required) inputs, please use checkInputs() function. If the inherited class doesn't have any required parameter other than the input, then checkInputs() can be left as an empty void function. If the output is empty, then cbica::createTmpDir() is invoked and the resultant directory is shown as output in the command line.

Parameters

inputFileNames	Wrap for m_inputFiles
output	Can have the output file or directory. If file is specified without path, it is written in temp dir created using cbica::createTmpDir()

SetParameters()

void SetParameters ( const std::vector< std::string > &  inputFileNames, const std::string &  output, const std::string &  prefix  )

virtual

Set the object parameters for the default () constructor.

Since this class utilizes only a single image (for multiple images, it can be called in a loop), setting the input as a vector will tell the algorithm to take the first file only.

Parameters

inputFileNames	Vector of input files
output	Output file/dir

Reimplemented from CommonHolder.

---

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

• src/classes/itk/cbicaITKComputeAverageMap.h