Constructor and Description |
---|
ArrayArrayImpl(Object data,
OrderedNDShape oshape,
Number badValue)
Constructs a new ArrayArrayImpl backed by a given java primitive
numeric array.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canMap()
Indicates whether mapped access is available.
|
void |
close()
Shuts down this ArrayImpl for pixel access.
|
AccessImpl |
getAccess()
Returns an object which can access the pixels of this ArrayImpl.
|
Number |
getBadValue()
The magic bad value for data.
|
Object |
getMapped()
Returns a single primitive array holding all the pixel data of
this array.
|
OrderedNDShape |
getShape()
Returns an object representing the shape (origin and dimensions)
and pixel sequence of this object.
|
Type |
getType()
Returns the primitive type of the data held by this object.
|
boolean |
isRandom()
Indicates whether random access is possible.
|
boolean |
isReadable()
Indicates whether read access is possible.
|
boolean |
isWritable()
Indicates whether write access is possible.
|
boolean |
multipleAccess()
Indicates whether the getAccess method may be called more than once.
|
void |
open()
Prepares this ArrayImpl for pixel access.
|
public ArrayArrayImpl(Object data, OrderedNDShape oshape, Number badValue)
data
- the java primitive array; must be a numeric
type corresponding to one of the Type
instancesoshape
- the shape of the array; must have the same number
of pixels as data
badValue
- the bad data value; must match the type of
data
if it is not null
IllegalArgumentException
- if data
is not a suitable
primitive numeric type or oshape
has the wrong
number of pixelspublic OrderedNDShape getShape()
ArrayImpl
public Type getType()
ArrayImpl
public Number getBadValue()
ArrayImpl
null
if there is no bad value.
The return value must not change over the lifetime of the object.getBadValue
in interface ArrayImpl
public boolean isReadable()
ArrayImpl
isReadable
in interface ArrayImpl
public boolean isWritable()
ArrayImpl
isWritable
in interface ArrayImpl
public boolean isRandom()
ArrayImpl
public boolean multipleAccess()
ArrayImpl
multipleAccess
in interface ArrayImpl
public void open()
ArrayImpl
public boolean canMap()
ArrayImpl
Will only be called after an open call, and before any close call.
public Object getMapped()
ArrayImpl
Will only be called if canMap returns true, and only after an open call and before any close call.
public void close()
ArrayImpl
public AccessImpl getAccess()
ArrayImpl
This method will only be called after the sole call to open and before the sole call to close.
This method will only be called more than once if the multipleAccess method returns true.
It is the responsibility of the caller to close the returned AccessImpl when it is no longer required; this enables resources it may hold to be released.
Copyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.