NPL
Neurological Programs and Libraries
|
This class is used to iterate through an 3D array, where each point then has has multiple higher dimensional variable. This is analogous to Vector3DView, where even if there are multiple higher dimensions they are all alligned into a single vector at each 3D point. This makes them easier to than simple iteration in N-dimensions. This is the constant version. More...
#include <iterators.h>
Inherits npl::Slicer.
Public Member Functions | |
Vector3DConstIter () | |
Default constructor. Note, this will segfault if you don't use setArray to set the target NDArray/Image. More... | |
Vector3DConstIter (std::shared_ptr< const NDArray > in) | |
void | setArray (ptr< const NDArray > in) |
Vector3DConstIter & | operator++ () |
Prefix increment operator. More... | |
Vector3DConstIter & | operator-- () |
Prefix decrement operator. More... | |
T | operator* () const |
Dereference operator. More... | |
T | get (int64_t i=0) const |
Get value at ith element of vector. More... | |
T | operator[] (int64_t i) const |
Get value at ith element of vector. More... | |
void | goBegin () |
Go to beginning of iteration. More... | |
void | goEnd () |
Go to end of iteration. More... | |
bool | isEnd () const |
Are we one past the last element? More... | |
bool | eof () const |
Are we one past the last element? More... | |
bool | isBegin () const |
Are we at the first element. More... | |
bool | operator== (const Vector3DConstIter &other) const |
Whether the position and parent are the same as another. More... | |
bool | operator!= (const Vector3DConstIter &other) const |
Whether the position and parent are different from another. More... | |
bool | operator< (const Vector3DConstIter &other) const |
If the parents are different then false, if they are the same, returns whether this iterator is before the other. More... | |
bool | operator> (const Vector3DConstIter &other) const |
If the parents are different then false, if they are the same, returns whether this iterator is after the other. More... | |
bool | operator<= (const Vector3DConstIter &other) const |
If the parents are different then false, if they are the same, returns whether this iterator is the same or before the other. More... | |
bool | operator>= (const Vector3DConstIter &other) const |
If the parents are different then false, if they are the same, returns whether this iterator is the same or after the other. More... | |
size_t | tlen () const |
void | setDim (size_t ndim, const size_t *dim) |
Updates dimensions of target nd array. More... | |
void | goIndex (size_t len, int64_t *newpos) |
Jump to the given position, additional values in newpos beyond dim will be ignored. Any values missing due to ndim > len will be treated as zeros. More... | |
void | goIndex (std::vector< int64_t > newpos) |
Jump to the given position. More... | |
void | index (size_t len, int64_t *index) const |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ. More... | |
void | index (size_t len, int *index) const |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ. More... | |
void | index (size_t len, double *index) const |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ. More... | |
void | index (std::vector< int64_t > &ind) const |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ. More... | |
void | index (std::vector< int > &ind) const |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ. More... | |
void | index (std::vector< double > &ind) const |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ. More... | |
int64_t | index (size_t dd) const |
Returns the index in the specified dimension. More... | |
size_t | linIndex () const |
get linear position of current point More... | |
int64_t | getStride (size_t dd) |
get stride in specified dimension More... | |
void | setROI (size_t len, const size_t *roisize, const int64_t *roistart=NULL) |
Sets the region of interest, with lower bound of 0. During iteration or any motion the position will not move outside the specified range. Invalidates position. More... | |
void | setROI (const std::vector< std::pair< int64_t, int64_t >> &roi) |
Sets the region of interest. During iteration or any motion the position will not move outside the specified range. Extra elements in roi beyond the number of dimensions, are ignored. More... | |
void | setOrder (const std::vector< size_t > &order, bool revorder=false) |
Sets the order of iteration from increment operators. More... | |
void | setOrder (std::initializer_list< size_t > order, bool revorder=false) |
Sets the order of iteration from ++/– operators. More... | |
void | setOrder () |
Sets the order of iteration from ++/– operators. Order will be the default (highest to lowest) More... | |
const std::vector< size_t > & | getOrder () const |
Returns the array giving the order of dimension being traversed. So 3,2,1,0 would mean that the next point in dimension 3 will be next, when wrapping the next point in 2 is visited, when that wraps the next in one and so on. More... | |
Protected Attributes | |
size_t | m_linpos |
size_t | m_linfirst |
std::vector< int64_t > | m_pos |
bool | m_end |
size_t | m_ndim |
std::vector< size_t > | m_order |
std::vector< std::pair< int64_t, int64_t > > | m_roi |
std::vector< size_t > | m_dim |
std::vector< size_t > | m_strides |
This class is used to iterate through an 3D array, where each point then has has multiple higher dimensional variable. This is analogous to Vector3DView, where even if there are multiple higher dimensions they are all alligned into a single vector at each 3D point. This makes them easier to than simple iteration in N-dimensions. This is the constant version.
T |
Definition at line 2503 of file iterators.h.
|
inline |
Default constructor. Note, this will segfault if you don't use setArray to set the target NDArray/Image.
Definition at line 2511 of file iterators.h.
|
inline |
Definition at line 2513 of file iterators.h.
|
inline |
Are we one past the last element?
Definition at line 2673 of file iterators.h.
|
inline |
Get value at ith element of vector.
Definition at line 2634 of file iterators.h.
|
inlineinherited |
|
inlineinherited |
|
inline |
Go to beginning of iteration.
Definition at line 2658 of file iterators.h.
|
inline |
Go to end of iteration.
Definition at line 2663 of file iterators.h.
|
inherited |
Jump to the given position, additional values in newpos beyond dim will be ignored. Any values missing due to ndim > len will be treated as zeros.
len | Length of newpos array |
newpos | location to move to |
|
inherited |
Jump to the given position.
newpos | location to move to |
|
inherited |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ.
len | size of index |
index | output index variable |
|
inherited |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ.
len | size of index |
index | output index variable |
|
inherited |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ.
len | size of index |
index | output index variable |
|
inlineinherited |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ.
ind | output index variable |
|
inlineinherited |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ.
ind | output index variable |
|
inlineinherited |
Places the first len dimension in the given array. If the number of dimensions exceed the len then the additional dimensions will be ignored, if len exceeds the dimensionality then index[dim...len-1] = 0. In other words index will be completely overwritten in the most sane way possible if the internal dimensions and size index differ.
ind | output index variable |
|
inlineinherited |
|
inline |
Are we at the first element.
Definition at line 2678 of file iterators.h.
|
inline |
Are we one past the last element?
Definition at line 2668 of file iterators.h.
|
inlineinherited |
|
inline |
Whether the position and parent are different from another.
other |
Definition at line 2699 of file iterators.h.
|
inline |
Dereference operator.
Definition at line 2621 of file iterators.h.
|
inline |
Prefix increment operator.
Definition at line 2599 of file iterators.h.
|
inline |
Prefix decrement operator.
Definition at line 2610 of file iterators.h.
|
inline |
If the parents are different then false, if they are the same, returns whether this iterator is before the other.
other |
Definition at line 2712 of file iterators.h.
|
inline |
If the parents are different then false, if they are the same, returns whether this iterator is the same or before the other.
other |
Definition at line 2754 of file iterators.h.
|
inline |
Whether the position and parent are the same as another.
other |
Definition at line 2687 of file iterators.h.
|
inline |
If the parents are different then false, if they are the same, returns whether this iterator is after the other.
other |
Definition at line 2733 of file iterators.h.
|
inline |
If the parents are different then false, if they are the same, returns whether this iterator is the same or after the other.
other |
Definition at line 2773 of file iterators.h.
|
inline |
Get value at ith element of vector.
Definition at line 2647 of file iterators.h.
|
inline |
Definition at line 2518 of file iterators.h.
|
inherited |
Updates dimensions of target nd array.
ndim | Rank (dimensionality) of data block, length of dim |
dim | Size of data block, in each dimension, so dim = {32, 2,54 } would have 32*2*54 members |
|
inherited |
Sets the order of iteration from increment operators.
order | vector of priorities, with first element being the fastest iteration and last the slowest. All other dimensions not used will be slower than the last |
revorder | Reverse order, in which case the first element of order will have the slowest iteration, and dimensions not specified in order will be faster than those included. |
|
inherited |
Sets the order of iteration from ++/– operators.
order | vector of priorities, with first element being the fastest iteration and last the slowest. All other dimensions not used will be slower than the last |
revorder | Reverse order, in which case the first element of order will have the slowest iteration, and dimensions not specified in order will be faster than those included. |
|
inherited |
Sets the order of iteration from ++/– operators. Order will be the default (highest to lowest)
|
inherited |
Sets the region of interest, with lower bound of 0. During iteration or any motion the position will not move outside the specified range. Invalidates position.
Invalidates position
len | length of roi array |
roisize | Size of ROI (which runs in the block from: [roistart[0] ... roisize[0]-1, roistart[0] ... roisize[1]-1, etc] or, if roistart is Null then [0 ... roisize[0]-1, 0 ... roisize[1]-1, etc] |
roistart | Lower corner of region-of-interest |
|
inherited |
Sets the region of interest. During iteration or any motion the position will not move outside the specified range. Extra elements in roi beyond the number of dimensions, are ignored.
roi | pair of [min,max] values in the desired hypercube |
|
inline |
Definition at line 2784 of file iterators.h.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |