Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix some typos #751

Merged
merged 1 commit into from
Jul 8, 2024
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ Here is an example of such lightweight workflow in Linux environment (Debian-bas
- option `-DBoost_ARCHITECTURE=-x64` to help CMake find Boost 1.66 and above
add an architecture tag to the library file names in versioned build
The option added in CMake 3.13.0.
- option `-DDBoost_ADDITIONAL_VERSIONS=<unreleased Boost version>` is especially usefull
- option `-DDBoost_ADDITIONAL_VERSIONS=<unreleased Boost version>` is especially useful
when testing GIL with staged build of Boost from its `develop` branch.
- if CMake is still failing to find Boost, you may try `-DBoost_DEBUG=ON` to
get detailed diagnostics output from `FindBoost.cmake` module.
Expand Down
2 changes: 1 addition & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

- Fixed convolution in `convolve_2d` ([PR #723](https://github.com/boostorg/gil/pull/723))
- Normalize Gaussian 2D kernel to avoid darkening ([PR #725](https://github.com/boostorg/gil/pull/725))
- Wrong buffer size in path string conversion functionss for `std::wstring` is fixed, avoiding buffer
- Wrong buffer size in path string conversion functions for `std::wstring` is fixed, avoiding buffer
overflows when using I/O-related functions with `std::wstring` paths ([PR #746](https://github.com/boostorg/gil/pull/764)).

### Acknowledgements
Expand Down
2 changes: 1 addition & 1 deletion doc/histogram/cumulative.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Overview

A cumulative histogram is a histogram in which each bin stores the count / frequency of itself
as well as all the bins with keys 'smaller' than the particular bin.
As such, a notion of ordering among its keys should be existant in the histogram.
As such, a notion of ordering among its keys should be existent in the histogram.

The GIL histogram class has the ability to convert itself into its cumulative version.

Expand Down
2 changes: 1 addition & 1 deletion example/affine.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

// This example relies on the matrices and functions available in GIL to define the operation,
// in include/boost/gil/extension/numeric/affine.hpp
// and calls resample_pixels(), avaiable in the numeric extension, to apply it
// and calls resample_pixels(), available in the numeric extension, to apply it.

int main()
{
Expand Down
2 changes: 1 addition & 1 deletion example/anisotropic_diffusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Anisotropic diffusion capabilities in GIL are demonstrated by the program `aniso
- The fourth parameter is the number of iterations, which *must* be a positive integer
- The fifth and last parameter is the value of the kappa constant

Note that both the input and the ouput images must be in the PNG format.
Note that both the input and the output images must be in the PNG format.

## Specific requirements

Expand Down
2 changes: 1 addition & 1 deletion example/hough_transform_circle.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ namespace gil = boost::gil;
// The function hough_circle_transform_brute, defined in include/boost/gil/image_processing/hough_transform.cpp,
// accepts a greyscale edge map, the three Hough parameters allowing to do the drawing and the voting,
// an accumulator in the form of an iterator of views of the parameter space and a utility rasterizer to produce the points.
// The example outputs the voting cell of the centre of a circle drawn programatically.
// The example outputs the voting cell of the centre of a circle drawn programmatically.
// See also:
// hough_transform_line.cpp - Hough transform to detect lines

Expand Down
2 changes: 1 addition & 1 deletion example/hough_transform_circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Hough circle transform capabilities in GIL are demonstrated by the program `houg

The program doesn't take any argument on the command line.

The program outputs the voting cell of the centre of a circle drawn programatically.
The program outputs the voting cell of the centre of a circle drawn programmatically.

## Specific requirements

Expand Down
2 changes: 1 addition & 1 deletion example/morphology.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ int main(int argc, char** argv)
" <operation1> <operation2> <operation3> <operation4> <operation5> "
"<operation6>"
" <operation7> <operation8>\n");
// User has to enter atleast one operation and they can enter maximum 8
// User has to enter at least one operation and they can enter maximum 8
// operations considering binary conversion to be an
// operation.Output_image_template argument is the common component which
// will be added in names of all output images followed by a hyphen and
Expand Down
6 changes: 3 additions & 3 deletions example/rasterizer_ellipse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Ellipse rasterization capabilities in GIL are demonstrated by the program `raste
The program doesn't take any argument on the command line.

`rasterizer_ellipse` produces three images in the current directory:
- `rasterized_ellipse_gray.jpg`, in the JPEG format, wich is a greyscale image of an ellipse
- `rasterized_ellipse_rgb.jpg`, in the JPEG format, wich is an RGB image of an ellipse
- `rasterized_ellipse_rgb_out_of_bound.jpg`, in the JPEG format, wich is an RGB image of an ellipse bigger than the containinig view.
- `rasterized_ellipse_gray.jpg`, in the JPEG format, which is a greyscale image of an ellipse
- `rasterized_ellipse_rgb.jpg`, in the JPEG format, which is an RGB image of an ellipse
- `rasterized_ellipse_rgb_out_of_bound.jpg`, in the JPEG format, which is an RGB image of an ellipse bigger than the containinig view.

## Specific requirements

Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/channel_algorithm.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ namespace detail
return (tmp + (tmp >> 8)) >> 8;
}

// fast integer divison by 32768
// fast integer division by 32768
inline auto div32768(uint32_t in) -> uint32_t
{
return (in + 16384) >> 15;
Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/channel_numeric_operations.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ struct channel_minus_scalar_t
/// \param scalar - subtrahend operand of the subtraction.
auto operator()(ChannelRef channel, Scalar const& scalar) const -> ChannelResult
{
// TODO: Convertion after subtraction vs conversion of operands in channel_minus_t?
// TODO: Conversion after subtraction vs conversion of operands in channel_minus_t?
return ChannelResult(channel - scalar);
}
};
Expand Down
6 changes: 3 additions & 3 deletions include/boost/gil/color_convert.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ template <typename P> struct channel_type;
////////////////////////////////////////////////////////////////////////////////////////

/// \ingroup ColorConvert
/// \brief Color Convertion function object. To be specialized for every src/dst color space
/// \brief Color Conversion function object. To be specialized for every src/dst color space
template <typename C1, typename C2>
struct default_color_converter_impl
{
Expand All @@ -47,7 +47,7 @@ struct default_color_converter_impl
};

/// \ingroup ColorConvert
/// \brief When the color space is the same, color convertion performs channel depth conversion
/// \brief When the color space is the same, color conversion performs channel depth conversion
template <typename C>
struct default_color_converter_impl<C,C> {
template <typename P1, typename P2>
Expand Down Expand Up @@ -319,7 +319,7 @@ struct default_color_converter_impl<rgba_t,rgba_t> {
}
};

/// @defgroup ColorConvert Color Space Converion
/// @defgroup ColorConvert Color Space Conversion
/// \ingroup ColorSpaces
/// \brief Support for conversion between pixels of different color spaces and channel depths

Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/concepts/pixel_iterator.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ struct RandomAccessIteratorIsMemoryBasedConcept
ignore_unused_variable_warning(bd);

memunit_advance(it,3);
// for performace you may also provide a customized implementation of memunit_advanced_ref
// for performance you may also provide a customized implementation of memunit_advanced_ref
}
Iterator it;
};
Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/extension/dynamic_image/dynamic_at_c.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

namespace boost { namespace gil {

// Constructs for static-to-dynamic integer convesion
// Constructs for static-to-dynamic integer conversion

#define BOOST_GIL_AT_C_VALUE(z, N, text) mp11::mp_at_c<IntTypes, S+N>::value,
#define BOOST_GIL_DYNAMIC_AT_C_LIMIT 226 // size of the maximum vector to handle
Expand Down
4 changes: 2 additions & 2 deletions include/boost/gil/extension/io/bmp/tags.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ static const uint32_t bmp_signature = 0x4D42; /// Constant signature for bmp fil
template<>
struct image_read_info< bmp_tag >
{
/// Default contructor.
/// Default constructor.
image_read_info()
: _top_down(false)
, _valid( false )
Expand Down Expand Up @@ -118,7 +118,7 @@ struct image_read_info< bmp_tag >

bmp_top_down::type _top_down;

/// Used internaly to identify is the header has been read.
/// Used internally to identify is the header has been read.
bool _valid;
};

Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/extension/io/png/tags.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ struct png_info_base
png_bitdepth::type _bit_depth;
/// The color space type.
png_color_type::type _color_type;
/// The interlace methos.
/// The interlace method.
png_interlace_method::type _interlace_method;
/// The compression method.
png_compression_method::type _compression_method;
Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/extension/io/pnm/detail/read.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ class reader< Device
if( process )
{
// We are reading a gray1_image like a gray8_image but the two pixel_t
// aren't compatible. Though, read_and_no_convert::read(...) wont work.
// aren't compatible. Though, read_and_no_convert::read(...) won't work.
copy_data< View_Dst
, View_Src >( dst
, src
Expand Down
4 changes: 2 additions & 2 deletions include/boost/gil/extension/io/raw/tags.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ struct raw_unpack_function_name : property_base< std::string > {};
template<>
struct image_read_info< raw_tag >
{
/// Default contructor.
/// Default constructor.
image_read_info()
: _valid( false )
{}
Expand Down Expand Up @@ -164,7 +164,7 @@ struct image_read_info< raw_tag >
raw_libraw_version::type _libraw_version;
raw_unpack_function_name::type _unpack_function_name;

/// Used internaly to identify if the header has been read.
/// Used internally to identify if the header has been read.
bool _valid;
};

Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/extension/io/targa/tags.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ struct targa_screen_origin_bit : property_base< bool > {};
template<>
struct image_read_info< targa_tag >
{
/// Default contructor.
/// Default constructor.
image_read_info()
: _screen_origin_bit(false)
, _valid( false )
Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/extension/io/tiff/detail/is_allowed.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ struct Format_Type
// return SAMPLEFORMAT_IEEEFP;
// }
//
// io_error( "Unkown channel format." );
// io_error( "Unknown channel format." );
//}

// The following two functions look the same but are different since one is using
Expand Down
4 changes: 2 additions & 2 deletions include/boost/gil/extension/io/tiff/detail/writer_backend.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ struct writer_backend< Device

if(! this->_info._photometric_interpretation_user_defined )
{
// write photometric interpretion - Warning: This value is rather
// write photometric interpretation - Warning: This value is rather
// subjective. The user should better set this value itself. There
// is no way to decide if a image is PHOTOMETRIC_MINISWHITE or
// PHOTOMETRIC_MINISBLACK. If the user has not manually set it, then
Expand Down Expand Up @@ -86,7 +86,7 @@ struct writer_backend< Device

// write bits per sample
// @todo: Settings this value usually requires to write for each sample the bit
// value seperately in case they are different, like rgb556.
// value separately in case they are different, like rgb556.
tiff_bits_per_sample::type bits_per_sample = detail::unsigned_integral_num_bits< channel_t >::value;
this->_io_dev.template set_property<tiff_bits_per_sample>( bits_per_sample );

Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/extension/numeric/sampler.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ bool sample(bilinear_sampler, SrcView const& src, point<F> const& p, DstP& resul
}
else if (p0.y+1<src.height())
{
// most common case - inside the image, not on the frist nor last row/column
// most common case - inside the image, not on the first nor last row/column
detail::add_dst_mul_src<SrcP,F,pixel<F,devicen_layout_t<num_channels<SrcView>::value> > >()(*loc, (1-frac.x)*(1-frac.y),mp);
detail::add_dst_mul_src<SrcP,F,pixel<F,devicen_layout_t<num_channels<SrcView>::value> > >()(loc.x()[1], frac.x *(1-frac.y),mp);
++loc.y();
Expand Down
4 changes: 2 additions & 2 deletions include/boost/gil/extension/toolbox/color_spaces/ycbcr.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ T const& clamp(
template<>
struct default_color_converter_impl<ycbcr_601__t, rgb_t>
{
// Note: the RGB_t channels range can be set later on by the users. We dont want to cast to uint8_t or anything here.
// Note: The RGB_t channels range can be set later on by the users. We don't want to cast to uint8_t or anything here.
template < typename SRCP, typename DSTP >
void operator()( const SRCP& src, DSTP& dst ) const
{
Expand Down Expand Up @@ -130,7 +130,7 @@ struct default_color_converter_impl<ycbcr_601__t, rgb_t>
src_channel_t cb = channel_convert<src_channel_t>( get_color(src, cb_t()));
src_channel_t cr = channel_convert<src_channel_t>( get_color(src, cr_t()));

// The intermediate results of the formulas require at least 16bits of precission.
// The intermediate results of the formulas require at least 16 bits of precision.
std::int_fast16_t c = y - 16;
std::int_fast16_t d = cb - 128;
std::int_fast16_t e = cr - 128;
Expand Down
20 changes: 10 additions & 10 deletions include/boost/gil/image_processing/convolve.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ namespace boost { namespace gil {
namespace detail {

/// \brief Computes the cross-correlation of 1D kernel with rows of an image.
/// \tparam PixelAccum - Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum - Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView - Specifies the type of gil view of source image which is to be row correlated
/// with the kernel.
Expand Down Expand Up @@ -196,7 +196,7 @@ struct correlator_k

/// \ingroup ImageAlgorithms
/// \brief Correlate 1D variable-size kernel along the rows of image.
/// \tparam PixelAccum Specifies tha data type which will be used while creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used while creating buffer container
/// which is utilized for holding source image pixels after applying appropriate boundary
/// manipulations.
/// \tparam SrcView Models ImageViewConcept
Expand All @@ -216,7 +216,7 @@ void correlate_rows(

/// \ingroup ImageAlgorithms
/// \brief Correlates 1D variable-size kernel along the columns of image.
/// \tparam PixelAccum Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView Models ImageViewConcept
/// \tparam Kernel Specifies the type of 1D kernel which will be column correlated with source
Expand All @@ -236,7 +236,7 @@ void correlate_cols(

/// \ingroup ImageAlgorithms
/// \brief Convolves 1D variable-size kernel along the rows of image.
/// \tparam PixelAccum Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView Models ImageViewConcept
/// \tparam Kernel Specifies the type of 1D kernel which will be row convoluted with source image.
Expand All @@ -254,7 +254,7 @@ void convolve_rows(

/// \ingroup ImageAlgorithms
/// \brief Convolves 1D variable-size kernel along the columns of image.
/// \tparam PixelAccum Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView Models ImageViewConcept
/// \tparam Kernel Specifies the type of 1D kernel which will be column convoluted with source
Expand All @@ -274,7 +274,7 @@ void convolve_cols(

/// \ingroup ImageAlgorithms
/// \brief Correlate 1D fixed-size kernel along the rows of image.
/// \tparam PixelAccum Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView Models ImageViewConcept
/// \tparam Kernel Specifies the type of 1D kernel which will be row correlated with source image.
Expand All @@ -293,7 +293,7 @@ void correlate_rows_fixed(

/// \ingroup ImageAlgorithms
/// \brief Correlate 1D fixed-size kernel along the columns of image
/// \tparam PixelAccum Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView Models ImageViewConcept
/// \tparam Kernel Specifies the type of 1D kernel which will be column correlated with source
Expand All @@ -313,7 +313,7 @@ void correlate_cols_fixed(

/// \ingroup ImageAlgorithms
/// \brief Convolve 1D fixed-size kernel along the rows of image
/// \tparam PixelAccum Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView Models ImageViewConcept
/// \tparam Kernel Specifies the type of 1D kernel which will be row convolved with source image.
Expand All @@ -331,7 +331,7 @@ void convolve_rows_fixed(

/// \ingroup ImageAlgorithms
/// \brief Convolve 1D fixed-size kernel along the columns of image
/// \tparam PixelAccum Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView Models ImageViewConcept
/// \tparam Kernel Specifies the type of 1D kernel which will be column convolved with source
Expand All @@ -354,7 +354,7 @@ namespace detail

/// \ingroup ImageAlgorithms
/// \brief Convolve 1D variable-size kernel along both rows and columns of image
/// \tparam PixelAccum Specifies tha data type which will be used for creating buffer container
/// \tparam PixelAccum Specifies the data type which will be used for creating buffer container
/// utilized for holding source image pixels after applying appropriate boundary manipulations.
/// \tparam SrcView Models ImageViewConcept
/// \tparam Kernel Specifies the type of 1D kernel which will be used for 1D row and column
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ namespace boost { namespace gil {
/// 1. If histogram A is to be equalized compute the cumulative histogram of A.
/// 2. Let CFD(A) refer to the cumulative histogram of A
/// 3. For a uniform histogram A', CDF(A') = A'
/// 4. We need to transfrom A to A' such that
/// 4. We need to transform A to A' such that
/// 5. CDF(A') = CDF(A) => A' = CDF(A)
/// 6. Hence the pixel transform , px => histogram_of_ith_channel[px].
///
Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/image_processing/numeric.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#include <boost/gil/image_view.hpp>
#include <boost/gil/typedefs.hpp>
#include <boost/gil/detail/math.hpp>
// fixes ambigious call to std::abs, https://stackoverflow.com/a/30084734/4593721
// fixes ambiguous call to std::abs, https://stackoverflow.com/a/30084734/4593721
#include <cstdlib>
#include <cmath>

Expand Down
4 changes: 2 additions & 2 deletions include/boost/gil/image_processing/scaling.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
namespace boost { namespace gil {

/// \defgroup ScalingAlgorithms
/// \brief Algorthims suitable for rescaling
/// \brief Algorithms suitable for rescaling
///
/// These algorithms are used to improve image quality after image resizing is made.
///
/// \defgroup DownScalingAlgorithms
/// \ingroup ScalingAlgorithms
/// \brief Algorthims suitable for downscaling
/// \brief Algorithms suitable for downscaling
///
/// These algorithms provide best results when used for downscaling. Using for upscaling will
/// probably provide less than good results.
Expand Down
2 changes: 1 addition & 1 deletion include/boost/gil/io/base.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ struct image_read_settings_base
/**
* Boolean meta function, std::true_type if the pixel type \a PixelType is supported
* by the image format identified with \a FormatTag.
* \todo the name is_supported is to generic, pick something more IO realted.
* \todo the name is_supported is to generic, pick something more I/O-related.
*/
// Depending on image type the parameter Pixel can be a reference type
// for bit_aligned images or a pixel for byte images.
Expand Down
Loading
Loading