-
Notifications
You must be signed in to change notification settings - Fork 93
/
RealRandomAccess.java
171 lines (161 loc) · 5.76 KB
/
RealRandomAccess.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
* #%L
* ImgLib2: a general-purpose, multidimensional image processing library.
* %%
* Copyright (C) 2009 - 2024 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;
/**
* @author Tobias Pietzsch
* @author Stephan Preibisch
* @author Stephan Saalfeld
*/
public interface RealRandomAccess< T > extends RealLocalizable, RealPositionable, Sampler< T >
{
// NB: Ideally, we would utilize covariant inheritance to narrow the return
// type of a single copy() method here, rather than needing separate methods
// copy(), copyCursor(), copyRandomAccess() and copyRealRandomAccess().
// Unfortunately, due to a Javac bug with multiple interface inheritance,
// we must avoid doing so for now. For details, see:
// http://bugs.sun.com/view_bug.do?bug_id=6656332
// The bug is fixed in JDK7.
@Deprecated
default RealRandomAccess< T > copyRealRandomAccess()
{
return copy();
}
@Override
RealRandomAccess< T > copy();
/**
* Convenience method that moves the {@link RealRandomAccess} to the given
* position and gets the value at that position. It's a shortcut for:
* <p>
* <pre>
* {@code
* setPosition( position );
* get();
* }
* </pre>
* <p>
* WARNING: The return value is invalidated by next call to
* {@link #setPositionAndGet} or {@link #setPosition}.
* <p>
* <pre>
* {@code
* // This is wrong!!!
* a = randomAccess.setPositionAndGet( positionA );
* b = randomAccess.setPositionAndGet( positionB ); // this invalidates "a" !!!
* wrongDifference = a.getRealDouble() - b.getRealDouble();
*
* // Correct:
* // Use individual RandomAccesses to query a and b
* a = randomAccess_A.setPositionAndGet( positionA );
* b = randomAccess_B.setPositionAndGet( positionB ); // this is fine because a different RandomAccess is used
* difference = a.getRealDouble() - b.getRealDouble();
* }
* </pre>
*/
default T setPositionAndGet( final double... position )
{
assert position.length >= numDimensions();
setPosition( position );
return get();
}
/**
* Convenience method that moves the {@link RealRandomAccess} to the given
* position and gets the value at that position. It's a shortcut for:
* <p>
* <pre>
* {@code
* setPosition( position );
* get();
* }
* </pre>
* <p>
* WARNING: The return value is invalidated by next call to
* {@link #setPositionAndGet} or {@link #setPosition}.
* <p>
* <pre>
* {@code
* // This is wrong!!!
* a = randomAccess.setPositionAndGet( positionA );
* b = randomAccess.setPositionAndGet( positionB ); // this invalidates "a" !!!
* wrongDifference = a.getRealDouble() - b.getRealDouble();
*
* // Correct:
* // Use individual RandomAccesses to query a and b
* a = randomAccess_A.setPositionAndGet( positionA );
* b = randomAccess_B.setPositionAndGet( positionB ); // this is fine because a different RandomAccess is used
* difference = a.getRealDouble() - b.getRealDouble();
* }
* </pre>
*/
default T setPositionAndGet( final float... position )
{
assert position.length >= numDimensions();
setPosition( position );
return get();
}
/**
* Convenience method that moves the {@link RealRandomAccess} to the given
* position and gets the value at that position. It's a shortcut for:
* <p>
* <pre>
* {@code
* setPosition( position );
* get();
* }
* </pre>
* <p>
* WARNING: The return value is invalidated by next call to
* {@link #setPositionAndGet} or {@link #setPosition}.
* <p>
* <pre>
* {@code
* // This is wrong!!!
* a = randomAccess.setPositionAndGet( positionA );
* b = randomAccess.setPositionAndGet( positionB ); // this invalidates "a" !!!
* wrongDifference = a.getRealDouble() - b.getRealDouble();
*
* // Correct:
* // Use individual RandomAccesses to query a and b
* a = randomAccess_A.setPositionAndGet( positionA );
* b = randomAccess_B.setPositionAndGet( positionB ); // this is fine because a different RandomAccess is used
* difference = a.getRealDouble() - b.getRealDouble();
* }
* </pre>
*/
default T setPositionAndGet( final RealLocalizable position )
{
assert position.numDimensions() >= numDimensions();
setPosition( position );
return get();
}
}