Make a copy of the derived object (reference semantics).
Is the lattice persistent and can it be loaded by other processes as well?
That is the case for a PagedArray or PagedImage and for an ImageExpr
which does not use transient lattices or regions.
The default implementation returns False.
Is the lattice paged to disk?
The default implementation returns False.
Can the lattice data be referenced as an array section?
That is the case for an ArrayLattice or a Temp/SubLattice using it.
It is used by LatticeIterInterface.
The default implementation returns False.
Is the lattice writable?
The default implementation returns True.
It is strongly recommended to use class
LatticeLocker to
handle lattice locking. It also contains a more detailed
explanation of the locking process.
By default the functions do not do anything at all.
lock() and hasLock return True, which is suitable for all
non-paged lattices.
Resynchronize the Lattice object with the lattice file.
This function is only useful if no read-locking is used, ie.
if the table lock option is UserNoReadLocking or AutoNoReadLocking.
In that cases the table system does not acquire a read-lock, thus
does not synchronize itself automatically.
By default the function does not do anything at all.
Flush the data (but do not unlock).
By default the function does not do anything at all.
Temporarily close the lattice.
It will be reopened automatically on the next access.
By default the function does not do anything at all.
Explicitly reopen the temporarily closed lattice.
By default the function does not do anything at all.
Return the name of the current Lattice object. This will generally
be a file name for lattices that have a persistent form. Any path
before the actual file name can be optionally stripped off.
The default implementation returns an empty string.
Return the shape of the Lattice including all degenerate axes (ie. axes with a length of one)
Return the number of axes in this Lattice. This includes all
degenerate axes.
The default implementation returns shape().nelements().
Return the total number of elements in this Lattice.
The default implementation returns shape().product().
Return a value of "True" if this instance of Lattice and 'other' have the same shape, otherwise returns a value of "False".
Return the coordinates of the lattice.
The default implementation returns an 'empty' LELLattCoord object.
This function returns the recommended maximum number of pixels to include in the cursor of an iterator. The Lattice class has a default implementation which returns a number that is a power of two and includes enough pixels to consume between 4 and 8 MBytes of memory.
Returns a recommended cursor shape for iterating through all the pixels in the Lattice. The default implementation sets up a shape that completely fills as many axes as possible, but always at least the first axis. For example, given a 10x20x30 Lattice
maxPixels = 1 --> niceCursorShape = [10,1,1]
100 --> niceCursorShape = [10,1,1]
300 --> niceCursorShape = [10,20,1]
10000 --> niceCursorShape = [10,20,30]
The default argument is the result of advisedMaxPixels().
Check class internals - used for debugging. Should always return True
The function (in the derived classes) doing the actual work.
This function is public, so it can be used internally in the
various Lattice classes.
The default implementation tries to fit as many axes
as possible given maxPixels.
Maximum cache size - not necessarily all used. In pixels. Default returns 0, which means that there is no maximum.
Set the maximum (allowed) cache size as indicated.
The default implementation does nothing.
Set the actual cache size for this Array to be big enough for the
indicated number of tiles. This cache is not shared with PagedArrays
in other rows and is always clipped to be less than the maximum value
set using the setMaximumCacheSize member function.
Tiles are cached using a first in first out algorithm.
The default implementation does nothing.
Set the cache size as to "fit" the indicated path.
The default implementation does nothing.
Clears and frees up the caches, but the maximum allowed cache size is
unchanged from when setCacheSize was called.
The default implementation does nothing.
Report on cache success.
The default implementation does nothing.
Throw an exception for arithmetic on a Bool Lattice.