diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 49558c7..83c51c9 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-07-29T05:37:12","documenter_version":"1.5.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-07-29T05:53:15","documenter_version":"1.5.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 57b9e8c..65b8a58 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,4 +1,4 @@ Main · BcdiStrain.jl
GitHub

BcdiStrain.jl Documentation

About

Bragg Coherent Diffraction Imaging (BCDI) Strain implements projection-based phase retrieval algorithms. Some of the core functionality of this project is implemented in BcdiCore.jl and BcdiTrad.jl. Additionally, this package is part of a collection of BCDI packages consisting of BcdiAtomic.jl (an atomic scale BCDI solver), BcdiMeso.jl (a mesoscale BCDI Solver), and BcdiMulti.jl (a multiscale BCDI solver).

While this package is marked as BCDI specific, the methods are more general and can be used in many phase retrieval problems. In the future, this package may be incorporated into a more general phase retrieval package.

Currently, this entire package must be run with access to GPUs. This may change in the future (especially if Issues requesting it are opened), but for our research group, using GPUs is a necessity.

Installation

Currently, BcdiStrain.jl is not registered in the Julia general registry. BcdiTrad.jl can be installed by running in the REPL package manager (]):

add https://github.com/byu-cig/BcdiCore.jl.git
 add https://github.com/byu-cig/BcdiTrad.jl.git
-add https://github.com/byu-cig/BcdiStrain.jl.git
+add https://github.com/byu-cig/BcdiStrain.jl.git diff --git a/dev/use/index.html b/dev/use/index.html index c7b0933..047131e 100644 --- a/dev/use/index.html +++ b/dev/use/index.html @@ -3,4 +3,4 @@ hio = BcdiTrad.HIO(0.9) state = BcdiTrad.State(intensities, trues(size(intensities))) -(er * hio^20)^5 * state

This short script applies 20 HIO iterations and one ER iterations for a total of 5 times. This makes it easy to implement very complex recipes for phase retrieval algorithms.

API

Main.DummyDocs.State — Method
State(intensities, recSupport)

Create a reconstruction object. The intensities and a mask over reciprocal space indicating trusted intensities need to be passed in.

source
Main.DummyDocs.ER — Method
ER()

Create an object that applies an iteration of ER

source
Main.DummyDocs.HIO — Method
HIO(beta)

Create an object that applies an iteration of HIO

source
Main.DummyDocs.Shrink — Method
Shrink(threshold, sigma, state)

Create an object that applies shrinkwrap

source
Main.DummyDocs.Center — Method
Center(state)

Create an object that centers the current state

source
Main.DummyDocs.Mount — Method
Mount(beta, state, primitiveRecipLattice)

Create an object that switches between peaks.

source
+(er * hio^20)^5 * state

This short script applies 20 HIO iterations and one ER iterations for a total of 5 times. This makes it easy to implement very complex recipes for phase retrieval algorithms.

API

Main.DummyDocs.State — Method
State(intensities, recSupport)

Create a reconstruction object. The intensities and a mask over reciprocal space indicating trusted intensities need to be passed in.

source
Main.DummyDocs.ER — Method
ER()

Create an object that applies an iteration of ER

source
Main.DummyDocs.HIO — Method
HIO(beta)

Create an object that applies an iteration of HIO

source
Main.DummyDocs.Shrink — Method
Shrink(threshold, sigma, state)

Create an object that applies shrinkwrap

source
Main.DummyDocs.Center — Method
Center(state)

Create an object that centers the current state

source
Main.DummyDocs.Mount — Method
Mount(beta, state, primitiveRecipLattice)

Create an object that switches between peaks.

source