1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkBMPReader
* @brief read Windows BMP files
*
* vtkBMPReader is a source object that reads Windows BMP files.
* This includes indexed and 24bit bitmaps
* Usually, all BMPs are converted to 24bit RGB, but BMPs may be output
* as 8bit images with a LookupTable if the Allow8BitBMP flag is set.
*
* BMPReader creates structured point datasets. The dimension of the
* dataset depends upon the number of files read. Reading a single file
* results in a 2D image, while reading more than one file results in a
* 3D volume.
*
* To read a volume, files must be of the form "FileName.<number>"
* (e.g., foo.bmp.0, foo.bmp.1, ...). You must also specify the image
* range. This range specifies the beginning and ending files to read (range
* can be any pair of non-negative numbers).
*
* The default behavior is to read a single file. In this case, the form
* of the file is simply "FileName" (e.g., foo.bmp).
*
* @sa
* vtkBMPWriter
*/
#ifndef vtkBMPReader_h
#define vtkBMPReader_h
#include "vtkIOImageModule.h" // For export macro
#include "vtkImageReader.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkLookupTable;
class VTKIOIMAGE_EXPORT vtkBMPReader : public vtkImageReader
{
public:
static vtkBMPReader* New();
vtkTypeMacro(vtkBMPReader, vtkImageReader);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Returns the depth of the BMP, either 8 or 24.
*/
vtkGetMacro(Depth, int);
///@}
/**
* Is the given file a BMP file?
*/
int CanReadFile(VTK_FILEPATH const char* fname) override;
/**
* Get the file extensions for this format.
* Returns a string with a space separated list of extensions in
* the format .extension
*/
const char* GetFileExtensions() override { return ".bmp"; }
/**
* Return a descriptive name for the file format that might be useful in a GUI.
*/
const char* GetDescriptiveName() override { return "Windows BMP"; }
///@{
/**
* If this flag is set and the BMP reader encounters an 8bit file,
* the data will be kept as unsigned chars and a lookuptable will be
* exported
*/
vtkSetMacro(Allow8BitBMP, vtkTypeBool);
vtkGetMacro(Allow8BitBMP, vtkTypeBool);
vtkBooleanMacro(Allow8BitBMP, vtkTypeBool);
///@}
vtkGetObjectMacro(LookupTable, vtkLookupTable);
///@{
/**
* Returns the color lut.
*/
vtkGetMacro(Colors, unsigned char*);
///@}
protected:
vtkBMPReader();
~vtkBMPReader() override;
unsigned char* Colors;
short Depth;
vtkTypeBool Allow8BitBMP;
vtkLookupTable* LookupTable;
void ComputeDataIncrements() override;
void ExecuteInformation() override;
void ExecuteDataWithInformation(vtkDataObject* out, vtkInformation* outInfo) override;
private:
vtkBMPReader(const vtkBMPReader&) = delete;
void operator=(const vtkBMPReader&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
