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
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
Class to collect messages and errors related to a given frame handle.
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.
bool isTiffFilePairPart
True if this file is the Tiff file of a DCM/Tiff file pair.
FileTypeFlags
Flag bits describing file types.
@ IsOther
File belongs to a DCM/TIFF pair or it is any other file, but it is no normal DICOM file.
@ IsUnknownOrInvalidFileType
The given path does not describe a known file type.
@ IsValidDCMFrame
File is a valid DICOM frame (but it is not part of a DCM/Tif pair).
@ IsValidFile
The given path describes a file whose format was detected by extension- or file header analysis.
@ IsMLImage
The file is an .mlimage file.
@ IsDCMTiffPair
File belongs to a DCM/Tiff file pair (either a TIFF or a reduced DICOM file).
@ AllFileTypeBits
All possibly set bits ORed together. Does not describe a valid mode.
DCMTree::Const_TreePtr getDcmTree(DicomMessageCollector &dcmMsgCollector, bool alsoGetFromMLImage=false, bool alsoGetFromDCMTIFF=false, bool tryDCMLoad=false) const
FileAttribute(const DICOMCachedIOFileHandle &absoluteFilePath=DICOMCachedIOFileHandle(), bool passObject=true, std::string volLabel="", std::string importCfg="", std::string procSettings="", MLuint32 fileTypeMaskArg=0)
unsigned int MLuint32
Definition mlTypeDefs.h:184
boost::shared_ptr< const Tree > Const_TreePtr
Definition DCMTree_Lib.h:67
FileListTools::FileAttribute DirectDicomImportImportFileAttribute
For backward compatibility:
DICOMCachedIOFileHandleBase< char > DICOMCachedIOFileHandle
"Forward" to DICOMCachedIOFileHandle.