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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
/*=========================================================================
*
* Copyright UMC Utrecht and contributors
*
* 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
*
* http://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.
*
*=========================================================================*/
// First include the header file to be tested:
#include "itkImageFileCastWriter.h"
#include "GTesting/elxCoreMainGTestUtilities.h"
#include "elxPixelTypeToString.h"
// ITK header files:
#include <itkDeref.h>
#include <itkFileTools.h>
#include <itkImage.h>
#include <itkImageFileReader.h>
#include <gtest/gtest.h>
#include <type_traits>
using elx::CoreMainGTestUtilities::CreateImageFilledWithSequenceOfNaturalNumbers;
using elx::CoreMainGTestUtilities::minimumImageSizeValue;
using elx::CoreMainGTestUtilities::GetCurrentBinaryDirectoryPath;
using elx::CoreMainGTestUtilities::GetNameOfTest;
using elx::CoreMainGTestUtilities::TypeHolder;
namespace
{
// Expects that the specified types have the same type traits (unsignedness, floating point-ness, and size).
template <typename T1, typename T2>
void
ExpectEqualTypeTraits()
{
EXPECT_EQ(std::is_unsigned_v<T1>, std::is_unsigned_v<T2>);
EXPECT_EQ(std::is_floating_point_v<T1>, std::is_floating_point_v<T2>);
EXPECT_EQ(sizeof(T1), sizeof(T2));
}
// Returns true iff there is a mapping from the type specified by the template argument to the function argument.
template <typename TPixel>
bool
IsTypeMapping(const itk::IOComponentEnum componentEnum)
{
return itk::ImageIOBase::MapPixelType<TPixel>::CType == componentEnum;
}
// Expects that the component type specified by the function argument has the same type traits as the first template
// argument.
template <typename TComponent, typename... TPixel>
void
ExpectEqualTypeTraits(const itk::IOComponentEnum componentEnum)
{
// First check that there is a mapping from at least one of the pixel types to the enum value.
ASSERT_TRUE((IsTypeMapping<TPixel>(componentEnum) || ...));
((IsTypeMapping<TPixel>(componentEnum) ? ExpectEqualTypeTraits<TComponent, TPixel>() : void()), ...);
}
} // namespace
// Test that ImageFileCastWriter stores the specified component type, when calling `WriteCastedImage(image, filename,
// outputComponentType, compress)`.
GTEST_TEST(ImageFileCastWriter, StoresComponentType)
{
const std::string outputDirectoryPath = GetCurrentBinaryDirectoryPath() + '/' + GetNameOfTest(*this);
itk::FileTools::CreateDirectory(outputDirectoryPath);
using InputPixelType = int;
static constexpr unsigned int imageDimension{ 2 };
using InputImageType = itk::Image<InputPixelType, imageDimension>;
const auto inputImage = CreateImageFilledWithSequenceOfNaturalNumbers<InputPixelType>(
itk::Size<imageDimension>::Filled(minimumImageSizeValue));
// Note: ImageFileCastWriter does not support "long_long" or "unsigned_long_long" as `outputComponentType`. When using
// "long" or "unsigned_long" as `outputComponentType` on a platform whose `long` integer type has 64 bits, it may be
// read back as "long_long" or "unsigned_long_long", respecively.
for (const std::string outputComponentType :
{ "char", "unsigned_char", "short", "unsigned_short", "int", "unsigned_int", "float", "double" })
{
const std::string filename = outputDirectoryPath + '/' + outputComponentType + ".mhd";
itk::WriteCastedImage(*inputImage, filename, outputComponentType, false);
// Read back the file that is written by WriteCastedImage.
const auto reader = itk::ImageFileReader<InputImageType>::New();
reader->SetFileName(filename);
reader->Update();
// Check that the component type is in the image file.
const auto & imageIO = itk::Deref(reader->GetImageIO());
EXPECT_EQ(itk::ImageIOBase::GetComponentTypeAsString(imageIO.GetComponentType()), outputComponentType);
// Also check that the read image is equal to the written input image.
EXPECT_EQ(itk::Deref(reader->GetOutput()), itk::Deref(inputImage.get()));
}
}
// Test that ImageFileCastWriter supports using a fixed width notation to specify the component type, when calling
// `WriteCastedImage(image, filename, outputComponentType, compress)`.
GTEST_TEST(ImageFileCastWriter, SupportsFixedWidthComponentType)
{
const std::string outputDirectoryPath = GetCurrentBinaryDirectoryPath() + '/' + GetNameOfTest(*this);
itk::FileTools::CreateDirectory(outputDirectoryPath);
using InputPixelType = int;
static constexpr unsigned int imageDimension{ 2 };
const auto inputImage = CreateImageFilledWithSequenceOfNaturalNumbers<InputPixelType>(
itk::Size<imageDimension>::Filled(minimumImageSizeValue));
const auto check = [inputImage, &outputDirectoryPath](const auto componentTypeHolder) {
using ComponentType = typename decltype(componentTypeHolder)::Type;
const auto outputComponentType = elx::PixelTypeToFixedWidthString<ComponentType>();
const std::string filename = outputDirectoryPath + '/' + outputComponentType + ".mhd";
itk::WriteCastedImage(*inputImage, filename, outputComponentType, false);
// Read back the file that is written by WriteCastedImage.
const auto reader = itk::ImageFileReader<itk::Image<InputPixelType, imageDimension>>::New();
reader->SetFileName(filename);
reader->Update();
// Check that the component type in the image file has the expected type_info.
const auto & imageIO = itk::Deref(reader->GetImageIO());
ExpectEqualTypeTraits<ComponentType,
signed char,
char,
unsigned char,
short,
unsigned short,
int,
unsigned int,
long,
unsigned long,
long long,
unsigned long long,
float,
double>(imageIO.GetComponentType());
// Also check that the read image is equal to the written input image.
EXPECT_EQ(itk::Deref(reader->GetOutput()), itk::Deref(inputImage.get()));
};
check(TypeHolder<std::int8_t>{});
check(TypeHolder<std::uint8_t>{});
check(TypeHolder<std::int16_t>{});
check(TypeHolder<std::uint16_t>{});
check(TypeHolder<std::int32_t>{});
check(TypeHolder<std::uint32_t>{});
check(TypeHolder<std::int64_t>{});
check(TypeHolder<std::uint64_t>{});
check(TypeHolder<float>{});
check(TypeHolder<double>{});
}
// Test that ImageFileCastWriter throws an exception, when calling `WriteCastedImage(image, filename,
// outputComponentType, compress)` with an invalid or unsupported component type.
GTEST_TEST(ImageFileCastWriter, ThrowsExceptionOnInvalidComponentType)
{
const std::string outputDirectoryPath = GetCurrentBinaryDirectoryPath() + '/' + GetNameOfTest(*this);
itk::FileTools::CreateDirectory(outputDirectoryPath);
using InputPixelType = int;
static constexpr unsigned int imageDimension{ 2 };
const auto inputImage = CreateImageFilledWithSequenceOfNaturalNumbers<InputPixelType>(
itk::Size<imageDimension>::Filled(minimumImageSizeValue));
for (const std::string invalidComponentType : {
"",
"not a proper type",
"string",
})
{
EXPECT_THROW(itk::WriteCastedImage(*inputImage, outputDirectoryPath + "/file.mhd", invalidComponentType, false),
itk::ExceptionObject);
}
}
|