MAFW Tools

A set of commonly used tools to be used with MAFw and other data analysis frameworks.

This package is often used as an incubator for tools that sooner or later will gain the stability and the required completeness to be included into MAFw.

Table of Contents

• Installation
• Features
• Usage
• Documentation
• Contributing
• License

Installation

Install the package using pip:

pip install mafw-tools

Or install in development mode:

pip install -e .

Features

This package provides utility functions for:

• File Operations: Pickle serialization/deserialization with support for compressed files
• Plotting Tools: Flexible image plotting with customizable axes, titles, and colorbars
• Generic Utilities: Helper functions for common operations like nested attribute retrieval

Usage

Import the package or the modules to enjoy the tools.

File tools example

from mafw_tools.file_tools import save_to_pickle, load_from_pickle

# Save multiple objects to a pickle file
data = {'key': 'value'}
save_to_pickle('data.pkl', zipped=True, my_data=data)

# Load objects from pickle file
loaded_data = load_from_pickle('data.pkl')

Plotting tools example

import matplotlib.pyplot as plt
import numpy as np
from mafw_tools.plotting_tools import plot_image

fig, ax = plt.subplots()
data = np.random.rand(10, 10)
plot_image(data, ax, title="Sample Image", attach_colorbar=True)
plt.show()

Generic tools example

from mafw_tools.generic_tools import getattr_nested

class First:
    def __init__(self, a):
        self.a = a

class Second:
    def __init__(self, b):
        self.b = First(b)

m = Second(3)
value = getattr_nested(m, 'b.a')  # Returns 3

Documentation

Full documentation is available at https://gitlab.jrc.ec.europa.eu/jrc-projects/autorad/mafw-tools

Contributing

Contributions are welcome! Please follow these steps:

• Fork the repository
• Create a feature branch
• Commit your changes
• Push to the branch
• Create a Pull Request