Image redactions Leave feedback
On this page
GroupDocs.Redactions provides a set of features to redact data of sensitive nature from images of various formats like JPG, PNG, TIFF and others. See full list at supported document formats article.
GroupDocs.Redaction supports two ways of redacting images, both in separate image files and embedded images:
- You can put a colored box over a given area, such as header, footer, or an area, where customer’s data are expected to appear.
- You can use any 3-rd party OCR engine to process the image, search it for text and redact sensitive data within the image.
GroupDocs.Redaction for Python via .NET also allows you to change image metadata (e.g. edit EXIF data of an image or act as an “EXIF eraser”).
In order to redact image area, you have to use ImageAreaRedaction class:
from groupdocs.redaction import Redactor, RedactionStatus
from groupdocs.redaction.options import SaveOptions
from groupdocs.redaction.redactions import ImageAreaRedaction, RegionReplacementOptions
from groupdocs.pydrawing import Color, Point, Size
def redact_image_area():
# Define the top-left position of the area to redact
sample_point = Point(385, 485)
# Define the size of the area which needs to be redacted
sample_size = Size(1793, 2069)
# Define the color of the redaction box
color = Color.from_argb(255, 220, 20, 60)
# Specify the redaction options
repl_opt = RegionReplacementOptions(color, sample_size)
img_red = ImageAreaRedaction(sample_point, repl_opt)
# Load the document to be redacted
with Redactor("./sample.jpg") as redactor:
# Apply the redaction
result = redactor.apply(img_red)
if result.status != RedactionStatus.FAILED:
# By default, the redacted document is saved in PDF format
save_options = SaveOptions()
save_options.add_suffix = True
save_options.rasterize_to_pdf = True
save_options.redacted_file_suffix = "redacted"
redactor.save(save_options)
if __name__ == "__main__":
redact_image_area()
sample.jpg is the sample file used in this example. Click here to download it.
Binary file (PDF, 2.7 MB)
If the redaction cannot be applied to this type of files, e.g. MS Word document without embedded images, RedactorChangeLog.Status will be RedactionStatus.Skipped.
The following example demonstrates how to edit exif data (erase them) from a photo or any other image:
from groupdocs.redaction import Redactor
from groupdocs.redaction.options import SaveOptions
from groupdocs.redaction.redactions import EraseMetadataRedaction, MetadataFilters
def clean_image_metadata():
# Specify the redaction options to remove all image metadata (e.g. EXIF)
er_opt = EraseMetadataRedaction(MetadataFilters.ALL)
# Load the image to be redacted
with Redactor("./sample.jpg") as redactor:
# Apply the redaction
result = redactor.apply(er_opt)
# Save the redacted image next to the source file
so = SaveOptions()
so.add_suffix = True
so.rasterize_to_pdf = False
so.redacted_file_suffix = "redacted"
redactor.save(so)
if __name__ == "__main__":
clean_image_metadata()
sample.jpg is the sample file used in this example. Click here to download it.
Binary file (JPG, 3.1 MB)
If the redaction cannot be applied to this type of files, e.g. BMP image, RedactorChangeLog.Status will be RedactionStatus.Skipped.
You can redact image area within all kinds of embedded images inside a document.
The following example demonstrates how to redact all embedded images within a Microsoft Word document:
from groupdocs.redaction import Redactor, RedactionStatus
from groupdocs.redaction.options import SaveOptions
from groupdocs.redaction.redactions import ImageAreaRedaction, RegionReplacementOptions
from groupdocs.pydrawing import Color, Point, Size
def redact_embedded_images():
# Define the top-left position of the area to redact
sample_point = Point(516, 311)
# Define the size of the area which needs to be redacted
sample_size = Size(170, 35)
# Define the color of the redaction box
color = Color.from_argb(255, 220, 20, 60)
# Specify the redaction options
repl_opt = RegionReplacementOptions(color, sample_size)
img_red = ImageAreaRedaction(sample_point, repl_opt)
# Load the document to be redacted
with Redactor("./sample.docx") as redactor:
# Apply the redaction to all embedded images
result = redactor.apply(img_red)
if result.status != RedactionStatus.FAILED:
# By default, the redacted document is saved in PDF format
save_options = SaveOptions()
save_options.add_suffix = True
save_options.rasterize_to_pdf = True
save_options.redacted_file_suffix = "redacted"
redactor.save(save_options)
if __name__ == "__main__":
redact_embedded_images()
sample.docx is the sample file used in this example. Click here to download it.
Binary file (PDF, 1022 KB)
If the redaction cannot be applied to this type of files, e.g. a spreadsheet document, RedactorChangeLog.Status will be RedactionStatus.Skipped.
You can remove frames from a multi-frame image with a given origin and frame count. For additional information look at remove page redactions article.
Some image formats, such as DjVu documents, require pre-rasterization and further saving in PDF format.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
