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
|
/*=========================================================================
*
* 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 itkDefaultVectorPixelAccessor_h
#define itkDefaultVectorPixelAccessor_h
#include "itkMacro.h"
#include "itkVariableLengthVector.h"
#include "itkIntTypes.h"
namespace itk
{
/** \class DefaultVectorPixelAccessor
* \brief Give access to partial aspects of a type
*
* DefaultVectorPixelAccessor is specifically meant to provide VectorImage
* with the same \c DefaultPixelAccessor interface that
* DefaultPixelAccessor provides to Image.
*
* The template parameters is the type that is contained in by the elements of
* a vector.
*
* The class also contains a m_VectorLength parameter, set with the SetVectorLength
* method to set the length of the vectors. This must be set before the accessor
* can be used. This is the length of each of the vector containers.
*
* \note
* This work is part of the National Alliance for Medical Image Computing
* (NAMIC), funded by the National Institutes of Health through the NIH Roadmap
* for Medical Research, Grant U54 EB005149.
*
* \ingroup ImageAdaptors
* \ingroup ITKCommon
*/
template <typename TType>
class ITK_TEMPLATE_EXPORT DefaultVectorPixelAccessor
{
public:
using VectorLengthType = unsigned int;
/** External type alias. It defines the external aspect
* that this class will exhibit. Here it is an VariableLengthVector. The container does not
* manage the memory. In other words it is an array reference with the contents
* pointing to the actual data in the image. */
using ExternalType = VariableLengthVector<TType>;
/** Internal type alias. It defines the internal real representation of data. */
using InternalType = TType;
/** Set output using the value in input */
inline void
Set(InternalType & output, const ExternalType & input, const SizeValueType offset) const
{
InternalType * truePixel = (&output) + offset * m_OffsetMultiplier;
for (VectorLengthType i = 0; i < m_VectorLength; ++i)
{
truePixel[i] = input[i];
}
}
/** Get the value from input */
inline ExternalType
Get(const InternalType & input, const SizeValueType offset) const
{
// Do not create a local for this method, to use return value
// optimization.
return ExternalType((&input) + (offset * m_OffsetMultiplier), m_VectorLength);
}
/** Set the length of each vector in the VectorImage */
void
SetVectorLength(VectorLengthType l)
{
m_VectorLength = l;
m_OffsetMultiplier = (l - 1);
}
/** Get Vector lengths */
VectorLengthType
GetVectorLength() const
{
return m_VectorLength;
}
DefaultVectorPixelAccessor() = default;
/** Constructor to initialize VectorLength at construction time */
DefaultVectorPixelAccessor(VectorLengthType l)
{
m_VectorLength = l;
m_OffsetMultiplier = l - 1;
}
~DefaultVectorPixelAccessor() = default;
private:
VectorLengthType m_VectorLength{ 0 };
VectorLengthType m_OffsetMultiplier{ 0 };
};
} // end namespace itk
#endif
|