Skip to content

Commit

Permalink
fixed javadocs for release
Browse files Browse the repository at this point in the history
  • Loading branch information
hageldave committed Sep 26, 2018
1 parent 9ef45f4 commit 4de2884
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion ImagingKit_Fourier/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<artifactId>imagingkit-fourier</artifactId>
<name>ImagingKit-Fourier</name>
<groupId>com.github.hageldave.imagingkit</groupId>
<version>2.0-SNAPSHOT</version>
<version>2.0</version>
<url>https://github.com/hageldave/ImagingKit</url>
<description>The ImagingKit-Fourier artifact provides classes for Fast Fourier Transformations (FFT) for the ImagingKit framework.</description>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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){
Expand Down Expand Up @@ -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(){
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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());
Expand All @@ -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();
Expand Down

0 comments on commit 4de2884

Please sign in to comment.