Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Static Public Member Functions | List of all members
mitk::CollectionWriter Class Reference

#include <mitkCollectionWriter.h>

Static Public Member Functions

static bool ExportCollectionToFolder (DataCollection *dataCollection, std::string xmlFile, std::vector< std::string > filter)
 ExportCollectionToFolder. More...
 
static bool ExportCollectionToFolder (DataCollection *dataCollection, std::string xmlFile)
 
static bool SaveCollection (DataCollection *dataCollection, std::vector< std::string > filter, std::string xmlFile="")
 SaveCollection - Stores data collection at original location. More...
 
static bool FolderToXml (std::string folder, std::string collectionType, std::string xmlFile, std::vector< std::string > filter, std::vector< std::string > seriesNames)
 
static bool SingleFolderToXml (std::string folder, std::string xmlFile, std::vector< std::string > filter, std::vector< std::string > seriesNames, bool longDate=true, int skipUntil=0, float months=0)
 

Detailed Description

Definition at line 22 of file mitkCollectionWriter.h.

Member Function Documentation

◆ ExportCollectionToFolder() [1/2]

bool mitk::CollectionWriter::ExportCollectionToFolder ( DataCollection *  dataCollection,
std::string  xmlFile,
std::vector< std::string >  filter 
)
static

ExportCollectionToFolder.

Creates an XML file and stores all data in the same folder as the xml file (creating sub-folders for sub-collections)

Parameters
dataCollection
xmlFile
filter- (optional) only items with names contained in this list are written, if list is empty all items are written
Returns

Definition at line 71 of file mitkCollectionWriter.cpp.

References COLLECTION, DATA, FILEPATH, mitk::DataCollection::GetData(), mitk::DataCollection::GetDataFilePath(), mitk::DataCollection::GetMitkImage(), mitk::DataCollection::GetName(), image, mitk::DataCollection::IndexToName(), ITEM, LINK, MITK_ERROR, NAME, mitk::IOUtil::Save(), mitk::DataCollection::Size(), and SUBCOLLECTION.

Referenced by ExportCollectionToFolder(), and main().

◆ ExportCollectionToFolder() [2/2]

bool mitk::CollectionWriter::ExportCollectionToFolder ( mitk::DataCollection *  dataCollection,
std::string  xmlFile 
)
static

Definition at line 162 of file mitkCollectionWriter.cpp.

References ExportCollectionToFolder().

◆ FolderToXml()

bool mitk::CollectionWriter::FolderToXml ( std::string  folder,
std::string  collectionType,
std::string  xmlFile,
std::vector< std::string >  filter,
std::vector< std::string >  seriesNames 
)
static

Definition at line 274 of file mitkCollectionWriter.cpp.

References COLLECTION, DATA, FILEPATH, mitk::CollectionReader::GenerateFileLists(), GetDate(), GetName(), ITEM, k(), LINK, MITK_INFO, MITK_WARN, NAME, mitk::CollectionReader::SanitizeFileList(), and SUBCOLLECTION.

◆ SaveCollection()

bool mitk::CollectionWriter::SaveCollection ( mitk::DataCollection *  dataCollection,
std::vector< std::string >  filter,
std::string  xmlFile = "" 
)
static

SaveCollection - Stores data collection at original location.

Writes the collection back to the files given in the original XML file. New data items are stored into the default location, which is relative to the XML file.

If a XML file is provided the files are stored as stated above with the differences that a new XML file is generated and new files are saved relative to the newly generated xml.

Parameters
dataCollection
filter
xmlFile
Returns

Definition at line 168 of file mitkCollectionWriter.cpp.

References COLLECTION, DATA, FILEPATH, mitk::DataCollection::GetData(), mitk::DataCollection::GetDataFilePath(), mitk::DataCollection::GetMitkImage(), mitk::DataCollection::GetName(), mitk::DataCollection::GetXMLFile(), image, mitk::DataCollection::IndexToName(), ITEM, LINK, MITK_ERROR, MITK_INFO, NAME, mitk::IOUtil::Save(), mitk::DataCollection::Size(), and SUBCOLLECTION.

◆ SingleFolderToXml()

bool mitk::CollectionWriter::SingleFolderToXml ( std::string  folder,
std::string  xmlFile,
std::vector< std::string >  filter,
std::vector< std::string >  seriesNames,
bool  longDate = true,
int  skipUntil = 0,
float  months = 0 
)
static

Definition at line 341 of file mitkCollectionWriter.cpp.

References COLLECTION, DATA, FILEPATH, mitk::CollectionReader::GenerateFileLists(), GetDate(), GetName(), ITEM, k(), LINK, NAME, mitk::CollectionReader::SanitizeFileList(), and SUBCOLLECTION.

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