CBICA Toolkit  1.0.0
CommonHolder Class Reference

Common data container for all statistical computations of images. More...

#include <cbicaITKCommonHolder.h>

Inheritance diagram for CommonHolder:

Public Member Functions

 CommonHolder ()
 Default Constructor. More...
 
 CommonHolder (const std::string &inputFileName)
 Actual Constructor. More...
 
 CommonHolder (const std::vector< std::string > &inputFileNames)
 Actual Constructor. More...
 
 CommonHolder (const std::string &inputFileName, const std::string &output)
 Actual Constructor. More...
 
 CommonHolder (const std::vector< std::string > &inputFileNames, const std::string &output)
 Actual Constructor. More...
 
 CommonHolder (const std::string &inputFileName, const std::string &output, const std::string &prefix)
 Actual Constructor. More...
 
 CommonHolder (const std::vector< std::string > &inputFileNames, const std::string &output, const std::string &prefix)
 Actual Constructor. More...
 
virtual ~CommonHolder ()
 The Destructor.
 

Protected Member Functions

virtual void checkInputs ()
 Exception handling for input file names.
 
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...
 
virtual void runAlgorithm ()
 Main function to call different algorithms. More...
 
virtual void SetParameters (const std::vector< std::string > &inputFileNames, const std::string &output, const std::string &prefix)
 Set parameters after using default constructor. 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< FileNamePartsm_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

Common data container for all statistical computations of images.

Constructor & Destructor Documentation

◆ CommonHolder() [1/7]

CommonHolder ( )
explicit

Default Constructor.

Use the SetParameters() method if this is used

◆ CommonHolder() [2/7]

CommonHolder ( const std::string &  inputFileName)
explicit

Actual Constructor.

ALL scalars are computed. Output is saved using cbica::createTmpDir()

Parameters
inputFileNameThe Input File Name

◆ CommonHolder() [3/7]

CommonHolder ( const std::vector< std::string > &  inputFileNames)
explicit

Actual Constructor.

ALL scalars are computed. Output is saved using cbica::createTmpDir()

Parameters
inputFileNamesThe Input File Names

◆ CommonHolder() [4/7]

CommonHolder ( const std::string &  inputFileName,
const std::string &  output 
)
explicit

Actual Constructor.

ALL scalars are computed.

Parameters
inputFileNameThe Input File Name
outputThe output file or directory

◆ CommonHolder() [5/7]

CommonHolder ( const std::vector< std::string > &  inputFileNames,
const std::string &  output 
)
explicit

Actual Constructor.

ALL scalars are computed.

Parameters
inputFileNamesVector of input file names
outputThe output file or directory

◆ CommonHolder() [6/7]

CommonHolder ( const std::string &  inputFileName,
const std::string &  output,
const std::string &  prefix 
)
explicit

Actual Constructor.

Parameters
inputFileNameThe Input File Name
outputThe output file or directory
prefixPrefix for output. Disregarded if output is file

◆ CommonHolder() [7/7]

CommonHolder ( const std::vector< std::string > &  inputFileNames,
const std::string &  output,
const std::string &  prefix 
)
explicit

Actual Constructor.

Parameters
inputFileNamesVector of input file names
outputThe output file or directory
prefixPrefix 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 
)
inlineprotected

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
inputFileNamesWrap for m_inputFiles
outputCan have the output file or directory. If file is specified without path, it is written in temp dir created using cbica::createTmpDir()

◆ runAlgorithm()

virtual void runAlgorithm ( )
protectedvirtual

Main function to call different algorithms.

All inheriting classes need to implement this method. It should interface with initializeClass().

Reimplemented in ComputeAverageMap.

◆ SetParameters()

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

Set parameters after using default constructor.

Parameters
inputFileNamesVector of input file(s)
outputOutput file/dir
prefixFor output

Reimplemented in ComputeDtiScalars, ComputeAverageMap, and ComputeVarianceMap.


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