Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion Modules/Bridge/VTK/include/itkVTKImageExport.h
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,13 @@ class ITK_TEMPLATE_EXPORT VTKImageExport : public VTKImageExportBase
itkConceptMacro(ImageDimensionCheck, (Concept::SameDimensionOrMinusOneOrTwo<3, Self::InputImageDimension>));

/** Set the input image of this image exporter. */
/** @ITKStartGrouping */
using Superclass::SetInput;
void
SetInput(const InputImageType *);
InputImageType *
GetInput();

/** @ITKEndGrouping */
protected:
VTKImageExport();
~VTKImageExport() override = default;
Expand Down
6 changes: 4 additions & 2 deletions Modules/Bridge/VTK/include/itkVTKImageExportBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
GetCallbackUserData();

/** The function pointer type expected for a callback. */
/** @ITKStartGrouping */
using UpdateInformationCallbackType = void (*)(void *);
using PipelineModifiedCallbackType = int (*)(void *);
using WholeExtentCallbackType = int * (*)(void *);
Expand All @@ -66,11 +67,12 @@ class ITKVTK_EXPORT VTKImageExportBase : public ProcessObject
using UpdateDataCallbackType = void (*)(void *);
using DataExtentCallbackType = int * (*)(void *);
using BufferPointerCallbackType = void * (*)(void *);

/** @ITKEndGrouping */
/** Compatibility for VTK older than 4.4. */
/** @ITKStartGrouping */
using FloatSpacingCallbackType = float * (*)(void *);
using FloatOriginCallbackType = float * (*)(void *);

/** @ITKEndGrouping */
/**
* \class CallbackTypeProxy
* \brief Provide compatibility between VTK 4.4 and earlier versions.
Expand Down
45 changes: 30 additions & 15 deletions Modules/Bridge/VTK/include/itkVTKImageImport.h
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>

/** These are function pointer types for the pipeline connection
* callbacks. */
/** @ITKStartGrouping */
using UpdateInformationCallbackType = void (*)(void *);
using PipelineModifiedCallbackType = int (*)(void *);
using WholeExtentCallbackType = int * (*)(void *);
Expand All @@ -95,24 +96,29 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
using UpdateDataCallbackType = void (*)(void *);
using DataExtentCallbackType = int * (*)(void *);
using BufferPointerCallbackType = void * (*)(void *);

/** @ITKEndGrouping */
/** Compatibility for VTK older than 4.4. */
/** @ITKStartGrouping */
using FloatSpacingCallbackType = float * (*)(void *);
using FloatOriginCallbackType = float * (*)(void *);

/** @ITKEndGrouping */
/** What to do when receiving UpdateInformation(). */
/** @ITKStartGrouping */
itkSetMacro(UpdateInformationCallback, UpdateInformationCallbackType);
itkGetConstMacro(UpdateInformationCallback, UpdateInformationCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving PipelineModified(). */
/** @ITKStartGrouping */
itkSetMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);
itkGetConstMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving SetWholeExtent(). */
/** @ITKStartGrouping */
itkSetMacro(WholeExtentCallback, WholeExtentCallbackType);
itkGetConstMacro(WholeExtentCallback, WholeExtentCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving SetSpacing(). */
/** @ITKStartGrouping */
itkSetMacro(SpacingCallback, SpacingCallbackType);
itkGetConstMacro(SpacingCallback, SpacingCallbackType);
itkSetMacro(FloatSpacingCallback, FloatSpacingCallbackType);
Expand All @@ -122,8 +128,9 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
{
this->SetFloatSpacingCallback(f);
}

/** @ITKEndGrouping */
/** What to do when receiving SetOrigin(). */
/** @ITKStartGrouping */
itkSetMacro(OriginCallback, OriginCallbackType);
itkGetConstMacro(OriginCallback, OriginCallbackType);
itkSetMacro(FloatOriginCallback, FloatOriginCallbackType);
Expand All @@ -133,39 +140,47 @@ class ITK_TEMPLATE_EXPORT VTKImageImport : public ImageSource<TOutputImage>
{
this->SetFloatOriginCallback(f);
}

/** @ITKEndGrouping */
/** What to do when receiving SetDirection(). */
/** @ITKStartGrouping */
itkSetMacro(DirectionCallback, DirectionCallbackType);
itkGetConstMacro(DirectionCallback, DirectionCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving UpdateInformation(). */
/** @ITKStartGrouping */
itkSetMacro(ScalarTypeCallback, ScalarTypeCallbackType);
itkGetConstMacro(ScalarTypeCallback, ScalarTypeCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving SetNumberOfComponents(). */
/** @ITKStartGrouping */
itkSetMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);
itkGetConstMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving PropagateUpdateExtent(). */
/** @ITKStartGrouping */
itkSetMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);
itkGetConstMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving UpdateData(). */
/** @ITKStartGrouping */
itkSetMacro(UpdateDataCallback, UpdateDataCallbackType);
itkGetConstMacro(UpdateDataCallback, UpdateDataCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving DataExtent(). */
/** @ITKStartGrouping */
itkSetMacro(DataExtentCallback, DataExtentCallbackType);
itkGetConstMacro(DataExtentCallback, DataExtentCallbackType);

/** @ITKEndGrouping */
/** What to do when receiving BufferPointer(). */
/** @ITKStartGrouping */
itkSetMacro(BufferPointerCallback, BufferPointerCallbackType);
itkGetConstMacro(BufferPointerCallback, BufferPointerCallbackType);

/** @ITKEndGrouping */
/** Specify callback data. */
/** @ITKStartGrouping */
itkSetMacro2(CallbackUserData, void *);
itkGetConstMacro(CallbackUserData, void *);

/** @ITKEndGrouping */
protected:
VTKImageImport();
~VTKImageImport() override = default;
Expand Down
18 changes: 12 additions & 6 deletions Modules/Core/Common/include/itkAnnulusOperator.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,

/** Set/Get the inner radius of the annulus. Radius is specified in
* physical units (mm). */
/** @ITKStartGrouping */
void
SetInnerRadius(double r)
{
Expand All @@ -101,10 +102,11 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
{
return m_InnerRadius;
}

/** @ITKEndGrouping */
/** Set/Get the thickness of the annulus. The outer radius of the
* annulus is defined as r = InnerRadius + Thickness. Thickness is
* specified in physical units (mm). */
/** @ITKStartGrouping */
void
SetThickness(double t)
{
Expand All @@ -115,9 +117,10 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
{
return m_Thickness;
}

/** @ITKEndGrouping */
/** Set/Get the pixel spacings. Setting these ensures the annulus
* is round in physical space. Defaults to 1. */
/** @ITKStartGrouping */
void
SetSpacing(SpacingType & s)
{
Expand All @@ -128,9 +131,10 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
{
return m_Spacing;
}

/** @ITKEndGrouping */
/** Set/Get whether kernel values are computed automatically or
* specified manually */
/** @ITKStartGrouping */
void
SetNormalize(bool b)
{
Expand All @@ -151,9 +155,10 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
{
this->SetNormalize(false);
}

/** @ITKEndGrouping */
/** If Normalize is on, you define the annulus to have a bright
* center or a dark center. */
/** @ITKStartGrouping */
void
SetBrightCenter(bool b)
{
Expand All @@ -174,11 +179,12 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
{
this->SetBrightCenter(false);
}

/** @ITKEndGrouping */
/** If Normalize is off, the interior to annulus, the
* annulus (region between the two circles), and the region exterior to the
* annulus to be defined manually. Defaults are 0, 1, 0
* respectively. */
/** @ITKStartGrouping */
void
SetInteriorValue(TPixel v)
{
Expand Down Expand Up @@ -209,7 +215,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,
{
return m_ExteriorValue;
}

/** @ITKEndGrouping */
void
PrintSelf(std::ostream & os, Indent indent) const override
{
Expand Down
3 changes: 2 additions & 1 deletion Modules/Core/Common/include/itkArray.h
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ class ITK_TEMPLATE_EXPORT Array : public vnl_vector<TValue>
operator=(const VnlVectorType & rhs);

/** Return the number of elements in the Array */
/** @ITKStartGrouping */
SizeValueType
Size() const
{
Expand All @@ -135,7 +136,7 @@ class ITK_TEMPLATE_EXPORT Array : public vnl_vector<TValue>
{
return static_cast<SizeValueType>(this->size());
}

/** @ITKEndGrouping */
/** Get one element */
const TValue &
GetElement(SizeValueType i) const
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ class ITK_TEMPLATE_EXPORT AutoPointerDataObjectDecorator : public DataObject
Set(T * val);

/** Get the contained object */
/** @ITKStartGrouping */
virtual T *
Get()
{
Expand All @@ -94,7 +95,7 @@ class ITK_TEMPLATE_EXPORT AutoPointerDataObjectDecorator : public DataObject
{
return m_Component.get();
}

/** @ITKEndGrouping */
protected:
AutoPointerDataObjectDecorator() = default;
~AutoPointerDataObjectDecorator() override = default;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,20 @@ class ITK_TEMPLATE_EXPORT BinaryThresholdSpatialFunction
using FunctionOutputType = typename TFunction::OutputType;

/** Set/Get the lower threshold. */
/** @ITKStartGrouping */
itkSetMacro(LowerThreshold, FunctionOutputType);
itkGetConstReferenceMacro(LowerThreshold, FunctionOutputType);

/** @ITKEndGrouping */
/** Set/Get the upper threshold. */
/** @ITKStartGrouping */
itkSetMacro(UpperThreshold, FunctionOutputType);
itkGetConstReferenceMacro(UpperThreshold, FunctionOutputType);

/** @ITKEndGrouping */
/** Set/Get the underlying function. */
/** @ITKStartGrouping */
itkSetObjectMacro(Function, FunctionType);
itkGetModifiableObjectMacro(Function, FunctionType);

/** @ITKEndGrouping */
/** Evaluate the function at a given position. */
OutputType
Evaluate(const InputType & point) const override;
Expand Down
3 changes: 2 additions & 1 deletion Modules/Core/Common/include/itkBuildInformation.h
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ class ITKCommon_EXPORT BuildInformation final : public Object
New();

/** Returns the global singleton instance of the BuildInformation */
/** @ITKStartGrouping */
static Pointer
GetInstance();
static const MapType &
Expand All @@ -95,7 +96,7 @@ class ITKCommon_EXPORT BuildInformation final : public Object
GetDescription(const MapKeyType &);
static const std::vector<MapKeyType>
GetAllKeys();

/** @ITKEndGrouping */
private:
BuildInformation();

Expand Down
3 changes: 2 additions & 1 deletion Modules/Core/Common/include/itkCellInterface.h
Original file line number Diff line number Diff line change
Expand Up @@ -306,12 +306,13 @@ class ITK_TEMPLATE_EXPORT CellInterface
PointIdsEnd() const = 0;

/** Get/Set the point id list used by the cell */
/** @ITKStartGrouping */
using PointIdentifierContainerType = itk::Array<PointIdentifier>;
PointIdentifierContainerType
GetPointIdsContainer() const;
void
SetPointIdsContainer(const PointIdentifierContainerType &);

/** @ITKEndGrouping */
/** Given the parametric coordinates of a point in the cell
* (pCoords[CellDimension]), get the closest cell boundary feature of
* topological dimension CellDimension-1. If the "inside" pointer is not
Expand Down
3 changes: 2 additions & 1 deletion Modules/Core/Common/include/itkColorTable.h
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,12 @@ class ITK_TEMPLATE_EXPORT ColorTable : public Object
* the color. If a name is not provided, the name "UserDefined" is
* used.
*/
/** @ITKStartGrouping */
bool
SetColor(unsigned int c, TComponent r, TComponent g, TComponent b, const char * name = "UserDefined");
bool
SetColor(unsigned int c, RGBPixel<TComponent> pixel, const char * name = "UserDefined");

/** @ITKEndGrouping */
/** Given the position in the table and the color
* returns the value.
*/
Expand Down
9 changes: 6 additions & 3 deletions Modules/Core/Common/include/itkCommand.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,10 @@ class ITK_TEMPLATE_EXPORT MemberCommand : public Command
ITK_DISALLOW_COPY_AND_MOVE(MemberCommand);

/** pointer to a member function that takes a Object* and the event */
/** @ITKStartGrouping */
using TMemberFunctionPointer = void (T::*)(Object *, const EventObject &);
using TConstMemberFunctionPointer = void (T::*)(const Object *, const EventObject &);

/** @ITKEndGrouping */
/** Standard class type aliases. */
using Self = MemberCommand;
using Pointer = SmartPointer<Self>;
Expand Down Expand Up @@ -358,10 +359,11 @@ class ITKCommon_EXPORT CStyleCommand : public Command
{
public:
/** Typedefs for C-style callbacks. */
/** @ITKStartGrouping */
using FunctionPointer = void (*)(Object *, const EventObject &, void *);
using ConstFunctionPointer = void (*)(const Object *, const EventObject &, void *);
using DeleteDataFunctionPointer = void (*)(void *);

/** @ITKEndGrouping */
/** Standard class type aliases. */
using Self = CStyleCommand;
using Pointer = SmartPointer<Self>;
Expand All @@ -378,11 +380,12 @@ class ITKCommon_EXPORT CStyleCommand : public Command
SetClientData(void * cd);

/** Set the C callback function pointer to be called at Execute time. */
/** @ITKStartGrouping */
void
SetCallback(FunctionPointer f);
void
SetConstCallback(ConstFunctionPointer f);

/** @ITKEndGrouping */
/** Set the callback to delete the client data. */
void
SetClientDataDeleteCallback(DeleteDataFunctionPointer f);
Expand Down
Loading