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 168 169 170 171 172 173
|
/*=========================================================================
*
* 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.
*
*=========================================================================*/
/*=========================================================================
*
* Portions of this file are subject to the VTK Toolkit Version 3 copyright.
*
* Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
*
* For complete copyright, license and disclaimer of warranty information
* please refer to the NOTICE file at the top of the ITK source tree.
*
*=========================================================================*/
#ifndef itkRandomImageSource_h
#define itkRandomImageSource_h
#include "itkImageSource.h"
#include "itkNumericTraits.h"
namespace itk
{
/**
* \class RandomImageSource
* \brief Generate an n-dimensional image of random pixel values.
*
* RandomImageSource generates an image of random pixel values.
* This filter uses an inline random number generator since the library
* drand48, although thread-safe, is very slow in a threaded environment.
* The output image may be of any dimension.
* NOTE: To produce deterministic results, set the number of threads
* to 1.
*
* \ingroup DataSources MultiThreaded
* \ingroup ITKTestKernel
*
* \sphinx
* \sphinxexample{Core/TestKernel/GenerateRandomImage,Generate Random Image}
* \endsphinx
*/
template <typename TOutputImage>
class ITK_TEMPLATE_EXPORT RandomImageSource : public ImageSource<TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(RandomImageSource);
/** Standard class type aliases. */
using Self = RandomImageSource;
using Superclass = ImageSource<TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Typedef for the output image PixelType. */
using OutputImagePixelType = typename TOutputImage::PixelType;
/** Typedef to describe the output image region type. */
using OutputImageRegionType = typename TOutputImage::RegionType;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(RandomImageSource);
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Basic types from the OutputImageType */
using SizeType = typename TOutputImage::SizeType;
using IndexType = typename TOutputImage::IndexType;
using SpacingType = typename TOutputImage::SpacingType;
using DirectionType = typename TOutputImage::DirectionType;
using PointType = typename TOutputImage::PointType;
using SizeValueType = typename SizeType::SizeValueType;
using SizeValueArrayType = SizeValueType[TOutputImage::ImageDimension];
using SpacingValueType = typename TOutputImage::SpacingValueType;
using SpacingValueArrayType = SpacingValueType[TOutputImage::ImageDimension];
using PointValueType = typename TOutputImage::PointValueType;
using PointValueArrayType = PointValueType[TOutputImage::ImageDimension];
/** ImageDimension constant */
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
/** Set/Get size of the output image */
itkSetMacro(Size, SizeType);
virtual void
SetSize(SizeValueArrayType sizeArray);
virtual const SizeValueType *
GetSize() const;
/** Set/Get spacing of the output image */
itkSetMacro(Spacing, SpacingType);
virtual void
SetSpacing(SpacingValueArrayType spacingArray);
virtual const SpacingValueType *
GetSpacing() const;
/** Set/Get origin of the output image */
itkSetMacro(Origin, PointType);
virtual void
SetOrigin(PointValueArrayType originArray);
virtual const PointValueType *
GetOrigin() const;
itkSetMacro(Direction, DirectionType);
itkGetMacro(Direction, DirectionType);
/** Set the minimum possible pixel value. By default, it is
* NumericTraits<TOutputImage::PixelType>::min(). */
itkSetClampMacro(Min,
OutputImagePixelType,
NumericTraits<OutputImagePixelType>::NonpositiveMin(),
NumericTraits<OutputImagePixelType>::max());
/** Get the minimum possible pixel value. */
itkGetConstMacro(Min, OutputImagePixelType);
/** Set the maximum possible pixel value. By default, it is
* NumericTraits<TOutputImage::PixelType>::max(). */
itkSetClampMacro(Max,
OutputImagePixelType,
NumericTraits<OutputImagePixelType>::NonpositiveMin(),
NumericTraits<OutputImagePixelType>::max());
/** Get the maximum possible pixel value. */
itkGetConstMacro(Max, OutputImagePixelType);
protected:
RandomImageSource();
~RandomImageSource() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
void
GenerateOutputInformation() override;
private:
SizeType m_Size{}; // size of the output image
SpacingType m_Spacing{}; // spacing
PointType m_Origin{}; // origin
DirectionType m_Direction{}; // direction
typename TOutputImage::PixelType m_Min{}; // minimum possible value
typename TOutputImage::PixelType m_Max{}; // maximum possible value
// The following variables are deprecated, and provided here just for
// backward compatibility. It use is discouraged.
mutable PointValueArrayType m_OriginArray{};
mutable SpacingValueArrayType m_SpacingArray{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkRandomImageSource.hxx"
#endif
#endif
|