Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Public Attributes | List of all members
mitk::FiberfoxParameters< ScalarType > Class Template Reference

Datastructure to manage the Fiberfox signal generation parameters. More...

#include <mitkFiberfoxParameters.h>

Inheritance diagram for mitk::FiberfoxParameters< ScalarType >:
Inheritance graph
[legend]
Collaboration diagram for mitk::FiberfoxParameters< ScalarType >:
Collaboration graph
[legend]

Public Types

typedef itk::Image< double, 3 > ItkDoubleImgType
 
typedef itk::Image< unsigned char, 3 > ItkUcharImgType
 
typedef DiffusionSignalModel< ScalarType > DiffusionModelType
 
typedef std::vector< DiffusionModelType * > DiffusionModelListType
 
typedef DiffusionNoiseModel< ScalarType > NoiseModelType
 

Public Member Functions

 FiberfoxParameters ()
 
 ~FiberfoxParameters ()
 
template<class OutType >
FiberfoxParameters< OutType > CopyParameters ()
 
void PrintSelf ()
 Print parameters to stdout. More...
 
void SaveParameters (string filename)
 Save image generation parameters to .ffp file. More...
 
void LoadParameters (string filename)
 Load image generation parameters from .ffp file. More...
 
template<class ParameterType >
ParameterType ReadVal (boost::property_tree::ptree::value_type const &v, std::string tag, ParameterType defaultValue, bool essential=false)
 

Public Attributes

FiberGenerationParameters m_FiberGen
 Fiber generation parameters. More...
 
SignalGenerationParameters m_SignalGen
 Signal generation parameters. More...
 
MiscFiberfoxParameters m_Misc
 GUI realted and I/O parameters. More...
 
DiffusionModelListType m_FiberModelList
 Intra- and inter-axonal compartments. More...
 
DiffusionModelListType m_NonFiberModelList
 Extra-axonal compartments. More...
 
std::shared_ptr< NoiseModelType > m_NoiseModel
 If != NULL, noise is added to the image. More...
 
std::string m_MissingTags
 

Detailed Description

template<class ScalarType = double>
class mitk::FiberfoxParameters< ScalarType >

Datastructure to manage the Fiberfox signal generation parameters.

Definition at line 268 of file mitkFiberfoxParameters.h.

Member Typedef Documentation

template<class ScalarType = double>
typedef std::vector< DiffusionModelType* > mitk::FiberfoxParameters< ScalarType >::DiffusionModelListType

Definition at line 275 of file mitkFiberfoxParameters.h.

template<class ScalarType = double>
typedef DiffusionSignalModel<ScalarType> mitk::FiberfoxParameters< ScalarType >::DiffusionModelType

Definition at line 274 of file mitkFiberfoxParameters.h.

template<class ScalarType = double>
typedef itk::Image<double, 3> mitk::FiberfoxParameters< ScalarType >::ItkDoubleImgType

Definition at line 272 of file mitkFiberfoxParameters.h.

template<class ScalarType = double>
typedef itk::Image<unsigned char, 3> mitk::FiberfoxParameters< ScalarType >::ItkUcharImgType

Definition at line 273 of file mitkFiberfoxParameters.h.

template<class ScalarType = double>
typedef DiffusionNoiseModel<ScalarType> mitk::FiberfoxParameters< ScalarType >::NoiseModelType

Definition at line 276 of file mitkFiberfoxParameters.h.

Constructor & Destructor Documentation

template<class ScalarType >
mitk::FiberfoxParameters< ScalarType >::FiberfoxParameters ( )

Definition at line 26 of file mitkFiberfoxParameters.cpp.

template<class ScalarType >
mitk::FiberfoxParameters< ScalarType >::~FiberfoxParameters ( )

Definition at line 33 of file mitkFiberfoxParameters.cpp.

Member Function Documentation

template<class ScalarType = double>
template<class OutType >
FiberfoxParameters< OutType > mitk::FiberfoxParameters< ScalarType >::CopyParameters ( )
inline

Get same parameter object with different template parameter

Definition at line 283 of file mitkFiberfoxParameters.h.

template<class ScalarType = double>
void mitk::FiberfoxParameters< ScalarType >::LoadParameters ( string  filename)

Load image generation parameters from .ffp file.

Definition at line 450 of file mitkFiberfoxParameters.cpp.

References mitk::FiberGenerationParameters::DISTRIBUTE_GAUSSIAN, mitk::FiberGenerationParameters::DISTRIBUTE_UNIFORM, mitk::RawShModel< ScalarType >::GetAdcRange(), mitk::BallModel< ScalarType >::GetDiffusivity(), mitk::StickModel< ScalarType >::GetDiffusivity(), mitk::AstroStickModel< ScalarType >::GetDiffusivity(), mitk::TensorModel< ScalarType >::GetDiffusivity1(), mitk::TensorModel< ScalarType >::GetDiffusivity2(), mitk::TensorModel< ScalarType >::GetDiffusivity3(), mitk::RawShModel< ScalarType >::GetFaRange(), mitk::RawShModel< ScalarType >::GetMaxNumKernels(), mitk::AstroStickModel< ScalarType >::GetRandomizeSticks(), mitk::DiffusionSignalModel< ScalarType >::GetT1(), mitk::DiffusionSignalModel< ScalarType >::GetT2(), mitk::DiffusionSignalModel< ScalarType >::m_CompartmentId, max(), MITK_DEBUG, MITK_INFO, MITK_WARN, mitk::New(), mitk::RawShModel< ScalarType >::SetAdcRange(), mitk::BallModel< ScalarType >::SetDiffusivity(), mitk::StickModel< ScalarType >::SetDiffusivity(), mitk::AstroStickModel< ScalarType >::SetDiffusivity(), mitk::TensorModel< ScalarType >::SetDiffusivity1(), mitk::TensorModel< ScalarType >::SetDiffusivity2(), mitk::TensorModel< ScalarType >::SetDiffusivity3(), mitk::RawShModel< ScalarType >::SetFaRange(), mitk::DiffusionSignalModel< ScalarType >::SetGradientList(), mitk::RawShModel< ScalarType >::SetMaxNumKernels(), mitk::AstroStickModel< ScalarType >::SetRandomizeSticks(), mitk::RawShModel< ScalarType >::SetShCoefficients(), mitk::DiffusionSignalModel< ScalarType >::SetT1(), mitk::DiffusionSignalModel< ScalarType >::SetT2(), and mitk::DiffusionSignalModel< ScalarType >::SetVolumeFractionImage().

Referenced by main().

template<class ScalarType >
void mitk::FiberfoxParameters< ScalarType >::PrintSelf ( )

Print parameters to stdout.

Definition at line 852 of file mitkFiberfoxParameters.cpp.

References MITK_INFO.

template<class ScalarType >
template<class ParameterType >
ParameterType mitk::FiberfoxParameters< ScalarType >::ReadVal ( boost::property_tree::ptree::value_type const &  v,
std::string  tag,
ParameterType  defaultValue,
bool  essential = false 
)

Definition at line 427 of file mitkFiberfoxParameters.cpp.

References MITK_INFO, and mitkThrow.

template<class ScalarType = double>
void mitk::FiberfoxParameters< ScalarType >::SaveParameters ( string  filename)

Save image generation parameters to .ffp file.

Definition at line 173 of file mitkFiberfoxParameters.cpp.

References mitk::RawShModel< ScalarType >::GetAdcRange(), mitk::RawShModel< ScalarType >::GetBaselineSignal(), mitk::RawShModel< ScalarType >::GetCoefficients(), mitk::BallModel< ScalarType >::GetDiffusivity(), mitk::StickModel< ScalarType >::GetDiffusivity(), mitk::AstroStickModel< ScalarType >::GetDiffusivity(), mitk::TensorModel< ScalarType >::GetDiffusivity1(), mitk::TensorModel< ScalarType >::GetDiffusivity2(), mitk::TensorModel< ScalarType >::GetDiffusivity3(), mitk::RawShModel< ScalarType >::GetFaRange(), mitk::RawShModel< ScalarType >::GetMaxNumKernels(), mitk::RawShModel< ScalarType >::GetNumberOfKernels(), mitk::AstroStickModel< ScalarType >::GetRandomizeSticks(), mitk::RawShModel< ScalarType >::GetShOrder(), mitk::DiffusionSignalModel< ScalarType >::GetT1(), mitk::DiffusionSignalModel< ScalarType >::GetT2(), mitk::DiffusionSignalModel< ScalarType >::GetVolumeFractionImage(), mitk::DiffusionSignalModel< ScalarType >::m_CompartmentId, MITK_INFO, and mitk::New().

Referenced by main().

Member Data Documentation

template<class ScalarType = double>
FiberGenerationParameters mitk::FiberfoxParameters< ScalarType >::m_FiberGen

Fiber generation parameters.

Not templated parameters

Definition at line 332 of file mitkFiberfoxParameters.h.

Referenced by mitk::FiberfoxParameters< double >::CopyParameters().

template<class ScalarType = double>
DiffusionModelListType mitk::FiberfoxParameters< ScalarType >::m_FiberModelList

Intra- and inter-axonal compartments.

Templated parameters

Definition at line 337 of file mitkFiberfoxParameters.h.

Referenced by mitk::FiberfoxParameters< double >::CopyParameters().

template<class ScalarType = double>
MiscFiberfoxParameters mitk::FiberfoxParameters< ScalarType >::m_Misc

GUI realted and I/O parameters.

Definition at line 334 of file mitkFiberfoxParameters.h.

Referenced by mitk::CartesianReadout::AdjustEchoTime(), mitk::SingleShotEpi::AdjustEchoTime(), mitk::FiberfoxParameters< double >::CopyParameters(), and main().

template<class ScalarType = double>
std::string mitk::FiberfoxParameters< ScalarType >::m_MissingTags

Definition at line 346 of file mitkFiberfoxParameters.h.

template<class ScalarType = double>
std::shared_ptr< NoiseModelType > mitk::FiberfoxParameters< ScalarType >::m_NoiseModel

If != NULL, noise is added to the image.

Definition at line 339 of file mitkFiberfoxParameters.h.

Referenced by mitk::FiberfoxParameters< double >::CopyParameters().

template<class ScalarType = double>
DiffusionModelListType mitk::FiberfoxParameters< ScalarType >::m_NonFiberModelList

Extra-axonal compartments.

Definition at line 338 of file mitkFiberfoxParameters.h.

Referenced by mitk::FiberfoxParameters< double >::CopyParameters().

template<class ScalarType = double>
SignalGenerationParameters mitk::FiberfoxParameters< ScalarType >::m_SignalGen

Signal generation parameters.

Definition at line 333 of file mitkFiberfoxParameters.h.

Referenced by mitk::CartesianReadout::AdjustEchoTime(), mitk::SingleShotEpi::AdjustEchoTime(), mitk::CartesianReadout::CartesianReadout(), mitk::FiberfoxParameters< double >::CopyParameters(), mitk::CartesianReadout::GetActualKspaceIndex(), mitk::SingleShotEpi::GetActualKspaceIndex(), main(), and mitk::SingleShotEpi::SingleShotEpi().

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