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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkImageClassifierBase_h
#define itkImageClassifierBase_h
#include "itkClassifierBase.h"
#include "itkMacro.h"
#include "itkImageRegionIterator.h"
namespace itk
{
/**
* \class ImageClassifierBase
* \brief Base class for the ImageClassifierBase object.
*
* itkImageClassifierBase is the base class for algorithms
* that take input data as images and preserve the image structure
* while performing classification. In other words, the data is not
* converted into a list, hence filters that require spatial information
* of a pixel can use the subclasses under this tree. It provides
* the basic function definitions that are inherent to an image classifier
* objects.
*
* This is the Superclass for the image classifier tree of the classifier
* framework. This is the class for all the classification objects available
* through the classifier framework in the ITK toolkit that hold the input
* image and the classified image data.
*
* It is templated over the type of input image, classified image. The second
* template parameter allows templating over the classified image type. The
* name "image" indicates that the basic data structure used for storing
* data/results are derived from the ITK image class.
*
* This object supports data handling of multiband images. The object
* accepts the input image in vector format only, where each pixel is a
* vector and each element of the vector corresponds to an entry from
* 1 particular band of a multiband dataset. A single band image is treated
* as a vector image with a single element for every vector. The classified
* image is treated as a single band scalar image.
*
* This class stores the input and output data as its private members.
* Before you call the Classify method to start the classification process,
* you should plug in all necessary parts as described in the superclass
* documentation.
*
* The core computation is carried out here. The function requires that
* the number of classes be set to a non zero value and the membership
* functions be populated. In addition, the number of classes should be equal
* to the number of membership functions.
*
* \ingroup ImageClassificationFilters
* \ingroup ITKClassifiers
*/
template <typename TInputImage, typename TClassifiedImage>
class ITK_TEMPLATE_EXPORT ImageClassifierBase : public ClassifierBase<TInputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ImageClassifierBase);
/** Standard class type aliases. */
using Self = ImageClassifierBase;
using Superclass = ClassifierBase<TInputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ImageClassifierBase);
/** Type definition for the input image. */
using InputImageType = TInputImage;
using InputImagePointer = typename TInputImage::Pointer;
using InputImageConstPointer = typename TInputImage::ConstPointer;
/** Type definitions for the classified image pixel type. */
using ClassifiedImagePointer = typename TClassifiedImage::Pointer;
/** Type definitions from the Superclass */
/**Set the decision rule */
using typename Superclass::MeasurementVectorType;
/** Typedefs for membership function */
using typename Superclass::MembershipFunctionType;
using typename Superclass::MembershipFunctionPointer;
using typename Superclass::MembershipFunctionPointerVector;
/** Type alias for decision rule */
using typename Superclass::DecisionRuleType;
/** Get/Set the input image. */
itkSetConstObjectMacro(InputImage, InputImageType);
itkGetConstObjectMacro(InputImage, InputImageType);
/** Set the classified image. */
itkSetMacro(ClassifiedImage, ClassifiedImagePointer);
/** Get the classified image. */
itkGetConstMacro(ClassifiedImage, ClassifiedImagePointer);
/** Type definition for the vector associated with
* input image pixel type. */
using InputImagePixelType = typename TInputImage::PixelType;
/** Type definitions for the vector holding
* training image pixel type. */
using ClassifiedImagePixelType = typename TClassifiedImage::PixelType;
/** Type definition for the input image/training iterator */
using InputImageConstIterator = ImageRegionConstIterator<TInputImage>;
using ClassifiedImageIterator = ImageRegionIterator<TClassifiedImage>;
/** Method to get the membership of a given pixel to the different classes */
std::vector<double>
GetPixelMembershipValue(const InputImagePixelType inputImagePixel);
protected:
ImageClassifierBase() = default;
~ImageClassifierBase() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** Allocate memory for the classified image. */
void
Allocate();
/** Starts the classification process */
void
GenerateData() override;
private:
using InputImageSizeType = typename TInputImage::SizeType;
InputImageConstPointer m_InputImage{};
ClassifiedImagePointer m_ClassifiedImage{};
/** Define a virtual classifier function to classify the whole image. */
virtual void
Classify();
}; // class ImageClassifierBase
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkImageClassifierBase.hxx"
#endif
#endif
|