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
|
/*=========================================================================
*
* 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 itkSparseImage_h
#define itkSparseImage_h
#include "itkImage.h"
#include "itkSparseFieldLayer.h"
#include "itkObjectStore.h"
namespace itk
{
/**
* \class SparseImage
*
* \brief A storage type for sparse image data.
*
* \par
* This class is derived from the Image class. It uses the base class image
* data for storing pointers to variables of type TNode. The node type must
* have a member variable m_Index. The node data is
* stored using the SparseFieldLayer and ObjectStore classes to allow
* sequential list access to the nodes. This functionality is used in filter
* classes that process the SparseImage class such as
* FiniteDifferenceSparseImageFilter. The node type must also have members
* NodeType* Next and NodeType* Previous. A minimal node class which could
* be used to create the sparse equivalent of an itk::Image<unsigned char, 2>
* is shown below:
*
\code
struct NodeType
{
NodeType* Next;
NodeType* Previous;
ImageType::IndexType m_Index;
unsigned char m_Data;
};
using SparseImageType = itk::SparseImage<NodeType, 2>;
\endcode
*
* \par
* This class provides the method AddNode which allocates a node variable,
* associates it with the image pixel index (sets m_Index in the node variable)
* and returns the pointer to the node variable. It is suggested that the user
* call the FillBuffer method to initialize the image to null pointers before
* any calls to AddNode. This would allow the user later to distinguish between
* valid and non-valid pixels.
*
* \ingroup ITKCommon
*/
template <typename TNode, unsigned int VImageDimension = 2>
class ITK_TEMPLATE_EXPORT SparseImage : public Image<TNode *, VImageDimension>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(SparseImage);
/** Standard type alias. */
using Self = SparseImage;
using Superclass = Image<TNode *, VImageDimension>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using ConstWeakPointer = WeakPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(SparseImage);
/** Dimension of the image. */
static constexpr unsigned int ImageDimension = Superclass::ImageDimension;
/** The actual sparse pixel type. */
using NodeType = TNode;
/** Types derived from the Superclass */
using typename Superclass::IndexType;
/** Typedef for the functor used to access a neighborhood of pixel
* pointers. */
using NeighborhoodAccessorFunctorType = NeighborhoodAccessorFunctor<Self>;
using typename Superclass::IOPixelType;
/** The list types for storing the active pixels. */
using NodeListType = SparseFieldLayer<NodeType>;
using NodeStoreType = ObjectStore<NodeType>;
/** Return the NeighborhoodAccessor functor. This method is called by the
* neighborhood iterators. */
NeighborhoodAccessorFunctorType
GetNeighborhoodAccessor()
{
return NeighborhoodAccessorFunctorType();
}
/** Return the NeighborhoodAccessor functor. This method is called by the
* neighborhood iterators. */
const NeighborhoodAccessorFunctorType
GetNeighborhoodAccessor() const
{
return NeighborhoodAccessorFunctorType();
}
/** This function should be used to allocate memory for a variable at the
desired pixel location. */
NodeType *
AddNode(const IndexType & index)
{
m_NodeList->PushFront(m_NodeStore->Borrow());
NodeType * node = m_NodeList->Front();
node->m_Index = index;
this->SetPixel(index, node);
return node;
}
/** This function returns the allocated node list which can be used to
iterate through the valid nodes. */
NodeListType *
GetNodeList()
{
return m_NodeList;
}
/** This function initializes the m_NodeList and m_NodeStore variables, and
calls the superclass Initialize method. */
void
Initialize() override;
protected:
SparseImage() = default;
~SparseImage() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
/** The variables for storing the node variables. */
typename NodeListType::Pointer m_NodeList{ NodeListType::New() };
typename NodeStoreType::Pointer m_NodeStore{ NodeStoreType::New() };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkSparseImage.hxx"
#endif
#endif
|