Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::modelFit Namespace Reference

Classes

class  ModelFitException
 Class-specific exception for modelfits. More...
 
class  ModelFitInfo
 Data class that stores all information about a modelfit that is relevant to the visualization and stored as properties in the result nodes. More...
 
class  Parameter
 Data class that stores all information about a modelfit parameter. Such a parameter is going to be fitted for the according model. More...
 
class  StaticParameterMap
 

Typedefs

typedef std::set< ModelFitInfo::UIDTypeNodeUIDSetType
 
typedef std::map< ModelBase::ParameterNameType, Image::PointerModelFitResultImageMapType
 
typedef std::vector< DataNode::PointerModelFitResultNodeVectorType
 

Functions

MITKMODELFIT_EXPORT const std::string GetMandatoryProperty (const mitk::DataNode *node, const std::string &prop)
 Reads the string property with the given name from the data of the given node and returns its value. Throws a ModelFitException if the property doesn't exist. More...
 
MITKMODELFIT_EXPORT const std::string GetMandatoryProperty (const mitk::BaseData *data, const std::string &prop)
 Reads the string property with the given name from the given base data and returns its value. Throws a ModelFitException if the property doesn't exist. More...
 
MITKMODELFIT_EXPORT ModelFitInfo::Pointer CreateFitInfoFromNode (const ModelFitInfo::UIDType &uid, const mitk::DataStorage *storage)
 Creates a new ModelFitInfo instance from the nodes in the passed storage. The fit will be identified by the passed UID. Returns the instance on success. More...
 
MITKMODELFIT_EXPORT ModelFitInfo::Pointer CreateFitInfoFromModelParameterizer (const ModelParameterizerBase *usedParameterizer, mitk::BaseData *inputImage, const std::string &fitType, const std::string &fitName="", const NodeUIDType roiUID="")
 
MITKMODELFIT_EXPORT ModelFitInfo::Pointer CreateFitInfoFromModelParameterizer (const ModelParameterizerBase *usedParameterizer, mitk::BaseData *inputImage, const std::string &fitType, const ScalarListLookupTable &inputData, const std::string &fitName="", const NodeUIDType roiUID="")
 
MITKMODELFIT_EXPORT DataStorage::SetOfObjects::ConstPointer GetNodesOfFit (const ModelFitInfo::UIDType &fitUID, const mitk::DataStorage *storage)
 
MITKMODELFIT_EXPORT NodeUIDSetType GetFitUIDsOfNode (const mitk::DataNode *node, const mitk::DataStorage *storage)
 
MITKMODELFIT_EXPORT Parameter::Pointer ExtractParameterFromData (const mitk::BaseData *data)
 
MITKMODELFIT_EXPORT void SetModelFitDataProperties (mitk::BaseData *data, const ModelBase::ParameterNameType &name, modelFit::Parameter::Type dataType, const modelFit::ModelFitInfo *fitInfo)
 
MITKMODELFIT_EXPORT mitk::ScalarListLookupTableProperty::Pointer ConvertStaticParametersToProperty (const mitk::modelFit::StaticParameterMap &params)
 
MITKMODELFIT_EXPORT DataNode::Pointer CreateResultNode (const ModelBase::ParameterNameType &name, modelFit::Parameter::Type nodeType, Image *parameterImage, const ModelFitInfo *modelFitInfo)
 
MITKMODELFIT_EXPORT ModelFitResultNodeVectorType CreateResultNodeMap (const ModelFitResultImageMapType &results, const ModelFitResultImageMapType &derivedResults, const ModelFitResultImageMapType &criterionResults, const ModelFitResultImageMapType &evaluationResults, const ModelFitInfo *fitInfo)
 
MITKMODELFIT_EXPORT void StoreResultsInDataStorage (DataStorage *storage, const ModelFitResultNodeVectorType &resultNodes, DataNode *parentNode=nullptr)
 
bool operator< (const StaticParameterMap::ValueType &a, const StaticParameterMap::ValueType &b)
 Compares two var lists and returns true if the first list's first item is lower than the second one's. More...
 
void AdaptDataPropertyToParameter (mitk::BaseData *data, const ModelBase::ParameterNameType &name, modelFit::Parameter::Type dataType, const modelFit::ModelFitInfo *fitInfo)
 
void AdaptDataPropertyToModelFit (mitk::BaseData *data, const modelFit::ModelFitInfo *fitInfo)
 
mitk::DataNode::Pointer CreateNode (const ModelBase::ParameterNameType &name, Image *parameterImage, const ModelFitInfo *fitInfo)
 

Typedef Documentation

◆ ModelFitResultImageMapType

◆ ModelFitResultNodeVectorType

◆ NodeUIDSetType

Definition at line 190 of file mitkModelFitInfo.h.

Function Documentation

◆ AdaptDataPropertyToModelFit()

void mitk::modelFit::AdaptDataPropertyToModelFit ( mitk::BaseData data,
const modelFit::ModelFitInfo fitInfo 
)

Definition at line 85 of file mitkModelFitResultHelper.cpp.

References ConvertStaticParametersToProperty(), mitk::ModelFitConstants::FIT_INPUT_DATA_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_INPUT_IMAGEUID_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_INPUT_ROIUID_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_NAME_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_STATIC_PARAMETERS_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_TYPE_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_UID_PROPERTY_NAME(), mitk::modelFit::ModelFitInfo::fitName, mitk::modelFit::ModelFitInfo::fitType, mitk::modelFit::ModelFitInfo::function, mitk::modelFit::ModelFitInfo::functionClassID, mitk::ScalarListLookupTable::GetLookupTable(), mitk::BaseData::GetPropertyList(), mitk::modelFit::ModelFitInfo::inputData, mitk::modelFit::ModelFitInfo::inputUID, mitkThrow, mitk::ModelFitConstants::MODEL_FUNCTION_CLASS_PROPERTY_NAME(), mitk::ModelFitConstants::MODEL_FUNCTION_PROPERTY_NAME(), mitk::ModelFitConstants::MODEL_NAME_PROPERTY_NAME(), mitk::ModelFitConstants::MODEL_TYPE_PROPERTY_NAME(), mitk::ModelFitConstants::MODEL_X_PROPERTY_NAME(), mitk::modelFit::ModelFitInfo::modelName, mitk::modelFit::ModelFitInfo::modelType, mitk::modelFit::ModelFitInfo::roiUID, mitk::BaseData::SetProperty(), mitk::modelFit::ModelFitInfo::staticParamMap, mitk::modelFit::ModelFitInfo::uid, mitk::modelFit::ModelFitInfo::x, mitk::ModelFitConstants::XAXIS_NAME_PROPERTY_NAME(), mitk::ModelFitConstants::XAXIS_UNIT_PROPERTY_NAME(), mitk::modelFit::ModelFitInfo::xAxisName, mitk::modelFit::ModelFitInfo::xAxisUnit, mitk::ModelFitConstants::YAXIS_NAME_PROPERTY_NAME(), mitk::ModelFitConstants::YAXIS_UNIT_PROPERTY_NAME(), mitk::modelFit::ModelFitInfo::yAxisName, and mitk::modelFit::ModelFitInfo::yAxisUnit.

Referenced by SetModelFitDataProperties().

◆ AdaptDataPropertyToParameter()

◆ ConvertStaticParametersToProperty()

mitk::ScalarListLookupTableProperty::Pointer mitk::modelFit::ConvertStaticParametersToProperty ( const mitk::modelFit::StaticParameterMap params)

◆ CreateFitInfoFromModelParameterizer() [1/2]

mitk::modelFit::ModelFitInfo::Pointer mitk::modelFit::CreateFitInfoFromModelParameterizer ( const ModelParameterizerBase usedParameterizer,
mitk::BaseData inputImage,
const std::string &  fitType,
const std::string &  fitName = "",
const NodeUIDType  roiUID = "" 
)

creates a new ModelFitInfo instance from a passed modal instance and his traits instance*

Parameters
usedModelPointer to a model which was used for a fit, which should get a fit info created.
modelTraitsPointer to traits interface for the model that was used for the fit.
inputImagePointer to the input image. If it has no UID yet, a property will be added to the node.
fitTypeString identifying the type of the fit (e.g. ROI based or voxel based)
fitNameOptional human readable name of the fit.
roiUIDUID of the ROI, if one was used.
Returns
The newly created modelfit on success or NULL otherwise.

Definition at line 262 of file mitkModelFitInfo.cpp.

References mitk::EnsureModelFitUID(), mitk::modelFit::ModelFitInfo::fitName, mitk::modelFit::ModelFitInfo::fitType, mitk::ModelTraitsInterface::GetClassID(), mitk::ModelTraitsInterface::GetDerivedParameterNames(), mitk::ModelTraitsInterface::GetDerivedParameterScales(), mitk::ModelTraitsInterface::GetDerivedParameterUnits(), mitk::ModelTraitsInterface::GetFunctionString(), mitk::ModelParameterizerBase::GetGlobalStaticParameters(), mitk::ModelTraitsInterface::GetModelDisplayName(), mitk::ModelTraitsInterface::GetModelType(), mitk::ModelTraitsInterface::GetParameterNames(), mitk::ModelTraitsInterface::GetParameterScales(), mitk::ModelTraitsInterface::GetParameterUnits(), mitk::UIDGenerator::GetUID(), mitk::ModelTraitsInterface::GetXAxisName(), mitk::ModelTraitsInterface::GetXAxisUnit(), mitk::ModelTraitsInterface::GetXName(), mitk::ModelTraitsInterface::GetYAxisName(), mitk::ModelTraitsInterface::GetYAxisUnit(), mitk::modelFit::ModelFitInfo::inputImage, mitkThrow, mitk::modelFit::ModelFitInfo::roiUID, mitk::modelFit::ModelFitInfo::staticParamMap, and mitk::modelFit::ModelFitInfo::uid.

Referenced by CreateFitInfoFromModelParameterizer(), Generate3StepLinearModelFit_PixelBased(), Generate3StepLinearModelFit_ROIBased(), generateAIFbasedModelFit_PixelBased(), generateAIFbasedModelFit_ROIBased(), generateDescriptiveBrixModel_PixelBased(), and generateDescriptiveBrixModel_ROIBased().

◆ CreateFitInfoFromModelParameterizer() [2/2]

mitk::modelFit::ModelFitInfo::Pointer mitk::modelFit::CreateFitInfoFromModelParameterizer ( const ModelParameterizerBase usedParameterizer,
mitk::BaseData inputImage,
const std::string &  fitType,
const ScalarListLookupTable inputData,
const std::string &  fitName = "",
const NodeUIDType  roiUID = "" 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Overloaded version that allows additional definition of optional input data for the fit.

Definition at line 380 of file mitkModelFitInfo.cpp.

References CreateFitInfoFromModelParameterizer(), info(), and mitk::modelFit::ModelFitInfo::inputData.

◆ CreateFitInfoFromNode()

mitk::modelFit::ModelFitInfo::Pointer mitk::modelFit::CreateFitInfoFromNode ( const ModelFitInfo::UIDType uid,
const mitk::DataStorage storage 
)

Creates a new ModelFitInfo instance from the nodes in the passed storage. The fit will be identified by the passed UID. Returns the instance on success.

Parameters
uidThe uid of the fit that should get its ModelFitInfo created and which identifies the nodes in the storage.
storagePointer to the data storage containing any potential relevantThe nodes.
Returns
The newly created modelfit on success or NULL otherwise.

Definition at line 120 of file mitkModelFitInfo.cpp.

References ExtractParameterFromData(), mitk::ModelFitConstants::FIT_INPUT_DATA_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_INPUT_IMAGEUID_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_INPUT_ROIUID_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_NAME_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_STATIC_PARAMETERS_PROPERTY_NAME(), mitk::ModelFitConstants::FIT_TYPE_PROPERTY_NAME(), mitk::ScalarListLookupTable::GetLookupTable(), GetMandatoryProperty(), mitk::GetNodeByModelFitUID(), GetNodesOfFit(), mitk::modelFit::ModelFitInfo::inputImage, MITK_ERROR, mitk::ModelFitConstants::MODEL_FUNCTION_CLASS_PROPERTY_NAME(), mitk::ModelFitConstants::MODEL_FUNCTION_PROPERTY_NAME(), mitk::ModelFitConstants::MODEL_NAME_PROPERTY_NAME(), mitk::ModelFitConstants::MODEL_TYPE_PROPERTY_NAME(), mitk::ModelFitConstants::MODEL_X_PROPERTY_NAME(), mitk::modelFit::ModelFitInfo::uid, mitk::ModelFitConstants::XAXIS_NAME_PROPERTY_NAME(), mitk::ModelFitConstants::XAXIS_UNIT_PROPERTY_NAME(), mitk::ModelFitConstants::YAXIS_NAME_PROPERTY_NAME(), and mitk::ModelFitConstants::YAXIS_UNIT_PROPERTY_NAME().

Referenced by mitkModelFitInfoTest().

◆ CreateNode()

mitk::DataNode::Pointer mitk::modelFit::CreateNode ( const ModelBase::ParameterNameType name,
Image parameterImage,
const ModelFitInfo fitInfo 
)

◆ CreateResultNode()

MITKMODELFIT_EXPORT mitk::DataNode::Pointer mitk::modelFit::CreateResultNode ( const ModelBase::ParameterNameType name,
modelFit::Parameter::Type  nodeType,
Image parameterImage,
const ModelFitInfo modelFitInfo 
)

Definition at line 207 of file mitkModelFitResultHelper.cpp.

References CreateNode(), mitkThrow, and SetModelFitDataProperties().

Referenced by CreateResultNodeMap().

◆ CreateResultNodeMap()

MITKMODELFIT_EXPORT mitk::modelFit::ModelFitResultNodeVectorType mitk::modelFit::CreateResultNodeMap ( const ModelFitResultImageMapType results,
const ModelFitResultImageMapType derivedResults,
const ModelFitResultImageMapType criterionResults,
const ModelFitResultImageMapType evaluationResults,
const ModelFitInfo fitInfo 
)

Definition at line 225 of file mitkModelFitResultHelper.cpp.

References CreateResultNode(), and mitkThrow.

Referenced by ParameterFitBackgroundJob::run().

◆ ExtractParameterFromData()

mitk::modelFit::Parameter::Pointer mitk::modelFit::ExtractParameterFromData ( const mitk::BaseData data)

Extracts the parameter information stored in the data instance and returns it as parameter instance. If the data does not encode an parameter/fit result a Null pointer will be returned.

Parameters
dataThe data instance that contains parameter information that should be extracted.
Returns
The newly created parameter instance on success or NULL otherwise.

Definition at line 22 of file mitkModelFitParameter.cpp.

References mitk::BaseData::GetPropertyList(), mitk::ModelFitConstants::PARAMETER_NAME_PROPERTY_NAME(), mitk::ModelFitConstants::PARAMETER_SCALE_PROPERTY_NAME(), mitk::ModelFitConstants::PARAMETER_TYPE_PROPERTY_NAME(), mitk::ModelFitConstants::PARAMETER_TYPE_VALUE_CRITERION(), mitk::ModelFitConstants::PARAMETER_TYPE_VALUE_DERIVED_PARAMETER(), mitk::ModelFitConstants::PARAMETER_TYPE_VALUE_EVALUATION_PARAMETER(), and mitk::ModelFitConstants::PARAMETER_UNIT_PROPERTY_NAME().

Referenced by CreateFitInfoFromNode().

◆ GetFitUIDsOfNode()

mitk::modelFit::NodeUIDSetType mitk::modelFit::GetFitUIDsOfNode ( const mitk::DataNode node,
const mitk::DataStorage storage 
)

Returns the UIDs of all fits that are derived (directly or indirectly from the passed node).

Parameters
nodeThe node which defines the parent node. It will be searched in his derived nodes for fits.
storagePointer to the data storage containing any potential relevant nodes.
Returns
The set of found uid will be returned.

Definition at line 407 of file mitkModelFitInfo.cpp.

References mitk::ModelFitConstants::FIT_UID_PROPERTY_NAME(), mitk::DataStorage::GetDerivations(), mitk::NodePredicateDataProperty::New(), and mitk::modelFit::ModelFitInfo::uid.

Referenced by mitkModelFitInfoTest().

◆ GetMandatoryProperty() [1/2]

const std::string mitk::modelFit::GetMandatoryProperty ( const mitk::DataNode node,
const std::string &  prop 
)

Reads the string property with the given name from the data of the given node and returns its value. Throws a ModelFitException if the property doesn't exist.

Parameters
nodeThe node whose property value should be returned.
propThe name of the property that should be read.
Returns
The value of the found property.
Exceptions
ModelFitExceptionIf the property doesn't exist or returns an empty string.

Definition at line 87 of file mitkModelFitInfo.cpp.

References mitk::DataNode::GetData(), mitk::DataNode::GetName(), mitk::BaseData::GetPropertyList(), and mitkThrowException.

Referenced by CreateFitInfoFromNode(), and mitkModelFitInfoTest().

◆ GetMandatoryProperty() [2/2]

const std::string mitk::modelFit::GetMandatoryProperty ( const mitk::BaseData data,
const std::string &  prop 
)

Reads the string property with the given name from the given base data and returns its value. Throws a ModelFitException if the property doesn't exist.

Parameters
dataThe data whose property value should be returned.
propThe name of the property that should be read.
Returns
The value of the found property.
Exceptions
ModelFitExceptionIf the property doesn't exist or returns an empty string.

Definition at line 104 of file mitkModelFitInfo.cpp.

References mitk::BaseData::GetPropertyList(), and mitkThrowException.

◆ GetNodesOfFit()

mitk::DataStorage::SetOfObjects::ConstPointer mitk::modelFit::GetNodesOfFit ( const ModelFitInfo::UIDType fitUID,
const mitk::DataStorage storage 
)

Returns all nodes that belong to the fit indicated by the passed UID.

Parameters
fitUIDThe uid of the fit that is relevant for the query.
storagePointer to the data storage containing any potential relevant nodes.
Returns
The set of found nodes or null if storage is not valid.

Definition at line 393 of file mitkModelFitInfo.cpp.

References mitk::ModelFitConstants::FIT_UID_PROPERTY_NAME(), mitk::DataStorage::GetSubset(), mitk::NodePredicateDataProperty::New(), and mitk::StringProperty::New().

Referenced by CreateFitInfoFromNode(), and mitkModelFitInfoTest().

◆ operator<()

bool mitk::modelFit::operator< ( const StaticParameterMap::ValueType a,
const StaticParameterMap::ValueType b 
)
inline

Compares two var lists and returns true if the first list's first item is lower than the second one's.

Parameters
aThe first list to compare the other one to.
bThe other list to compare the first one to.
Returns
True if the first list's first item is smaller than the second one's.

Definition at line 139 of file mitkModelFitStaticParameterMap.h.

Referenced by Json::releaseStringValue(), and splitString().

◆ SetModelFitDataProperties()

MITKMODELFIT_EXPORT void mitk::modelFit::SetModelFitDataProperties ( mitk::BaseData data,
const ModelBase::ParameterNameType name,
modelFit::Parameter::Type  dataType,
const modelFit::ModelFitInfo fitInfo 
)

Helper function that sets the properties of the passed base data according to the given model fit info instance and parameter specification.

Parameters
dataInstance that properties should be configured.
nameName of the parameter this data instance represents.
dataTypeType of the parameter this data instance represents.
fitInfoInstance to the fit info that containes the information of the fit that derived the parameter.
Precondition
Data must point to a valid instance.
fitInfo must point to an valid instance.

Definition at line 201 of file mitkModelFitResultHelper.cpp.

References AdaptDataPropertyToModelFit(), and AdaptDataPropertyToParameter().

Referenced by CreateResultNode(), mitk::storeModelFitResultImage(), and storeResultImage().

◆ StoreResultsInDataStorage()