From 6135b2e2660d585f455d0c15726b7a0b6344e236 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Mon, 29 Jul 2024 05:53:43 +0000 Subject: [PATCH] build based on d01f698 --- dev/.documenter-siteinfo.json | 2 +- dev/use/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 83c51c9..c915a4b 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-07-29T05:53:15","documenter_version":"1.5.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-07-29T05:53:38","documenter_version":"1.5.0"}} \ No newline at end of file diff --git a/dev/use/index.html b/dev/use/index.html index 047131e..bb593d1 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