itkDefaultVectorPixelAccessor.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.
 *
 *=========================================================================*/
#ifndef itkDefaultVectorPixelAccessor_h
#define itkDefaultVectorPixelAccessor_h

#include "itkMacro.h"
#include "itkVariableLengthVector.h"
#include "itkIntTypes.h"

namespace itk
{
template< typename TType >
class ITK_TEMPLATE_EXPORT DefaultVectorPixelAccessor
{
public:

  using VectorLengthType = unsigned int;

  using ExternalType = VariableLengthVector< TType >;

  using InternalType = TType;

  inline void Set(InternalType & output, const ExternalType & input,
                  const unsigned long offset) const
  {
    InternalType *truePixel = ( &output ) + offset * m_OffsetMultiplier;

    for ( VectorLengthType i = 0; i < m_VectorLength; i++ )
      {
      truePixel[i] = input[i];
      }
  }

  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 );
  }

  void SetVectorLength(VectorLengthType l)
  {
    m_VectorLength = l;
    m_OffsetMultiplier = ( l - 1 );
  }

  VectorLengthType GetVectorLength() const { return m_VectorLength; }

  DefaultVectorPixelAccessor()  {}

  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