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.x installation. Being a pure Python wheel, it was tested with Python 3.9 on Windows.

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: 2022.04.06

Copyright (c) 2022 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-0.1.2.tar.gz (11.7 kB view hashes)

Uploaded Source

Built Distribution

cztile-0.1.2-py3-none-any.whl (12.4 kB view hashes)

Uploaded Python 3

Supported by

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