Skip to content

Commit

Permalink
DOC: Replace examples of SpatialObject functions that one may override
Browse files Browse the repository at this point in the history
In practice, it appears unnecessary to override `ValueAtInWorldSpace`,
`IsEvaluableAtInWorldSpace`, and `IsInsideInWorldSpace` from `SpatialObject`.
None of the thirteen derived SpatialObject classes of ITK itself does override
any of those three member functions.

On the other hand, for example, `ValueAtInObjectSpace`, `IsInsideInObjectSpace`,
and `ComputeMyBoundingBox` do get overridden by derived SpatialObject classes.
  • Loading branch information
N-Dekker committed Jan 31, 2024
1 parent c9c7236 commit 21e795b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Modules/Core/SpatialObjects/include/itkSpatialObject.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ namespace itk
* spatial objects can be plugged to a spatial object as children. To
* implement your own spatial object, you need to derive from the
* following class, which requires overriding just a few virtual functions.
* Examples of such functions are ValueAtInWorldSpace(),
* IsEvaluableAtInWorldSpace(), and IsInsideInWorldSpace(), each of which has a
* Examples of such functions are ValueAtInObjectSpace(),
* IsInsideInObjectSpace(), and ComputeMyBoundingBox(), each of which has a
* meaning specific to each particular object type.
* \ingroup ITKSpatialObjects
*/
Expand Down

0 comments on commit 21e795b

Please sign in to comment.