CBICA Toolkit  1.0.0
ComputeVarianceMap Class Reference

Computes the variance map for a single image. More...

#include <cbicaITKComputeVarianceMap.h>

Inheritance diagram for ComputeVarianceMap:
Collaboration diagram for ComputeVarianceMap:

Public Member Functions

 ComputeVarianceMap ()
 Default Constructor. More...
 
 ComputeVarianceMap (const std::string &inputFileName, const std::string &output)
 Actual Constructor. More...
 
 ComputeVarianceMap (const std::vector< std::string > &inputFileNames, const std::string &output)
 Actual Constructor. More...
 
 ComputeVarianceMap (const std::string &inputFileName, const std::string &output, const std::string &prefix)
 Actual Constructor. More...
 
 ComputeVarianceMap (const std::vector< std::string > &inputFileNames, const std::string &output, 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 ~ComputeVarianceMap ()
 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< 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

Computes the variance map for a single image.

Todo:
Support for calculating variance for multiple images (groundwork is ready, just need to change the runAlgorithm() function

Constructor & Destructor Documentation

◆ ComputeVarianceMap() [1/5]

ComputeVarianceMap ( )
explicit

Default Constructor.

Use the SetParameters() method if this is used

◆ ComputeVarianceMap() [2/5]

ComputeVarianceMap ( 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

◆ ComputeVarianceMap() [3/5]

ComputeVarianceMap ( 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

◆ ComputeVarianceMap() [4/5]

ComputeVarianceMap ( 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

◆ ComputeVarianceMap() [5/5]

ComputeVarianceMap ( 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 
)
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
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()

◆ 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
inputFileNamesVector of input files
outputOutput file/dir

Reimplemented from CommonHolder.


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