MeVisLab Toolbox Reference
mlImageFormatCompressionParams.h
Go to the documentation of this file.
1
/*************************************************************************************
2
**
3
** Copyright 2007, MeVis Medical Solutions AG
4
**
5
** The user may use this file in accordance with the license agreement provided with
6
** the Software or, alternatively, in accordance with the terms contained in a
7
** written agreement between the user and MeVis Medical Solutions AG.
8
**
9
** For further information use the contact form at https://www.mevislab.de/contact
10
**
11
**************************************************************************************/
12
13
#ifndef ML_IMAGE_FORMAT_COMPRESSION_PARAMS_H
14
#define ML_IMAGE_FORMAT_COMPRESSION_PARAMS_H
15
17
18
// Local includes
19
#include "
MLImageFormatBaseSystem.h
"
20
21
// ML includes
22
#include "
mlModuleIncludes.h
"
23
24
#include "
mlImageFormatTagList.h
"
25
26
#include "
mlDataCompressor.h
"
27
28
29
ML_START_NAMESPACE
30
31
// Forward declaration.
32
class
MLImageFormat;
33
34
// ----------------------------------------------------------
36
// ----------------------------------------------------------
37
class
MLIMAGEFORMATBASE_EXPORT
MLImageFormatCompressionParams
{
38
39
public
:
40
42
MLImageFormatCompressionParams
(
Module
&baseOp);
43
46
EnumField
&
getCompressorNameFld
()
const
{
return
*
_compressorNameFld
; }
47
NotifyField
&
getUpdateHintControlsFld
()
const
{
return
*
_updateHintControlsFld
; }
48
const
std::vector<std::string> &
getCompressorNames
()
const
{
return
_compressorNames
; }
49
MLImageFormatTagList
&
getCompressorArgs
() {
return
_compressorArgs
; }
50
StringField
*
const
*
getHintNameFlds
()
const
{
return
_hintNameFld
; }
51
DoubleField
*
const
*
getDblHintValFlds
()
const
{
return
_dblHintValFld
; }
52
IntField
*
const
*
getIntHintValFlds
()
const
{
return
_intHintValFld
; }
53
StringField
*
const
*
getStrHintValFlds
()
const
{
return
_strHintValFld
; }
54
BoolField
*
const
*
getBoolHintValFlds
()
const
{
return
_boolHintValFld
; }
55
BoolField
*
const
*
getIntHintVisibleFlds
()
const
{
return
_intHintVisibleFld
; }
56
BoolField
*
const
*
getStrHintVisibleFlds
()
const
{
return
_strHintVisibleFld
; }
57
BoolField
*
const
*
getDblHintVisibleFlds
()
const
{
return
_dblHintVisibleFld
; }
58
BoolField
*
const
*
getBoolHintVisibleFlds
()
const
{
return
_boolHintVisibleFld
; }
60
63
void
updateHintFieldsFromCompressor
(
DataCompressor
*compressor);
64
67
void
updateHintVisibility
(
const
DataCompressor
*compressor);
68
72
void
updateCompressorArgsFromHintFields
(
const
DataCompressor
*compressor);
73
79
void
handleCompressionFieldChanges
(
Field
*field);
80
84
void
updateCompressionFieldsToLoaderState
(
const
MLImageFormat
&loader);
85
87
void
resetCompressionParams
();
88
89
90
protected
:
91
93
Module
&
_baseOp
;
94
95
//--- Members
97
std::vector<std::string>
_compressorNames
;
98
100
MLImageFormatTagList
_compressorArgs
;
101
102
103
//--- Fields
104
106
EnumField
*
_compressorNameFld
;
107
110
NotifyField
*
_updateHintControlsFld
;
111
114
StringField
*
_hintNameFld
[
DataCompressor::MaxHints
];
115
116
DoubleField
*
_dblHintValFld
[
DataCompressor::MaxHints
];
117
IntField
*
_intHintValFld
[
DataCompressor::MaxHints
];
118
StringField
*
_strHintValFld
[
DataCompressor::MaxHints
];
119
BoolField
*
_boolHintValFld
[
DataCompressor::MaxHints
];
120
121
BoolField
*
_intHintVisibleFld
[
DataCompressor::MaxHints
];
122
BoolField
*
_strHintVisibleFld
[
DataCompressor::MaxHints
];
123
BoolField
*
_dblHintVisibleFld
[
DataCompressor::MaxHints
];
124
BoolField
*
_boolHintVisibleFld
[
DataCompressor::MaxHints
];
126
127
private
:
130
MLImageFormatCompressionParams
();
131
MLImageFormatCompressionParams
(
const
MLImageFormatCompressionParams
&);
132
MLImageFormatCompressionParams
&operator=(
const
MLImageFormatCompressionParams
&);
134
135
};
136
137
ML_END_NAMESPACE
138
139
#endif
// __mlImageFormatCompressionParams_H
MLImageFormatBaseSystem.h
MLIMAGEFORMATBASE_EXPORT
#define MLIMAGEFORMATBASE_EXPORT
Definition
MLImageFormatBaseSystem.h:19
ml::BoolField
Definition
mlFields.h:56
ml::DataCompressor
Definition
mlDataCompressor.h:37
ml::DataCompressor::MaxHints
@ MaxHints
Definition
mlDataCompressor.h:47
ml::DoubleField
Definition
mlFields.h:494
ml::EnumField
Definition
mlFields.h:173
ml::Field
Definition
mlField.h:73
ml::IntField
Definition
mlFields.h:117
ml::MLImageFormatCompressionParams::_dblHintValFld
DoubleField * _dblHintValFld[DataCompressor::MaxHints]
Value of double parameter.
Definition
mlImageFormatCompressionParams.h:116
ml::MLImageFormatCompressionParams::updateCompressorArgsFromHintFields
void updateCompressorArgsFromHintFields(const DataCompressor *compressor)
ml::MLImageFormatCompressionParams::updateCompressionFieldsToLoaderState
void updateCompressionFieldsToLoaderState(const MLImageFormat &loader)
ml::MLImageFormatCompressionParams::MLImageFormatCompressionParams
MLImageFormatCompressionParams(Module &baseOp)
Constructor; only available with a valid Module reference.
ml::MLImageFormatCompressionParams::_compressorNameFld
EnumField * _compressorNameFld
Compression scheme used for stored image data. Default is the first entry.
Definition
mlImageFormatCompressionParams.h:106
ml::MLImageFormatCompressionParams::getIntHintValFlds
IntField *const * getIntHintValFlds() const
Definition
mlImageFormatCompressionParams.h:52
ml::MLImageFormatCompressionParams::getCompressorNameFld
EnumField & getCompressorNameFld() const
Definition
mlImageFormatCompressionParams.h:46
ml::MLImageFormatCompressionParams::_boolHintValFld
BoolField * _boolHintValFld[DataCompressor::MaxHints]
Value of bool parameter.
Definition
mlImageFormatCompressionParams.h:119
ml::MLImageFormatCompressionParams::_compressorArgs
MLImageFormatTagList _compressorArgs
List of tags used as parameters for compressors.
Definition
mlImageFormatCompressionParams.h:100
ml::MLImageFormatCompressionParams::getHintNameFlds
StringField *const * getHintNameFlds() const
Definition
mlImageFormatCompressionParams.h:50
ml::MLImageFormatCompressionParams::getIntHintVisibleFlds
BoolField *const * getIntHintVisibleFlds() const
Definition
mlImageFormatCompressionParams.h:55
ml::MLImageFormatCompressionParams::updateHintFieldsFromCompressor
void updateHintFieldsFromCompressor(DataCompressor *compressor)
ml::MLImageFormatCompressionParams::getBoolHintValFlds
BoolField *const * getBoolHintValFlds() const
Definition
mlImageFormatCompressionParams.h:54
ml::MLImageFormatCompressionParams::_baseOp
Module & _baseOp
Reference to the related Module.
Definition
mlImageFormatCompressionParams.h:93
ml::MLImageFormatCompressionParams::getDblHintValFlds
DoubleField *const * getDblHintValFlds() const
Definition
mlImageFormatCompressionParams.h:51
ml::MLImageFormatCompressionParams::_updateHintControlsFld
NotifyField * _updateHintControlsFld
Definition
mlImageFormatCompressionParams.h:110
ml::MLImageFormatCompressionParams::getDblHintVisibleFlds
BoolField *const * getDblHintVisibleFlds() const
Definition
mlImageFormatCompressionParams.h:57
ml::MLImageFormatCompressionParams::resetCompressionParams
void resetCompressionParams()
Reset _compressionFld, _tagListFld, and all _tagListFld.
ml::MLImageFormatCompressionParams::_hintNameFld
StringField * _hintNameFld[DataCompressor::MaxHints]
Name of the parameter.
Definition
mlImageFormatCompressionParams.h:114
ml::MLImageFormatCompressionParams::getBoolHintVisibleFlds
BoolField *const * getBoolHintVisibleFlds() const
Definition
mlImageFormatCompressionParams.h:58
ml::MLImageFormatCompressionParams::updateHintVisibility
void updateHintVisibility(const DataCompressor *compressor)
ml::MLImageFormatCompressionParams::getUpdateHintControlsFld
NotifyField & getUpdateHintControlsFld() const
Definition
mlImageFormatCompressionParams.h:47
ml::MLImageFormatCompressionParams::_boolHintVisibleFld
BoolField * _boolHintVisibleFld[DataCompressor::MaxHints]
Controls visibility of boolean parameter.
Definition
mlImageFormatCompressionParams.h:124
ml::MLImageFormatCompressionParams::getCompressorArgs
MLImageFormatTagList & getCompressorArgs()
Definition
mlImageFormatCompressionParams.h:49
ml::MLImageFormatCompressionParams::getStrHintVisibleFlds
BoolField *const * getStrHintVisibleFlds() const
Definition
mlImageFormatCompressionParams.h:56
ml::MLImageFormatCompressionParams::_strHintVisibleFld
BoolField * _strHintVisibleFld[DataCompressor::MaxHints]
Controls visibility of string parameter.
Definition
mlImageFormatCompressionParams.h:122
ml::MLImageFormatCompressionParams::getStrHintValFlds
StringField *const * getStrHintValFlds() const
Definition
mlImageFormatCompressionParams.h:53
ml::MLImageFormatCompressionParams::_strHintValFld
StringField * _strHintValFld[DataCompressor::MaxHints]
Value of string parameter.
Definition
mlImageFormatCompressionParams.h:118
ml::MLImageFormatCompressionParams::_compressorNames
std::vector< std::string > _compressorNames
List of available compressor names stored when creating the module.
Definition
mlImageFormatCompressionParams.h:97
ml::MLImageFormatCompressionParams::_intHintVisibleFld
BoolField * _intHintVisibleFld[DataCompressor::MaxHints]
Controls visibility of integer parameter.
Definition
mlImageFormatCompressionParams.h:121
ml::MLImageFormatCompressionParams::getCompressorNames
const std::vector< std::string > & getCompressorNames() const
Definition
mlImageFormatCompressionParams.h:48
ml::MLImageFormatCompressionParams::handleCompressionFieldChanges
void handleCompressionFieldChanges(Field *field)
ml::MLImageFormatCompressionParams::_intHintValFld
IntField * _intHintValFld[DataCompressor::MaxHints]
Value of integer parameter.
Definition
mlImageFormatCompressionParams.h:117
ml::MLImageFormatCompressionParams::_dblHintVisibleFld
BoolField * _dblHintVisibleFld[DataCompressor::MaxHints]
Controls visibility of double parameter.
Definition
mlImageFormatCompressionParams.h:123
ml::MLImageFormatTagList
Class defining a list of tags used in the MLImageFormat class.
Definition
mlImageFormatTagList.h:39
ml::MLImageFormat
File format class to store, load, and modify a PagedImage in a file.
Definition
mlImageFormat.h:36
ml::Module
Definition
mlModule.h:151
ml::NotifyField
Definition
mlFields.h:598
ml::StringField
Definition
mlFields.h:553
mlDataCompressor.h
mlImageFormatTagList.h
mlModuleIncludes.h
MeVis
Foundation
Sources
MLImageFormatBase
mlImageFormatCompressionParams.h
Generated by
1.15.0