MeVisLab Toolbox Reference
mlFileListToolsFileAttribute.h
Go to the documentation of this file.
1// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2// **InsertLicense** code
3//----------------------------------------------------------------------------------
6
11//----------------------------------------------------------------------------------
12
13#pragma once
14
15// Local includes
17
18// ML includes
19#include <mlTypeDefs.h>
20#include <FMEThirdPartyWarningsDisable.h>
21#include <string>
22#include <FMEThirdPartyWarningsRestore.h>
23#include <mlErrorMacros.h>
25
26// DCMTree prototypes.
27#include <DCMTree_Lib.h>
28
29ML_START_NAMESPACE
30
31// Forwards
32class DicomMessageCollector;
33
34namespace FileListTools {
35
36//-------------------------------------------------------------------------------
39//-------------------------------------------------------------------------------
41 public:
42
55 bool passObject = true,
56 std::string volLabel = "",
57 std::string importCfg = "",
58 std::string procSettings = "",
59 MLuint32 fileTypeMaskArg = 0) :
60 filePath (absoluteFilePath),
61 pass (passObject),
62 volumeLabel (volLabel),
63 importConfig (importCfg),
64 processingSettings(procSettings),
65 fileTypeMask (fileTypeMaskArg),
66 otherFile (),
67 isDCMFilePairPart (false),
68 isTiffFilePairPart(false),
69 isDecomposed (false)
70 {
71 }
72
75 IsValidFile = 1,
76 IsOther = 2,
77 IsDCMTiffPair = 4,
78 IsValidDCMFrame = 8,
79 IsUnknownOrInvalidFileType = 16,
80 IsMLImage = 32,
81
82 AllFileTypeBits = 63
83 };
84
85
88
102 bool alsoGetFromMLImage=false,
103 bool alsoGetFromDCMTIFF=false,
104 bool tryDCMLoad=false) const;
105
106 bool pass;
108
109 std::string volumeLabel;
112
113 std::string importConfig;
117
125
127
128 std::string otherFile;
130
133
136};
137
138}; // end namespace FileListTools.
139
142
143
144ML_END_NAMESPACE
Project global and OS specific declarations.
Class to collect messages and errors related to a given frame handle.
Attributes assigned to files in a FileList according to filter operations on the file names or DICOM ...
bool isDCMFilePairPart
True if this file is the DICOM file of a DCM/Tiff file pair.
MLuint32 fileTypeMask
Bit combination of FileTypeFlags describing the type of file.
std::string importConfig
If non empty then volumes with identical volumeLabel importConfig, and processingSettings will be han...
std::string processingSettings
If non empty then volumes with identical volumeLabel, importConfig, and processingSettings will be ha...
bool isTiffFilePairPart
True if this file is the Tiff file of a DCM/Tiff file pair.
std::string otherFile
If a file pair calculation was done then this stores the other part of the file pair,...
FileTypeFlags
Flag bits describing file types.
DCMTree::Const_TreePtr getDcmTree(DicomMessageCollector &dcmMsgCollector, bool alsoGetFromMLImage=false, bool alsoGetFromDCMTIFF=false, bool tryDCMLoad=false) const
Gets the (cached) tree related to the file name (or loads it if necessary).
bool isDecomposed
True if this file is only a decomposed part or frame of a larger file or tree, typically a single DIC...
std::string volumeLabel
Normally "" but can be set to a label stored in the created MultiFileVolume.
DICOMCachedIOFileHandle filePath
Absolute file name of the file and/or DCMTree, usually only set by creator.
FileAttribute(const DICOMCachedIOFileHandle &absoluteFilePath=DICOMCachedIOFileHandle(), bool passObject=true, std::string volLabel="", std::string importCfg="", std::string procSettings="", MLuint32 fileTypeMaskArg=0)
Constructor to initialize all members with default or with user defined values.
bool pass
If set to true (the default) then the object will be used and passed to the importer,...
Header of FileHandle class which should be used in DICOM importing modules to resolve the filename fo...
unsigned int MLuint32
Definition mlTypeDefs.h:184
boost::shared_ptr< const Tree > Const_TreePtr
Definition DCMTree_Lib.h:67
Namespace containing a number of tools and classes to scan directories for files, assign attributes t...