Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
amirDahari1 committed Oct 7, 2024
1 parent 1d08096 commit 2ba7f79
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# Representativity

![Tests](https://github.com/tldr-group/Representativity/actions/workflows/tests.yml/badge.svg)
# ImageRep

[Try it out!](https://www.imagerep.io/)

Here we introduce the 'ImageRep' method for fast phase fraction representativity estimation from a single microstructural image. This is achieved by calculating the Two-Point Correlation (TPC) function of the image, combined with a data-driven analysis of the [Microlib](https://microlib.io/) dataset. By applying a statistical framework that utilizes both data sources, we can establish the uncertainty in the phase fraction in the image with a given confidence, **and** the image size that would be needed to meet a given target uncertainty. Further details are provided in our [paper](CITATION.cff).
Here we introduce the 'ImageRep' method for fast phase fraction representativity estimation from a single microstructural image. This is achieved by calculating the Two-Point Correlation (TPC) function of the image, combined with a data-driven analysis of the [MicroLib](https://microlib.io/) dataset. By applying a statistical framework that utilizes both data sources, we can establish the uncertainty in the phase fraction in the image with a given confidence, **and** the image size that would be needed to meet a given target uncertainty. Further details are provided in our [paper](CITATION.cff).

If you use this ImageRep in your research, [please cite us](CITATION.cff).

## Usage:

This method can be used via the [website (imagerep.io)](https://www.imagerep.io/)or as python package - see [`example.ipynb`](example.ipynb).
This method can be used via the [website (imagerep.io)](https://www.imagerep.io/) or as python package - see [`example.ipynb`](example.ipynb).

<p align="center">
<img src="https://sambasegment.blob.core.windows.net/resources/repr_repo_v2.gif">
Expand Down Expand Up @@ -82,6 +80,8 @@ yarn && yarn start

## Testing Instructions

![Tests](https://github.com/tldr-group/Representativity/actions/workflows/tests.yml/badge.svg)

1. Run (with your virtual enviroment activated!)

```
Expand Down

0 comments on commit 2ba7f79

Please sign in to comment.