Metadata-Version: 2.4
Name: kzstack
Version: 1.0.0
Summary: a library to stack images
Author: Kevin Zhu
Author-email: kzhu2099@gmail.com
Maintainer: Kevin Zhu
Maintainer-email: kzhu2099@gmail.com
License: MIT License
        
        Copyright (c) 2025 Kevin Zhu
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/kzhu2099/KZ-Stack
Project-URL: Issues, https://github.com/kzhu2099/KZ-Stack/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# kzstack

- HomePage: https://github.com/kzhu2099/KZ-Stack
- Issues: https://github.com/kzhu2099/KZ-Stack/issues

[![PyPI Downloads](https://static.pepy.tech/badge/kzstack)](https://pepy.tech/projects/kzstack)

Author: Kevin Zhu

## Features

- ability to stack images
- gamma correction accounted
- custom quality / denoising functions
- image showing / saving
- bias usage

## Installation

To install kzstack, use pip: ```pip install kzstack```.

However, many prefer to use a virtual environment.

macOS / Linux:

```sh
# make your desired directory
mkdir /path/to/your/directory
cd /path/to/your/directory

# setup the .venv (or whatever you want to name it)
pip install virtualenv
python3 -m venv .venv

# install kzstack
source .venv/bin/activate
pip install kzstack

deactivate # when you are completely done
```

Windows CMD:

```sh
# make your desired directory
mkdir C:path\to\your\directory
cd C:path\to\your\directory

# setup the .venv (or whatever you want to name it)
pip install virtualenv
python3 -m venv .venv

# install kzstack
.venv\Scripts\activate
pip install kzstack

deactivate # when you are completely done
```

## Usage

First, import KZStack and all its functions (for denoising / quality).

Follow the provided `stack_accumualte.ipynb` for your data (change the path).

After, you may choose to use the average or input your own denoising / quality control functions.

These must be in the format of `def func(image)`, without additional parameters. Other `parameters` (like a threshold) should not be `args` to the function.

## License

The License is an MIT License found in the LICENSE file.
