From 4de2884011e478a30f386263b31da93d19e63fec Mon Sep 17 00:00:00 2001 From: David Date: Thu, 27 Sep 2018 00:19:42 +0200 Subject: [PATCH] fixed javadocs for release --- ImagingKit_Fourier/pom.xml | 2 +- .../hageldave/imagingkit/fourier/ComplexImg.java | 13 +++++++------ .../hageldave/imagingkit/fourier/ComplexPixel.java | 4 ++-- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/ImagingKit_Fourier/pom.xml b/ImagingKit_Fourier/pom.xml index c02edd1..730768a 100644 --- a/ImagingKit_Fourier/pom.xml +++ b/ImagingKit_Fourier/pom.xml @@ -8,7 +8,7 @@ imagingkit-fourier ImagingKit-Fourier com.github.hageldave.imagingkit - 2.0-SNAPSHOT + 2.0 https://github.com/hageldave/ImagingKit The ImagingKit-Fourier artifact provides classes for Fast Fourier Transformations (FFT) for the ImagingKit framework. diff --git a/ImagingKit_Fourier/src/main/java/hageldave/imagingkit/fourier/ComplexImg.java b/ImagingKit_Fourier/src/main/java/hageldave/imagingkit/fourier/ComplexImg.java index 50441eb..1df2296 100644 --- a/ImagingKit_Fourier/src/main/java/hageldave/imagingkit/fourier/ComplexImg.java +++ b/ImagingKit_Fourier/src/main/java/hageldave/imagingkit/fourier/ComplexImg.java @@ -453,7 +453,8 @@ public void setValueI(int x, int y, double value) { * update the corresponding power value. * @param x coordinate * @param y coordinate - * @param value to be set + * @param real part to be set + * @param imag imaginary part to be set */ public void setComplex(int x, int y, double real, double imag){ int idx=y*width+x; @@ -475,7 +476,7 @@ public ComplexImg recomputePowerChannel(){ /** * Calculates, stores and returns the power at the specified index. - * The power is the squared magnitude of the complex number ( c=a+bi -> power = a*a+b*b ). + * The power is the squared magnitude of the complex number ( cmplx=a+bi power=a*a+b*b ). * Subsequent calls to e.g. {@link #getValueP_atIndex(int)} will return the stored result. * @param idx index * @return power of pixel at index @@ -489,7 +490,7 @@ public double computePower(int idx){ /** * Calculates, stores and returns the power at the specified position. - * The power is the squared magnitude of the complex number ( c=a+bi -> power = a*a+b*b ). + * The power is the squared magnitude of the complex number ( cmplx=a+bi power=a*a+b*b ). * Subsequent calls to e.g. {@link #getValueP(int, int)} will return the stored result. * @param x coordinate * @param y coordinate @@ -503,7 +504,7 @@ public double computePower(int x, int y){ * Calculates the phase of the pixel at the specified index. * The phase is the argument of the complex number, i.e. the angle of the complex vector * in the complex plane. - * @param idx + * @param idx index * @return the phase in [0,2pi] of the complex number at index */ public double computePhase(int idx){ @@ -588,8 +589,8 @@ public ComplexImg copyArea(int x, int y, int w, int h, ComplexImg dest, int dest /** * Returns the delegate {@link ColorImg} backing this {@link ComplexImg}. - * The delegate is used to implement functionality like {@link #getRemoteBufferedImage()} - * or {@link #interpolate(int, double, double)}. + * The delegate is used to implement functionality like {@link #getRemoteBufferedImage()}. + * It can also be used to gain access to {@link ColorImg#interpolate(int, double, double)}. * @return {@link ColorImg} delegate of this complex image. */ public ColorImg getDelegate(){ diff --git a/ImagingKit_Fourier/src/main/java/hageldave/imagingkit/fourier/ComplexPixel.java b/ImagingKit_Fourier/src/main/java/hageldave/imagingkit/fourier/ComplexPixel.java index 32bf70e..eb8b1e3 100644 --- a/ImagingKit_Fourier/src/main/java/hageldave/imagingkit/fourier/ComplexPixel.java +++ b/ImagingKit_Fourier/src/main/java/hageldave/imagingkit/fourier/ComplexPixel.java @@ -229,7 +229,7 @@ public ComplexPixel subtract(double r, double i){ /** * Conjugates this complex pixel (negates imaginary part). - * @return + * @return this */ public ComplexPixel conjugate(){ return setImag(-imag()); @@ -240,7 +240,7 @@ public ComplexPixel conjugate(){ * and stores the result in this pixel. * @param r real part to multiply * @param i imaginary part to multiply - * @return + * @return this */ public ComplexPixel mult(double r, double i){ double thisr = real(), thisi = imag();