ComputeDtiScalars Class Reference

Computes the scalars of a single DTI image and writes the output. More...

#include <cbicaITKComputeDtiScalars.h>

Inheritance diagram for ComputeDtiScalars:

Collaboration diagram for ComputeDtiScalars:

Public Member Functions
	ComputeDtiScalars ()
	Default Constructor. More...
	ComputeDtiScalars (const std::string &inputFileName, const std::string &output)
	Actual Constructor. More...
	ComputeDtiScalars (const std::string &inputFileName, const std::string &output, const std::string &parameters)
	Actual Constructor. More...
	ComputeDtiScalars (const std::string &inputFileName, const std::string &output, const std::string &parameters, const std::string &prefix)
	Actual Constructor. More...
void	SetParameters (const std::string &inputFileName, const std::string &output, const std::string &parameters, const std::string &prefix)
	Set the object parameters for the default () 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	~ComputeDtiScalars ()
	The Destructor.

Protected Member Functions
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...

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 scalars of a single DTI image and writes the output.

Todo:

Reuqired for multiple images?

Constructor & Destructor Documentation

ComputeDtiScalars() [1/4]

ComputeDtiScalars ( )

explicit

Default Constructor.

Use the SetParameters() method if this is used

ComputeDtiScalars() [2/4]

ComputeDtiScalars ( const std::string &  inputFileName, const std::string &  output  )

explicit

Actual Constructor.

ALL scalars are computed.

Parameters

inputFileName	The Input File Name
output	The output file or directory

ComputeDtiScalars() [3/4]

ComputeDtiScalars ( const std::string &  inputFileName, const std::string &  output, const std::string &  parameters  )

explicit

Actual Constructor.

Available options:

• FA : FA images
• EIG : Eigensystem images
• GEO : Geoemtric features
• SKEW : Tensor Skewness
• KURT : Tensor kurtosis
• RADAX: Radial and Axial diffusivity
• GORDR: Gordon's R measures
• GORDK: Gordon's K measures
• ALL : All of the above (default)

Parameters

inputFileName	The Input File Name
output	The output file or directory
parameters	A string of requested parameters (mixed case characters allowed)

ComputeDtiScalars() [4/4]

ComputeDtiScalars ( const std::string &  inputFileName, const std::string &  output, const std::string &  parameters, const std::string &  prefix  )

explicit

Actual Constructor.

Parameters

inputFileName	The Input File Name
output	The output file or directory
parameters	A string of requested parameters (mixed case characters allowed)
prefix	Prefix for output. Disregarded if output is file

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() [1/2]

void SetParameters	(	const std::string &	inputFileName,
		const std::string &	output,
		const std::string &	parameters,
		const std::string &	prefix
	)

Set the object parameters for the default () constructor.

Parameters

inputFileName	The Input File Name
output	Output file/dir
parameters	A string of requested parameters (mixed case characters allowed)
prefix	For written file(s)

SetParameters() [2/2]

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/cbicaITKComputeDtiScalars.h