Common data container for all statistical computations of images.
More...
#include <cbicaITKCommonHolder.h>
|
| 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.
|
|
|
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...
|
|
|
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 |
|
Common data container for all statistical computations of images.
◆ CommonHolder() [1/7]
◆ CommonHolder() [2/7]
Actual Constructor.
ALL scalars are computed. Output is saved using cbica::createTmpDir()
- Parameters
-
inputFileName | The 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
-
inputFileNames | The Input File Names |
◆ CommonHolder() [4/7]
CommonHolder |
( |
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 |
◆ CommonHolder() [5/7]
CommonHolder |
( |
const std::vector< std::string > & |
inputFileNames, |
|
|
const std::string & |
output |
|
) |
| |
|
explicit |
Actual Constructor.
ALL scalars are computed.
- Parameters
-
inputFileNames | Vector of input file names |
output | The output file or directory |
◆ CommonHolder() [6/7]
CommonHolder |
( |
const std::string & |
inputFileName, |
|
|
const std::string & |
output, |
|
|
const std::string & |
prefix |
|
) |
| |
|
explicit |
Actual Constructor.
- Parameters
-
inputFileName | The Input File Name |
output | The output file or directory |
prefix | Prefix 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
-
inputFileNames | Vector of input file names |
output | The output file or directory |
prefix | Prefix for output. Disregarded if output is file |
◆ 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
-
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() |
◆ 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 |
The documentation for this class was generated from the following file: