From 16ee90068c8b5e4bd3f2ab1aec779cfc1d5ca23c Mon Sep 17 00:00:00 2001
From: NattoMaki <negi.in.natto.maki@gmail.com>
Date: Thu, 7 Dec 2023 22:14:47 +0900
Subject: [PATCH] Update README.md

---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 57 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e894a6f..64411fa 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@
 
 ## Features
 
-### OpenAI DALLe3
+### Generator/OpenAI DALLe3
 
 Generates an image using DALL-E3 via OpenAI API.
 
@@ -34,6 +34,7 @@ required: OPENAI_API_KEY.
   The prompt can be written in any language.
 - `resolution`: Select the output resolution from the candidates;
   the resolution combination is fixed in DALL-E3.
+  The selected resolution will be output as WIDTH, HEIGHT.
 - `dummy_seed`: DALL-E3 does not currently provide a way to specify a seed value. 
   This `dummy_seed` value is a parameter to control caching. 
   If the prompt and resolution are the same and dummy_seed has not changed, 
@@ -42,10 +43,40 @@ required: OPENAI_API_KEY.
   Since it does not function as an actual seed value,
   the output will not be the same even if regenerated with the same value set.
 
+REVISED_OUTPUT will output the prompts that DALL-E3 modified prior to generation.
+
 <img src="resources/screenshot_openai_dalle3.png" alt="screenshot_openai_dalle3" width="300px">
 
 
-### OpenAI Translate to English
+### Generator/Noise Image Generator
+
+Generate a noise image.
+
+- `image_opt`: The target image to which the noise will be added. 
+  If nothing is connected, it is assumed that the all 0 black image is used as input.
+- `mask_opt`: Mask specifying the area where noise will be added. 
+  If nothing is connected, the noise is added to all regions.
+- `width`, `height`: Specifies the size of the image to be generated; 
+  if an image is passed to `image_opt`, the size of the image is used and the value of this field is ignored.
+- `method`:  Specifies the type of noise to be generated.
+  \*_gray generates an image with the same RGB pixel values, 
+  and \*_color generates independent RGB pixel values.
+  Noise will be scaled to range of \[center - scale/2, center + scale/2\].
+  - uniform: Generates noise uniformly distributed.
+  - gaussian: Gaussian distribution with standard deviation = scale/2.
+  - perlin: Perlin Noise
+  - perlin_fractal: Perlin Noise with a gradually decaying high-frequency component.
+- `seed`: Seed value for the random generator.
+- `scale`, `bias`: Specifies a range of values. See the description of `method`.
+- `perlin_freq_log2`: Specifies the base frequency of Perlin Noise. 
+  Specifying a higher value produces more detailed noise.
+- `perlin_octaves`: Used only for perlin_fractal. Specifies the number of high-frequency components.
+- `perlin_persistence`: Used only for perlin_fractal. Specifies the amount of attenuation of high-frequency components.
+
+Each component of the output image is scaled in the range of 0.0 to 1.0.
+
+
+### utils/OpenAI Translate to English
 
 Translates text written in any language into English using GPT-4.
 This is useful when you want to write prompts in a language other than English
@@ -58,7 +89,7 @@ required: OPENAI_API_KEY.
 <img src="resources/screenshot_openai_translate.png" alt="screenshot_openai_translate" width="300px">
 
 
-### String Function
+### utils/String Function
 
 String generation using Python scripts.
 
@@ -93,7 +124,7 @@ return "a girl with %s hair and %s eyes wearing %s maid costume" % (
 > received from a third party that cannot be fully trusted.
 
 
-### Seed Generator
+### utils/Seed Generator
 
 Generate an integer to be used as the seed value.
 
@@ -111,3 +142,25 @@ and fix the seed value thereafter.
 
 <img src="resources/screenshot_seed_generator.png" alt="screenshot_seed_generator" width="450px">
 
+
+### utils/ImageProperties
+
+Outputs the properties of the image. Currently only the resolution (width and height) can be output.
+
+### utils/LatentProperties
+
+Outputs the properties of the latent image. Currently only the resolution (width and height) can be output.
+
+### utils/CompositeImages
+
+Composite two images with alpha.
+
+- `image_B`: Background image.
+- `image_F`: Foreground image.
+- `mask_opt`: Optional MASK input.
+  If connected, a value calculated by multiplying the mask and alpha is treated as the per-pixel alpha value.
+- `method`: Specifies the composite algorithm.
+- `alpha`: Specifies the alpha value. 
+  If the alpha value is 0.0, `image_B` will be output directly; 
+  if the alpha value is 1.0, the composite result will be output.
+  For intermediate values, the output is the result of weighted average both images using alpha.