Metadata-Version: 2.4
Name: cylindra-moire-analysis
Version: 0.1.0
Summary: Plugin for traditional moire pattern analysis of microtubules
Author: Hanjin Liu
Author-email: liuhanjin.sc@gmail.com
License: 
        Copyright (c) 2025, Hanjin Liu
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Requires-Dist: cylindra>=1.0.2
Requires-Dist: impy-array>=2.4.10
Requires-Dist: magic-class>=0.7.20
Requires-Dist: matplotlib>=3.8.1
Requires-Dist: numpy>=1.23.0
Requires-Dist: scipy>=1.11.3
Provides-Extra: testing
Requires-Dist: cylindra[testing]>=1.0.2; extra == 'testing'
Requires-Dist: pytest; extra == 'testing'
Requires-Dist: pytest-cov; extra == 'testing'
Requires-Dist: pytest-qt; extra == 'testing'
Description-Content-Type: text/markdown

# cylindra-moire-analysis

![](images/ex0.png)

A [cylindra](https://github.com/hanjinliu/cylindra) plugin for traditional moiré pattern analysis of microtubules.

This plugin was generated with [cookiecutter](https://github.com/cookiecutter/cookiecutter).

## Installation

```bash
pip install cylindra-moire-analysis
```

## Usage

After running spline fitting and global-CFT analysis, you can analyze the moiré patterns for each splines.

1. Automatic skew angle measurement.
    From "Plugins > Moire pattern analysis > Measure skew ...", the traditional skew angle will be automatically determined from the moiré pattern, printed in the logger and stored as `"moire_skew_angle"` global property of each spline.

2. Export images for [TubuleJ](https://igdr.univ-rennes.fr/en/node/3536) analysis.
    From "Plugins > Moire pattern analysis > Export for TubuleJ ...", the straightened and filtered images along with the calibration file will be exported. The exported directory can be directly opened in TubuleJ for further manual analysis.
