Skip to main content

A set of tiling utilities

Project description

cztile - Python package to simplify the process of tiling arrays

This project provides simple-to-use tiling functionality for arrays. It is not linked directly to the CZI file format, but can be of use to process such images in an efficient and tile-wise manner, which is especially important when dealing with larger images.

Samples

The basic usage can be inferred from this sample notebook:
Open In Colab

System setup

The current version of this toolbox only requires a fresh Python >= 3.9 installation.

Supported Tiling Strategies

This package features the following tiling strategies:

AlmostEqualBorderFixedTotalAreaStrategy2D

This covers a total area with a minimal number of tiles of constant total area such that:

  • the image area is completely covered by tiles and is filled up with as few tiles as possible
  • the overlap/border between tiles is as small as possible, but it is ensured that at least a minimum border size is used
  • all interior tiles have the same size
  • a possible excess border is split among tiles and can lead to slightly different tile and border sizes at the edge
  • all interior tiles have at least a minimum border width/height on all sides
  • the edge tiles have zero border at the edge and at least the minimum border width on their inner sides.
  • The sizes of all non-zero borders differ at most by one pixel.

cztile - AlmostEqualBorderFixedTotalAreaStrategy2D

The core functionality is of course also available for 1D.

The AlmostEqualBorderFixedTotalAreaStrategy2D is based on the following algorithm:

Inputs

Image width: equation
Minimum interior border width (left or right): equation
Fixed total tile width: equation

Calculation of tile positions and borders

Case 1: equation
There is no solution. Fail!

Case 2: equation
Use a single tile with no borders.

Case 3: equation
Maximum inner tile width of edge tiles: equation
Maximum inner tile width of interior tiles: equation
Total interior tile width: equation
Number of tiles: equation
Excess border: equation
Total number of non-zero left and right borders: equation
Fractional excess border: equation
The first non-zero border has index equation, the last has index equation. Tile equation is surrounded by the borders with index equation and equation.
Cumulative excess border for all borders up to border equation: equation for equation
Cumulative border for all borders up to border equation: equation for equation
Tile boundaries: equation
Tile equation for equation:

  • Left-most pixel of inner tile: equation
  • Right-most pixel of inner tile: equation
  • Inner tile width: equation
  • Total border width: equation
  • Left border width: equation
  • Right border width: equation
  • Left-most border pixel: equation
  • Right-most-border pixel: equation

Disclaimer

The libary and the notebook are free to use for everybody. Carl Zeiss Microscopy GmbH undertakes no warranty concerning the use of those tools. Use them at your own risk.

By using any of those examples you agree to this disclaimer.

Version: 2025.05.20

Copyright (c) 2025 Carl Zeiss AG, Germany. All Rights Reserved.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cztile-1.0.0.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cztile-1.0.0-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file cztile-1.0.0.tar.gz.

File metadata

  • Download URL: cztile-1.0.0.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.4

File hashes

Hashes for cztile-1.0.0.tar.gz
Algorithm Hash digest
SHA256 6553826ea6badcad08b949e2f7534235bc14c93aeea0f3c5ca240def6ceffe76
MD5 d49a787491855bdc48c3872322bba8bc
BLAKE2b-256 0eecce28814fc3ea9e26eaffac8b98c4cb1e7e1e35ed47dc0d1001eb82120792

See more details on using hashes here.

File details

Details for the file cztile-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: cztile-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.4

File hashes

Hashes for cztile-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d3e770386935817274bb261f65c4186bdee9d50bc299e1000b18aa06350b871f
MD5 b7f3083f6c460949b15bfd8dce457579
BLAKE2b-256 d1f8c301cf2a730b9788b08af4c90248766ef392162e5a367ad75c21d4ee78f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page