Skip to content

Commit

Permalink
DOC: Fix typos in Modules/Core subdirectory
Browse files Browse the repository at this point in the history
Found via `codespell -q 3 -S ./Modules/ThirdParty,./Documentation/ReleaseNotes -L ans,ba,childrens,developpement,dum,fiter,inout,ist,nd,ot,serie,te,unser ./Modules`
Update Modules/Core/Common/test/itkCommandObserverObjectTest.cxx

Co-authored-by: Dženan Zukić <dzenan.zukic@kitware.com>
  • Loading branch information
2 people authored and N-Dekker committed Jul 27, 2022
1 parent 835dc01 commit d8063f3
Show file tree
Hide file tree
Showing 127 changed files with 168 additions and 168 deletions.
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkAnnulusOperator.h
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ class ITK_TEMPLATE_EXPORT AnnulusOperator : public NeighborhoodOperator<TPixel,

/** 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. Defauls are 0, 1, 0
* annulus to be defined manually. Defaults are 0, 1, 0
* respectively. */
void
SetInteriorValue(TPixel v)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ class ITK_TEMPLATE_EXPORT ConstShapedNeighborhoodIterator : private Neighborhood
/** Typedef for generic boundary condition pointer */
using ImageBoundaryConditionPointerType = ImageBoundaryCondition<ImageType> *;

/** Const Interator */
/** Const Iterator */
struct ConstIterator
{
ConstIterator() { m_NeighborhoodIterator = nullptr; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class ITK_TEMPLATE_EXPORT EllipsoidInteriorExteriorSpatialFunction
/** The center of the ellipsoid. */
InputType m_Center;

/** The axes lenths of the ellipsoid. */
/** The axes lengths of the ellipsoid. */
InputType m_Axes;

/** The orientation vectors (must be orthogonal) of the ellipsoid axes. */
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkEventObject.h
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ operator<<(std::ostream & os, const EventObject & e)
static_assert(true, "Compile time eliminated. Used to require a semi-colon at end of macro.")

#if !defined(ITK_LEGACY_REMOVE)
// Suppport Pre 2015 code bases
// Support Pre 2015 code bases

// This macro duplicates some of the declaration and definition
// macro code. The purpose is to provide a backward compatibility API
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkExtractImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ extern ITKCommon_EXPORT std::ostream &
* starting index value provided in the ExtractRegion parameter. If you are
* looking for a filter that will re-compute the origin of the output image,
* and provide an output image region whose index is set to zeros, then you may
* want to use the RegionOfInterestImageFilter. The output spacing is is
* want to use the RegionOfInterestImageFilter. The output spacing is
* simply the collapsed version of the input spacing.
*
* Determining the direction of the collapsed output image from an larger
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ extern ITKCommon_EXPORT std::ostream &
* it performs only smoothing as a standard itk::GaussianOperator)
*
* (3) The "maximum error" allowed in the discrete Gaussian
* function. "Maximum errror" is defined as the difference between the area
* function. "Maximum error" is defined as the difference between the area
* under the discrete Gaussian curve and the area under the continuous
* Gaussian. Maximum error affects the Gaussian operator size. Care should
* be taken not to make this value too small relative to the variance
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkGaussianOperator.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ namespace itk
* (1) The floating-point variance of the desired Gaussian function.
*
* (2) The "maximum error" allowed in the discrete Gaussian
* function. "Maximum errror" is defined as the difference between the area
* function. "Maximum error" is defined as the difference between the area
* under the discrete Gaussian curve and the area under the continuous
* Gaussian. Maximum error affects the Gaussian operator size. Care should
* be taken not to make this value too small relative to the variance
Expand Down
6 changes: 3 additions & 3 deletions Modules/Core/Common/include/itkImageBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ namespace itk
*
* ImageBase also provides helper routines for the ImageIterators
* which convert an Index to an offset in memory from the first pixel
* address as well as covert an offset in memory from the first pixel
* address as well as convert an offset in memory from the first pixel
* address to an Index.
*
* \ingroup ImageObjects
Expand Down Expand Up @@ -199,7 +199,7 @@ class ITK_TEMPLATE_EXPORT ImageBase : public DataObject
* (0.5, 0.866)
*
* The columns of the Direction matrix are expected to form an
* orthogonal right handed coordinate syste. But this is not
* orthogonal right handed coordinate system. But this is not
* checked nor enforced in itk::ImageBase.
*
* For details, please see:
Expand Down Expand Up @@ -723,7 +723,7 @@ class ITK_TEMPLATE_EXPORT ImageBase : public DataObject

/** UpdateOutputData() is part of the pipeline infrastructure to
* communicate between ProcessObjects and DataObjects. The method of
* the superclass is overriden to check if the requested image
* the superclass is overridden to check if the requested image
* region has zero pixels. This is needed so that filters can set an
* input's requested region to zero, to indicate that it does not
* need to be updated or executed.
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkImageBase.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ ImageBase<VImageDimension>::UpdateOutputData()
{
// If the requested region does not contain any pixels then there is
// no reason to Update the output data. This is needed so that
// filters don't need to update all inputs. This occours in
// filters don't need to update all inputs. This occurs in
// ImageBase as oppose to DataObject, but cause this statement
// requires the specific GetNumberOfPixels methods ( as oppose to a
// generic Region::IsEmpty method ).
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkImageIORegion.h
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ class ITKCommon_EXPORT ImageIORegion : public Region
bool
IsInside(const IndexType & index) const;

/** Test if a region (the argument) is completly inside of this region */
/** Test if a region (the argument) is completely inside of this region */
bool
IsInside(const Self & region) const;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ ImageRegionConstIterator<TImage>::Decrement()
const typename ImageIterator<TImage>::IndexType & startIndex = this->m_Region.GetIndex();
const typename ImageIterator<TImage>::SizeType & size = this->m_Region.GetSize();

// Deccrement along a row, then wrap at the beginning of the region row.
// Decrement along a row, then wrap at the beginning of the region row.

// Check to see if we are past the first pixel in the region
// Note that --ind[0] moves to the previous pixel along the row.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ class ITK_TEMPLATE_EXPORT ImageRegionExclusionConstIteratorWithIndex : public Im

/** Method to define the Exclusion region. The iterator will skip pixels
* inside this region.
* \warning The exclusion region must be completly contained inside the
* \warning The exclusion region must be completely contained inside the
* normal region used to construct the iterator. A border of at least one
* pixel should exist between the normal region and the exclusion region.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ class ITK_TEMPLATE_EXPORT ImageRegionReverseConstIterator : public ImageReverseC
const typename ImageConstIterator<TImage>::IndexType & startIndex = this->m_Region.GetIndex();
const typename ImageConstIterator<TImage>::SizeType & size = this->m_Region.GetSize();

// Deccrement along a row, then wrap at the beginning of the region row.
// Decrement along a row, then wrap at the beginning of the region row.
bool done;
unsigned int dim;

Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkImageSource.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ template <typename TOutputImage>
void
ImageSource<TOutputImage>::GenerateData()
{
// Call a method that can be overriden by a subclass to allocate
// Call a method that can be overridden by a subclass to allocate
// memory for the filter's outputs
this->AllocateOutputs();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class ITK_TEMPLATE_EXPORT ImageVectorOptimizerParametersHelper : public Optimize

/** Set a new data pointer for *both* the Array and parameter image,
* pointing both to a different memory block.
* The size of the new memroy block must be the same as current size of
* The size of the new memory block must be the same as current size of
* Array and the parameter image's buffer, in elements of TValue.
* Memory must be managed by caller afterwards. */
void
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkIndexRange.h
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ class IndexRange final
empty() const noexcept
{
// When an IndexRange is empty, each index value of m_MaxIndex is less than the corresponding
// index value of m_MinIndex. And vise versa: when an IndexRange is non-empty, each index value
// index value of m_MinIndex. And vice versa: when an IndexRange is non-empty, each index value
// of m_MaxIndex is greater than or equal to the corresponding index value of m_MinIndex.
// Note that the range contains one element when m_MaxIndex == m_MinIndex.
return m_MaxIndex[0] < m_MinIndex[0];
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkLaplacianOperator.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ LaplacianOperator<TPixel, VDimension, TAllocator>::CreateOperator()
this->Fill(coefficients);
}

// This function fills the coefficients into the corresponding neighborhodd.
// This function fills the coefficients into the corresponding neighborhood.
template <typename TPixel, unsigned int VDimension, typename TAllocator>
void
LaplacianOperator<TPixel, VDimension, TAllocator>::Fill(const CoefficientVector & coeff)
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkMacro.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* to interface to instance variables in a standard fashion. For example,
* these macros manage modified time, debugging information, and provide a
* standard interface to set and get instance variables. Macros are
* available for built-in types; for string classe; vector arrays;
* available for built-in types; for string classes; vector arrays;
* object pointers; and debug, warning, and error printout information.
*/

Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkMath.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ namespace Math
// These constants originate from VXL's vnl_math.h. They have been
// moved here to improve visibility, and to ensure that the constants
// are available during compile time ( as opposed to static ITK_CONSTEXPR
// member vaiables ).
// member variables ).


/** \brief \f[e\f] The base of the natural logarithm or Euler's number */
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkMetaDataDictionary.h
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ class ITKCommon_EXPORT MetaDataDictionary
std::vector<std::string>
GetKeys() const;

// Implement map's api. On some Micorsoft compilers, stl containers
// Implement map's api. On some Microsoft compilers, stl containers
// cannot be exported. This causes problems when building DLL's.
// Here we inherit privately from std::map and provide a simple
// API. The implementation will be in the DLL.
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkMetaDataObject.h
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ class ITK_TEMPLATE_EXPORT MetaDataObject : public MetaDataObjectBase
* \param Dictionary TODO
* \param key TODO
* \param invalue the value of type T that is to be encapsulated.
* \return A smartpointer ot a MetaDataObject that is suitable for
* \return A smartpointer to a MetaDataObject that is suitable for
* insertion into a MetaDataDictionary.
*/
template <typename T>
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkObjectFactoryBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ namespace itk
*
* ObjectFactoryBase is used to create itk objects. The base class
* ObjectFactoryBase contains a static method CreateInstance() that is
* used to create itk objects from the list of registerd ObjectFactoryBase
* used to create itk objects from the list of registered ObjectFactoryBase
* sub-classes. The first time CreateInstance() is called, all dll's or
* shared libraries in the environment variable ITK_AUTOLOAD_PATH are loaded
* into the current process. The C function itkLoad is called on each dll.
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkPoint.h
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ class ITK_TEMPLATE_EXPORT Point : public FixedArray<TCoordRep, VPointDimension>
+ (1-w_1-w_2 ) * \overrightarrow{P}_3
* \f]
*
* If the two weight are \f$ \in [0,1] \f$ , The resulting point will alway be placed
* If the two weight are \f$ \in [0,1] \f$ , The resulting point will always be placed
* inside the triangle formed by the three points given as arguments. */
void
SetToBarycentricCombination(const Self & A, const Self & B, const Self & C, double weightForA, double weightForB);
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkPolygonCell.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ PolygonCell<TCellInterface>::RemovePointId(PointIdentifier ptID)
}

/**
* clear all the point and edge informations
* clear all the point and edge information
*/
template <typename TCellInterface>
void
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkRGBAPixel.h
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ class ITK_TEMPLATE_EXPORT RGBAPixel : public FixedArray<TComponent, 4>
RGBAPixel &
operator=(const ComponentType r[4]);

/** Aritmetic operations between pixels. Return a new RGBAPixel. */
/** Arithmetic operations between pixels. Return a new RGBAPixel. */
Self
operator+(const Self & r) const;
Self
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkRGBPixel.h
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ class ITK_TEMPLATE_EXPORT RGBPixel : public FixedArray<TComponent, 3>
Self &
operator=(const ComponentType r[3]);

/** Aritmetic operations between pixels. Return a new RGBPixel. */
/** Arithmetic operations between pixels. Return a new RGBPixel. */
Self
operator+(const Self & r) const;
Self
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkRealTimeClock.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class ITKCommon_EXPORT RealTimeClock : public Object
/** Method for creation through the object factory */
itkNewMacro(Self);

/** Define the type for the timestap */
/** Define the type for the timestamp */
using TimeStampType = double;

/** Define the type for the frequency of the clock */
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkSize.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace itk
* \brief Represent a n-dimensional size (bounds) of a n-dimensional image.
*
* Size is a templated class to represent multi-dimensional array bounds,
* i.e. (I,J,K,...). Size is templated over teh dimension of the bounds.
* i.e. (I,J,K,...). Size is templated over the dimension of the bounds.
* ITK assumes the first element of a size (bounds) is the fastest moving index.
*
* For efficiency, Size does not define a default constructor, a
Expand Down
8 changes: 4 additions & 4 deletions Modules/Core/Common/include/itkSmapsFileParser.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ MapFileParser<TMapDataType>::GetHeapUsage() -> MemoryLoadType
{
if (m_MapData.Empty())
{
std::cerr << "Read a map file before quering memory usage";
std::cerr << "Read a map file before querying memory usage";
}
return m_MapData.GetHeapUsage();
}
Expand All @@ -58,7 +58,7 @@ MapFileParser<TMapDataType>::GetStackUsage() -> MemoryLoadType
{
if (m_MapData.Empty())
{
std::cerr << "Read a map file before quering memory usage";
std::cerr << "Read a map file before querying memory usage";
}
return m_MapData.GetStackUsage();
}
Expand All @@ -69,7 +69,7 @@ MapFileParser<TMapDataType>::GetTotalMemoryUsage() -> MemoryLoadType
{
if (m_MapData.Empty())
{
std::cerr << "Read a map file before quering memory usage";
std::cerr << "Read a map file before querying memory usage";
}
return m_MapData.GetTotalMemoryUsage();
}
Expand All @@ -80,7 +80,7 @@ MapFileParser<TMapDataType>::GetMemoryUsage(const char * filter, const char * to
{
if (m_MapData.Empty())
{
std::cerr << "Read a map file before quering memory usage";
std::cerr << "Read a map file before querying memory usage";
}
return m_MapData.GetMemoryUsage(filter, token);
}
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkStoppingCriterionBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class ITKCommon_EXPORT StoppingCriterionBase : public Object

/** \return \c true if the stopping criterion is reached (and the algorithm
must stop).
\return \c fasle else. */
\return \c false else. */
virtual bool
IsSatisfied() const = 0;
virtual std::string
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkStreamingImageFilter.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ StreamingImageFilter<TInputImage, TOutputImage>::UpdateOutputData(DataObject * i
}

/**
* Tell all Observers that the filter is starting, before emiting
* Tell all Observers that the filter is starting, before emitting
* the 0.0 Progress event
*/
this->InvokeEvent(StartEvent());
Expand Down
8 changes: 4 additions & 4 deletions Modules/Core/Common/include/itkSymmetricEigenAnalysis.h
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,7 @@ class ITK_TEMPLATE_EXPORT SymmetricEigenAnalysis
}


/* Implementation detail using EigenLib that do not peform a copy.
/* Implementation detail using EigenLib that do not perform a copy.
* It needs the existence of a pointer to matrix data. \sa GetPointerToMatrixData
* If new types want to use this method, an appropriate overload of GetPointerToMatrixData
* should be included.
Expand Down Expand Up @@ -698,7 +698,7 @@ class ITK_TEMPLATE_EXPORT SymmetricEigenAnalysis
return 1;
}

/* Implementation detail using EigenLib that do not peform a copy.
/* Implementation detail using EigenLib that do not perform a copy.
* It needs the existence of a pointer to matrix data. \sa GetPointerToMatrixData
* If new types want to use this method, an appropriate overload of GetPointerToMatrixData
* should be included.
Expand Down Expand Up @@ -890,7 +890,7 @@ class ITK_TEMPLATE_EXPORT SymmetricEigenAnalysisFixedDimension
return QMatrix::ValueType();
}

/* Implementation detail using EigenLib that do not peform a copy.
/* Implementation detail using EigenLib that do not perform a copy.
* It needs the existence of a pointer to matrix data. \sa GetPointerToMatrixData
* If new types want to use this method, an appropriate overload of GetPointerToMatrixData
* should be included.
Expand Down Expand Up @@ -1048,7 +1048,7 @@ class ITK_TEMPLATE_EXPORT SymmetricEigenAnalysisFixedDimension
return 1;
}

/* Implementation detail using EigenLib that do not peform a copy.
/* Implementation detail using EigenLib that do not perform a copy.
* It needs the existence of a pointer to matrix data. \sa GetPointerToMatrixData
* If new types want to use this method, an appropriate overload of GetPointerToMatrixData
* should be included.
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkSymmetricSecondRankTensor.h
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ class ITK_TEMPLATE_EXPORT SymmetricSecondRankTensor : public FixedArray<TCompone
Self &
operator=(const ComponentArrayType r);

/** Aritmetic operations between pixels. Return a new
/** Arithmetic operations between pixels. Return a new
SymmetricSecondRankTensor. */
Self
operator+(const Self & r) const;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ SymmetricSecondRankTensor<T, VDimension>::operator=(const ComponentType & r)
}

/**
* Assigment from a plain array
* Assignment from a plain array
*/
template <typename T, unsigned int VDimension>
SymmetricSecondRankTensor<T, VDimension> &
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkTimeStamp.h
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class ITKCommon_EXPORT TimeStamp
static Self *
New();

/** Destoy this instance. */
/** Destroy this instance. */
void
Delete()
{
Expand Down
2 changes: 1 addition & 1 deletion Modules/Core/Common/include/itkVariableLengthVector.h
Original file line number Diff line number Diff line change
Expand Up @@ -1202,7 +1202,7 @@ struct VariableLengthVectorExpression
: m_lhs(lhs)
, m_rhs(rhs)
{
// Not neccessary actually as end-user/developer is not expected to
// Not necessary actually as end-user/developer is not expected to
// provide new BinaryOperations
static_assert(std::is_base_of<Details::op::BinaryOperationConcept, TBinaryOp>::value,
"The Binary Operation shall inherit from BinaryOperationConcept");
Expand Down
Loading

0 comments on commit d8063f3

Please sign in to comment.