net.imglib2.RealPoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of imglib2 Show documentation
Show all versions of imglib2 Show documentation
A multidimensional, type-agnostic image processing library.
/*
* #%L
* ImgLib2: a general-purpose, multidimensional image processing library.
* %%
* Copyright (C) 2009 - 2018 Tobias Pietzsch, Stephan Preibisch, Stephan Saalfeld,
* John Bogovic, Albert Cardona, Barry DeZonia, Christian Dietz, Jan Funke,
* Aivar Grislis, Jonathan Hale, Grant Harris, Stefan Helfrich, Mark Hiner,
* Martin Horn, Steffen Jaensch, Lee Kamentsky, Larry Lindsey, Melissa Linkert,
* Mark Longair, Brian Northan, Nick Perry, Curtis Rueden, Johannes Schindelin,
* Jean-Yves Tinevez and Michael Zinsmaier.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package net.imglib2;
import net.imglib2.util.Localizables;
import java.util.Arrays;
/**
* A point is a location in EuclideanSpace.
*
* @author Lee Kamentsky
* @author Stephan Saalfeld
* @author Tobias Pietzsch
*/
public class RealPoint extends AbstractRealLocalizable implements RealPositionable
{
/**
* Protected constructor that can re-use the passed position array.
*
* @param position
* array used to store the position.
* @param copy
* flag indicating whether position array should be duplicated.
*/
protected RealPoint( final double[] position, final boolean copy )
{
super( copy ? position.clone() : position );
}
/**
* Create a point in nDimensional space initialized to 0,0,...
*
* @param n
* number of dimensions of the space
*/
public RealPoint( final int n )
{
super( n );
}
/**
* Create a point at a definite location in a space of the dimensionality of
* the position.
*
* @param position
* the initial position. The length of the array determines the
* dimensionality of the space.
*/
public RealPoint( final double... position )
{
this( position, true );
}
/**
* Create a point at a definite location in a space of the dimensionality of
* the position.
*
* @param position
* the initial position. The length of the array determines the
* dimensionality of the space.
*/
public RealPoint( final float... position )
{
super( position.length );
setPosition( position );
}
/**
* Create a point using the position and dimensionality of a
* {@link RealLocalizable}
*
* @param localizable
* the initial position. Its dimensionality determines the
* dimensionality of the space.
*/
public RealPoint( final RealLocalizable localizable )
{
super( localizable.numDimensions() );
localizable.localize( position );
}
@Override
public void fwd( final int d )
{
++position[ d ];
}
@Override
public void bck( final int d )
{
--position[ d ];
}
@Override
public void move( final int distance, final int d )
{
position[ d ] += distance;
}
@Override
public void move( final long distance, final int d )
{
position[ d ] += distance;
}
@Override
public void move( final Localizable localizable )
{
for ( int d = 0; d < n; d++ )
position[ d ] += localizable.getDoublePosition( d );
}
@Override
public void move( final int[] distance )
{
for ( int d = 0; d < n; d++ )
position[ d ] += distance[ d ];
}
@Override
public void move( final long[] distance )
{
for ( int d = 0; d < n; d++ )
position[ d ] += distance[ d ];
}
@Override
public void setPosition( final Localizable localizable )
{
for ( int d = 0; d < n; d++ )
position[ d ] = localizable.getDoublePosition( d );
}
@Override
public void setPosition( final int[] position )
{
for ( int d = 0; d < n; d++ )
this.position[ d ] = position[ d ];
}
@Override
public void setPosition( final long[] position )
{
for ( int d = 0; d < n; d++ )
this.position[ d ] = position[ d ];
}
@Override
public void setPosition( final int position, final int d )
{
this.position[ d ] = position;
}
@Override
public void setPosition( final long position, final int d )
{
this.position[ d ] = position;
}
@Override
public void move( final float distance, final int d )
{
position[ d ] += distance;
}
@Override
public void move( final double distance, final int d )
{
position[ d ] += distance;
}
@Override
public void move( final RealLocalizable localizable )
{
for ( int d = 0; d < n; ++d )
position[ d ] += localizable.getDoublePosition( d );
}
@Override
public void move( final float[] distance )
{
for ( int d = 0; d < n; ++d )
position[ d ] += distance[ d ];
}
@Override
public void move( final double[] distance )
{
for ( int d = 0; d < n; ++d )
position[ d ] += distance[ d ];
}
@Override
public void setPosition( final RealLocalizable localizable )
{
for ( int d = 0; d < n; d++ )
position[ d ] = localizable.getDoublePosition( d );
}
@Override
public void setPosition( final float[] position )
{
for ( int d = 0; d < n; ++d )
this.position[ d ] = position[ d ];
}
@Override
public void setPosition( final double[] position )
{
for ( int d = 0; d < n; ++d )
this.position[ d ] = position[ d ];
}
@Override
public void setPosition( final float position, final int d )
{
this.position[ d ] = position;
}
@Override
public void setPosition( final double position, final int d )
{
this.position[ d ] = position;
}
@Override
public String toString()
{
return Localizables.toString( this );
}
@Override
public boolean equals( final Object obj )
{
return obj != null && obj.getClass() == getClass() &&
Localizables.equals( this, ( RealPoint ) obj );
}
@Override
public int hashCode()
{
return Arrays.hashCode( position );
}
/**
* Create a point that stores its coordinates in the provided position
* array.
*
* @param position
* array to use for storing the position.
*/
public static RealPoint wrap( final double[] position )
{
return new RealPoint( position, false );
}
}