objscale 1.3.0

Object-based analysis functions for fractal dimensions and size distributions

Figure from DeWitt et al. (2025)

objscale

Object-based analysis functions for fractal dimensions and size distributions in atmospheric sciences and beyond. Optimized for large datasets.

Description

objscale provides computational tools for analyzing the scaling properties of objects in 2D binary arrays. The package consolidates methods for calculating size distributions and fractal dimensions that account for finite domain effects and complex boundary conditions. Originally developed for atmospheric science applications, these methods apply broadly to any field where object scaling properties matter.

The package implements methods from two main papers:

• DeWitt & Garrett (2024) - finite domain effects in size distributions
• DeWitt et al. (2025) - fractal dimensions for cloud field characterization

See the interactive scaling explorer to visualize how the correlation dimension is computed.

Key Functions

finite_array_powerlaw_exponent

Calculate power-law exponents for size distributions while accounting for finite domain truncation effects. Essential for accurate scaling analysis in bounded domains.

individual_fractal_dimension

Fractal dimension of individual objects using the perimeter-area relationship, with proper handling of interior holes and resolution effects.

individual_correlation_dimension

Correlation dimension of a single object. Isolates the Nth largest structure in an array (after removing border-touching structures) and computes its correlation dimension.

ensemble_correlation_dimension

Correlation dimension for characterizing the collective scaling properties of object ensembles. Uses point-pair correlation analysis across multiple length scales.

ensemble_box_dimension

Box-counting dimension for object ensembles. New analyses should prefer ensemble_correlation_dimension. Counts boxes containing object boundaries at varying spatial scales.

Installation

pip install objscale

Documentation

📖 Full Documentation

Complete API reference, detailed examples, and usage guides are available at objscale.readthedocs.io.

Agent Skill (Highly Recommended for Agents)

An agent skill is included in this repository. For Claude Code:

mkdir -p ~/.claude/skills/objscale
cp agent-skills/objscale/SKILL.md ~/.claude/skills/objscale/

Codex:

mkdir -p ~/.codex/skills/objscale
cp agent-skills/objscale/SKILL.md ~/.codex/skills/objscale/

Quick Example

import objscale
import numpy as np

# Create binary array (e.g., cloud mask, percolation lattice)
arrays = [(np.random.random((1000, 1000)) < 0.3).astype(int) for _ in range(4)]

# Size distribution with finite domain corrections
(exponent, error), (log10_sizes, log10_counts) = objscale.finite_array_powerlaw_exponent(
    arrays, 'area', return_counts=True
)

# Ensemble fractal dimensions
corr_dim, corr_error = objscale.ensemble_correlation_dimension(arrays)
box_dim, box_error = objscale.ensemble_box_dimension(arrays)

# Individual object analysis  
ind_dim, ind_error = objscale.individual_fractal_dimension(arrays)

Features

• Finite domain corrections: Proper handling of truncation effects at domain boundaries as recommended by DeWitt & Garrett (2024)
• Multiple size metrics: Area, perimeter, width, height, nested perimeter
• Arbitrary boundaries: Support for NaN-demarcated non-rectangular domains
• Individual and Ensemble methods: Characterize both individual and collective properties of object fields
• Performance optimized: Numba acceleration for computational efficiency. Can handle billions of individual objects on a mid-range laptop.

Requirements

• Python ≥ 3.8
• NumPy ≥ 1.20.0
• SciPy ≥ 1.7.0
• scikit-image ≥ 0.18.0
• Numba ≥ 0.56.0

Available Functions

Fractal Dimensions

• individual_fractal_dimension - Fractal dimension of individual objects (perimeter-area scaling)
• individual_correlation_dimension - Correlation dimension of a single object
• ensemble_correlation_dimension - Correlation dimension for object ensembles
• ensemble_box_dimension - Box-counting dimension for object ensembles

Size Distributions

• finite_array_powerlaw_exponent - Power-law exponents with finite domain corrections
• finite_array_size_distribution - Size distributions with truncation analysis
• array_size_distribution - Basic size distribution for single arrays

Object Analysis

• label_structures - Label connected components (wraps scipy.ndimage.label with NaN handling and periodic boundaries)
• get_structure_areas - Calculate areas of labelled structures (O(n), fast)
• get_structure_perimeters - Calculate perimeters of labelled structures (O(n), fast)
• get_structure_height_width - Calculate height and width of labelled structures
• get_structure_props - Calculate perimeter, area, width, height from a binary array (convenience wrapper)
• get_every_boundary_perimeter - Perimeters of every boundary including nested holes
• total_perimeter - Total perimeter of all objects
• total_number - Count number of structures
• isolate_nth_largest_structure - Extract the Nth largest connected structure
• remove_structures_touching_border_nan - Remove border-touching structures
• remove_structure_holes - Fill holes in structures
• label_size - Label each structure with its size value
• clear_border_adjacent - Clear structures touching array edges

Utilities

• coarsen_array - Coarsen array resolution by averaging
• linear_regression - Linear regression with error estimates
• encase_in_value - Add border of specified value around array
• get_coords_of_boundaries - Find boundary pixel coordinates (toroidal topology)
• get_locations_from_pixel_sizes - Convert pixel size arrays to cumulative locations
• set_num_threads - Set number of threads for parallel computations

For detailed parameter descriptions and usage examples, see the full documentation or use help(objscale.function_name) or objscale.function_name? in IPython/Jupyter.

Support Statement

This package consolidates research code developed over several years. While functional and tested, it should be considered research software with limited ongoing support. Users are encouraged to understand the underlying methods through the referenced papers before applying to their data.

References

If you use this package, please cite:

DeWitt, T. D. and Garrett, T. J.: Finite domains cause bias in measured and modeled distributions of cloud sizes, Atmos. Chem. Phys., 24, 8457–8472, https://doi.org/10.5194/acp-24-8457-2024, 2024.

Author

Thomas D. DeWitt University of Utah Department of Atmospheric Sciences

Sonnet 4 with Claude Code Anthropic

License

MIT License