Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::cl::CLResultXMLWriter Class Reference

Writes classification feature results to an XML file. More...

#include <mitkCLResultXMLWriter.h>

Public Member Functions

 CLResultXMLWriter ()=default
 
 ~CLResultXMLWriter ()=default
 
void SetImage (const Image *image)
 Set the intensity image whose features were computed. More...
 
void SetMask (const Image *mask)
 Set the mask image used for feature computation. More...
 
void SetFeatures (const mitk::AbstractGlobalImageFeature::FeatureListType &features)
 Set the computed feature list to be written. More...
 
void SetMethodName (const std::string &name)
 Set the name of the analysis method. More...
 
void SetMethodVersion (const std::string &version)
 Set the version of the analysis method. More...
 
void SetOrganisation (const std::string &orga)
 Set the organisation performing the analysis. More...
 
void SetPipelineUID (const std::string &pipelineUID)
 Set the unique identifier of the analysis pipeline. More...
 
void SetCLIArgs (const std::map< std::string, us::Any > &args)
 Set the command-line arguments used for the analysis. More...
 
void write (const std::string &filePath) const
 Write the XML output to a file. More...
 
void write (std::ostream &stream) const
 Write the XML output to a stream. More...
 

Detailed Description

Writes classification feature results to an XML file.

Serializes image metadata, mask information, computed features, and pipeline metadata (method name, version, organisation) into a structured XML format.

Definition at line 31 of file mitkCLResultXMLWriter.h.

Constructor & Destructor Documentation

◆ CLResultXMLWriter()

mitk::cl::CLResultXMLWriter::CLResultXMLWriter ( )
default

◆ ~CLResultXMLWriter()

mitk::cl::CLResultXMLWriter::~CLResultXMLWriter ( )
default

Member Function Documentation

◆ SetCLIArgs()

void mitk::cl::CLResultXMLWriter::SetCLIArgs ( const std::map< std::string, us::Any > &  args)

Set the command-line arguments used for the analysis.

Parameters
argsMap of argument names to values.

◆ SetFeatures()

void mitk::cl::CLResultXMLWriter::SetFeatures ( const mitk::AbstractGlobalImageFeature::FeatureListType &  features)

Set the computed feature list to be written.

Parameters
featuresThe list of feature name-value pairs.

◆ SetImage()

void mitk::cl::CLResultXMLWriter::SetImage ( const Image *  image)

Set the intensity image whose features were computed.

Parameters
imagePointer to the input image.

◆ SetMask()

void mitk::cl::CLResultXMLWriter::SetMask ( const Image *  mask)

Set the mask image used for feature computation.

Parameters
maskPointer to the mask image.

◆ SetMethodName()

void mitk::cl::CLResultXMLWriter::SetMethodName ( const std::string &  name)

Set the name of the analysis method.

Parameters
nameThe method name string.

◆ SetMethodVersion()

void mitk::cl::CLResultXMLWriter::SetMethodVersion ( const std::string &  version)

Set the version of the analysis method.

Parameters
versionThe version string.

◆ SetOrganisation()

void mitk::cl::CLResultXMLWriter::SetOrganisation ( const std::string &  orga)

Set the organisation performing the analysis.

Parameters
orgaThe organisation name.

◆ SetPipelineUID()

void mitk::cl::CLResultXMLWriter::SetPipelineUID ( const std::string &  pipelineUID)

Set the unique identifier of the analysis pipeline.

Parameters
pipelineUIDThe pipeline UID string.

◆ write() [1/2]

void mitk::cl::CLResultXMLWriter::write ( const std::string &  filePath) const

Write the XML output to a file.

Parameters
filePathPath to the output XML file.

◆ write() [2/2]

void mitk::cl::CLResultXMLWriter::write ( std::ostream &  stream) const

Write the XML output to a stream.

Parameters
streamThe output stream to write to.

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