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

Add docstring to the transform module #6797

Merged
merged 16 commits into from Apr 4, 2023
34 changes: 34 additions & 0 deletions skimage/transform/__init__.py
@@ -1,3 +1,37 @@
"""Utilities to perform various transforms.

This module includes tools to transform images and volumetric data
such as:

- Geometric Transformations: These transforms change the shape or position
of an image. They are useful for tasks such as image registration,
alignment, and geometric correction.
Examples: Affine transform, Projective transform, Euclidean
transform etc.
lagru marked this conversation as resolved.
Show resolved Hide resolved

- Image Resizing and Rescaling: These transforms change the size or
resolution of an image. They are useful for tasks such as
down-sampling an image to reduce its size or up-sampling an
image to increase its resolution.
Examples: Resize, Rescale etc.
lagru marked this conversation as resolved.
Show resolved Hide resolved

- Feature Detection and Extraction: These transforms identify and
extract specific features or patterns in an image. They are useful
for tasks s object detection, image segmentation, and
feature matching
Examples: Hough transforms, Pyramid Transforms, Radon transforms etc.

- Image Transformation: These transforms change the appearance of an
image without changing its content. They are useful for tasks such a
creating image mosaics, applying artistic effects, and visualizing
image data.
Examples: Wrap transform, Inverse transforms etc.

For more information on each transform, see their respective docstrings

"""


from .hough_transform import (hough_line, hough_line_peaks,
probabilistic_hough_line, hough_circle,
hough_circle_peaks, hough_ellipse)
Expand Down