Skip to main content
# Pixel Clusterizer [![Build Status](https://travis-ci.org/SiLab-Bonn/pixel_clusterizer.svg?branch=master)](https://travis-ci.org/SiLab-Bonn/pixel_clusterizer) [![Build Status](https://ci.appveyor.com/api/projects/status/github/SiLab-Bonn/pixel_clusterizer)](https://ci.appveyor.com/project/SiLab-Bonn/pixel_clusterizer) [![Coverage Status](https://coveralls.io/repos/github/SiLab-Bonn/pixel_clusterizer/badge.svg?branch=master)](https://coveralls.io/github/SiLab-Bonn/pixel_clusterizer?branch=master)

Pixel_clusterizer is an easy to use pixel hit-clusterizer for Python. It clusters hits on an event basis in space and time.

The hits have to be defined as a numpy recarray. The array has to have the following fields:
- event_number
- frame
- column
- row
- charge

or a mapping of the names has to be provided. The data type does not matter.

The result of the clustering is the hit array extended by the following fields:
- cluster_ID
- is_seed
- cluster_size
- n_cluster

A new array with cluster information is also created created and has the following fields:
- event_number
- ID
- size
- charge
- seed_column
- seed_row
- mean_column
- mean_row



# Installation

The stable code is hosted on PyPI and can be installed by typing:

pip install pixel_clusterizer

# Usage

```
import numpy as np

from pixel_clusterizer import clusterizer

hits = np.ones(shape=(3, ), dtype=clusterizer.hit_data_type) # Create some data with std. hit data type

cr = clusterizer.HitClusterizer() # Initialize clusterizer

hits_clustered, cluster = cr.cluster_hits(hits) # Cluster hits

```
Also take a look at the example folder!

# Test installation
```
nosetests pixel_clusterizer
```

Metadata

Release files for pixel-clusterizer 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pixel-clusterizer 3.0.0
File Size Uploaded
pixel_clusterizer-3.0.0.tar.gz 33.7 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for pixel-clusterizer 3.0.0
File Interpreter ABI Platform
pixel_clusterizer-3.0.0-py3-none-any.whl Python 3 none any Details
pixel_clusterizer-3.0.0-py2-none-any.whl Python 2 none any Details

Total release size: 106.0 kB

Release files / pixel_clusterizer-3.0.0.tar.gz

Download URL pixel_clusterizer-3.0.0.tar.gz
Size 33.7 kB
Tags Source
SHA-256 checksum
How to use checksums
fe18c5466cc5794616e5081e0593cc1dd04a9036d3ce39610360b2ab893de091
BLAKE2b-256 checksum
How to use checksums
0dd9aed767c346e392e07ad48c8383d1a0315e72c451462560fb25a269430948
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pixel_clusterizer-3.0.0-py3-none-any.whl

Download URL pixel_clusterizer-3.0.0-py3-none-any.whl
Size 36.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
61303196bf1b0cbb525bf84b06ebad2025f5b493c0b7a88c55d6914e2b820225
BLAKE2b-256 checksum
How to use checksums
ecc9705eac5c033c7ad9cece43c774515f48a3760265c3fd69d8dce6e0f3754e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pixel_clusterizer-3.0.0-py2-none-any.whl

Download URL pixel_clusterizer-3.0.0-py2-none-any.whl
Size 35.4 kB
Tags Python 2
SHA-256 checksum
How to use checksums
7b0dea7dbc5233770fcbad4ed8c5c7f1bb04b8ed15b93613b1c635847192525a
BLAKE2b-256 checksum
How to use checksums
b3edb02ecd90c61f723ee8037a9a115f337dceaecda51c0f26f6f5b6288a6161
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

3.2.0

2 release files

3.1.7

2 release files

3.1.5

2 release files

3.1.4

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.1

1 release file

This release

3.0.0 This release

3 release files

2.5.0

3 release files

2.4.0

3 release files

2.3.0

1 release file

2.2.0

1 release file

2.0.0

1 release file

1.1.1

5 release files

1.1.0

1 release file

1.0.3

5 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page