SimpleITK  
sitkLabelMapOverlayImageFilter.h
Go to the documentation of this file.
1/*=========================================================================
2*
3* Copyright NumFOCUS
4*
5* Licensed under the Apache License, Version 2.0 (the "License");
6* you may not use this file except in compliance with the License.
7* You may obtain a copy of the License at
8*
9* http://www.apache.org/licenses/LICENSE-2.0.txt
10*
11* Unless required by applicable law or agreed to in writing, software
12* distributed under the License is distributed on an "AS IS" BASIS,
13* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14* See the License for the specific language governing permissions and
15* limitations under the License.
16*
17*=========================================================================*/
18#ifndef sitkLabelMapOverlayImageFilter_h
19#define sitkLabelMapOverlayImageFilter_h
20
21/*
22 * WARNING: DO NOT EDIT THIS FILE!
23 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24 * Please look at sitkDualImageFilterTemplate.h.jinja to make changes.
25 */
26
27#include <memory>
28
29#include "sitkImageFilter.h"
31#include "sitkBasicFilters.h"
33
34namespace itk::simple {
35
60public:
62
65
69
72
73
74
75
79 void
80 SetOpacity(double Opacity )
81 { this->m_Opacity = Opacity; }
82
85 double
86 GetOpacity() const { return this->m_Opacity; }
87
88
91 void
92 SetColormap(std::vector<unsigned char> Colormap )
93 { this->m_Colormap = Colormap; }
94
96 std::vector<unsigned char>
97 GetColormap() const { return this->m_Colormap; }
98
99
101 std::string GetName() const { return std::string("LabelMapOverlayImageFilter"); }
102
104 std::string ToString() const;
105
106
108 Image Execute(const Image &labelMapImage, const Image &featureImage);
109
110private:
111
113 using MemberFunctionType = Image (Self::*)(const Image *
114 labelMapImage, const Image *
115 featureImage);
116
118 template <class TImageType1, class TImageType2> Image DualExecuteInternal(const Image *
119 labelMapImage, const Image *
120 featureImage);
121
122
124
125
126
127 /* Value assigned to pixels outside of the mask */
128 double m_Opacity{ 0.5 };
129
130 std::vector<unsigned char> m_Colormap{ std::vector<unsigned char>() };
131
132
133
134
135
136
137
138};
139
140
150 const Image &labelMapImage, const Image &featureImage, double opacity = 0.5, std::vector<unsigned char> colormap = std::vector<unsigned char>()
151);
152
154
155}
156#endif
The Image class for SimpleITK.
Definition sitkImage.h:77
void SetColormap(std::vector< unsigned char > Colormap)
Image Execute(const Image &labelMapImage, const Image &featureImage)
Image DualExecuteInternal(const Image *labelMapImage, const Image *featureImage)
Image(Self::*)(const Image * labelMapImage, const Image * featureImage) MemberFunctionType
static const detail::DualMemberFunctionFactory< MemberFunctionType > & GetMemberFunctionFactory()
std::vector< unsigned char > GetColormap() const
A class used to instantiate and generate function objects of templated member functions with two temp...
typelist2::typelist< LabelPixelID< uint8_t >, LabelPixelID< uint16_t >, LabelPixelID< uint32_t > > LabelPixelIDTypeList
Image LabelMapOverlay(const Image &labelMapImage, const Image &featureImage, double opacity=0.5, std::vector< unsigned char > colormap=std::vector< unsigned char >())
Apply a colormap to a label map and superimpose it on an image.
#define SITKBasicFilters_EXPORT