Isis Developer Reference
|
Buffer manager, for moving through a cube in lines. More...
#include <LineManager.h>
Public Member Functions | |
LineManager (const Isis::Cube &cube, const bool reverse=false) | |
Constructs a LineManager object. | |
~LineManager () | |
Destroys the LineManager object. | |
bool | SetLine (const int line, const int band=1) |
Positions the buffer at the requested line and returns a status indicator if the set was succesful or not. | |
bool | operator++ (int) |
Moves the shape buffer to the next position. | |
BufferManager & | operator+= (int i) |
Moves the shape buffer by a certain amount. | |
bool | begin () |
Moves the shape buffer to the first position. | |
bool | next () |
Moves the shape buffer to the next position. | |
bool | end () const |
Returns true if the shape buffer has accessed the end of the cube. | |
bool | setpos (BigInt map) |
Sets the position of the shape in the cube. | |
void | swap (BufferManager &other) |
Swaps the values of this BufferManager with that of another. | |
int | SampleDimension () const |
Returns the number of samples in the shape buffer. | |
int | LineDimension () const |
Returns the number of lines in the shape buffer. | |
int | BandDimension () const |
Returns the number of bands in the shape buffer. | |
int | size () const |
Returns the total number of pixels in the shape buffer. | |
int | Sample (const int index=0) const |
Returns the sample position associated with a shape buffer index. | |
int | Line (const int index=0) const |
Returns the line position associated with a shape buffer index. | |
int | Band (const int index=0) const |
Returns the band position associated with a shape buffer index. | |
void | Position (const int index, int &i_samp, int &i_line, int &i_band) const |
Returns the sample, line, and band position associated with a shape buffer index. | |
int | Index (const int i_samp, const int i_line, const int i_band) const |
Given a sample, line, and band position, this returns the appropriate index in the shape buffer. | |
double | at (const int index) const |
Returns the value in the shape buffer at the given index. | |
double & | operator[] (const int index) |
Returns the value in the shape buffer at given index. | |
const double & | operator[] (const int index) const |
Returns the value in the shape buffer at given index. | |
double * | DoubleBuffer () const |
Returns the value of the shape buffer. | |
void | Copy (const Buffer &in, bool includeRawBuf=true) |
Allows copying of the buffer contents to another Buffer. | |
bool | CopyOverlapFrom (const Buffer &in) |
Allows copying of the buffer contents of a larger buffer to another same size or smaller Buffer, using their base positions to relate data. | |
void * | RawBuffer () const |
Returns a void pointer to the raw buffer. | |
Isis::PixelType | PixelType () const |
Returns the raw buffer pixel type. | |
Protected Member Functions | |
int | MaxSamples () const |
Returns the number of samples in the cube. | |
int | MaxLines () const |
Returns the number of lines in the cube. | |
int | MaxBands () const |
Returns the number of bands in the cube. | |
BigInt | MaxMaps () const |
Returns the maximum number of positions the shape buffer needs to cover the entire image (see setpos method for more info). | |
void | SetIncrements (const int sinc, const int linc, const int binc) |
Sets how the shape is incremented through the cube. | |
void | SetOffsets (const int soff, const int loff, const int boff) |
Sets the offset of the buffer. | |
void | SetBasePosition (const int start_sample, const int start_line, const int start_band) |
This method is used to set the base position of the shape buffer. | |
void | SetBaseSample (const int start_samp) |
This method is used to set the base sample position of the shape buffer. | |
void | SetBaseLine (const int start_line) |
This method is used to set the base line position of the shape buffer. | |
void | SetBaseBand (const int start_band) |
This method is used to set the base band position of the shape buffer. | |
void | Allocate () |
Size or resize the memory buffer. | |
Protected Attributes | |
int | p_sample |
Starting sample to read/write. | |
int | p_nsamps |
Number of samples to read/write. | |
int | p_line |
Starting line to read/write. | |
int | p_nlines |
Number of lines to read/write. | |
int | p_band |
Starting band to read/write. | |
int | p_nbands |
Number of bands to read/write. | |
int | p_npixels |
Number of pixels (nsamps * nlines * nbands) | |
double * | p_buf |
Shape buffer allocated to the size of npixels for handling reads/writes. | |
const Isis::PixelType | p_pixelType |
The pixel type of the raw buffer. | |
void * | p_rawbuf |
The raw dm read from the disk. | |
Buffer manager, for moving through a cube in lines.
This class is used as a manager for moving through a cube one line at a time. A line is defined as a one dimensional sub-area of a cube. That is, the number of samples by 1 line by 1 band (ns,1,1). The manager moves this (ns,1,1) shape through the cube sequentially accessing all the lines in the first band before proceeding to the second band.
If you would like to see LineManager being used in implementation, see the ProcessByLine class.
Isis::LineManager::LineManager | ( | const Isis::Cube & | cube, |
const bool | reverse = false ) |
Constructs a LineManager object.
cube | The cube this buffer manager will be associated with. |
reverse | Modifies the order of progression LineManager takes through the cube. By default, progresses lines first then bands. If reverse = true, then the buffer progresses bands first, then lines. |
|
inline |
Destroys the LineManager object.
|
protectedinherited |
Size or resize the memory buffer.
Isis::iException::System | - Memory allocation failed |
References _FILEINFO_, Isis::Message::MemoryAllocationFailed(), Isis::Buffer::p_buf, Isis::Buffer::p_npixels, Isis::Buffer::p_pixelType, Isis::Buffer::p_rawbuf, Isis::SizeOf(), and Isis::IException::Unknown.
Referenced by Isis::Buffer::Buffer(), Isis::Buffer::Buffer(), and Isis::Brick::Resize().
|
inherited |
Returns the value in the shape buffer at the given index.
index | Index position in buffer. Out of bounds index is trapped. |
Isis::iException::Programmer | - Array Subscript not in range |
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::Buffer::p_buf, Isis::Buffer::p_npixels, and Isis::IException::Programmer.
Referenced by Isis::CubeDataThreadTester::BrickChanged(), Isis::ViewportBuffer::fillBuffer(), Isis::CubeDataThreadTester::ReadBrick(), and Isis::CubeDataThreadTester::ReadWriteBrick().
|
inherited |
Returns the band position associated with a shape buffer index.
The shape buffer is one dimensional. Let us assume a nsamps=2, nlines=3, and nbands=2. Therefore the total size of the shape buffer is 12 and valid index values are 0-11. Indexes 0-5 will return band 1 and 6-11 will return band 2.
index | Shape buffer index to map to a band position. Defaults to 0. |
References Isis::Buffer::p_band, Isis::Buffer::p_nlines, and Isis::Buffer::p_nsamps.
Referenced by Isis::Buffer::CopyOverlapFrom(), Isis::IndependentCubeViewport::cubeDataChanged(), and Isis::Buffer::Position().
|
inlineinherited |
Returns the number of bands in the shape buffer.
References Isis::Buffer::p_nbands.
Referenced by Isis::IndependentCubeViewport::cubeDataChanged().
|
inlineinherited |
Moves the shape buffer to the first position.
References Isis::BufferManager::setpos().
Referenced by Isis::ProcessByBoxcar::StartProcess().
|
inherited |
Allows copying of the buffer contents to another Buffer.
in | The Buffer to be copied. |
includeRawBuf | Whether to include raw dm read from disk |
Isis::iException::Programmer | - Input and Output buffers are not the same size |
Isis::iException::Programmer | - Input and Output buffers do not use the same pixel type |
References _FILEINFO_, Isis::Buffer::p_buf, Isis::Buffer::p_npixels, Isis::Buffer::p_pixelType, Isis::Buffer::p_rawbuf, Isis::IException::Programmer, and Isis::SizeOf().
Referenced by Isis::Buffer::Buffer().
|
inherited |
Allows copying of the buffer contents of a larger buffer to another same size or smaller Buffer, using their base positions to relate data.
This does not copy the raw buffer.
in | The Buffer to be copied. |
References Isis::Buffer::Band(), Isis::Buffer::Line(), Isis::Buffer::p_band, Isis::Buffer::p_line, Isis::Buffer::p_nbands, Isis::Buffer::p_nlines, Isis::Buffer::p_npixels, Isis::Buffer::p_nsamps, Isis::Buffer::p_sample, Isis::Buffer::Sample(), and Isis::Buffer::size().
|
inlineinherited |
Returns the value of the shape buffer.
References Isis::Buffer::p_buf.
Referenced by Isis::Process::CalculateStatistics(), Isis::IndependentCubeViewport::cubeDataChanged(), Isis::Cube::histogram(), Isis::DemShape::localRadius(), and Isis::Cube::statistics().
|
inlineinherited |
Returns true if the shape buffer has accessed the end of the cube.
Referenced by Isis::BufferManager::setpos(), and Isis::ProcessByBoxcar::StartProcess().
|
inherited |
Given a sample, line, and band position, this returns the appropriate index in the shape buffer.
i_samp | Sample position. |
i_line | Line position. |
i_band | Band position. |
Isis::iException::Programmer | - Array Subscript not in range |
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::Buffer::p_band, Isis::Buffer::p_line, Isis::Buffer::p_nbands, Isis::Buffer::p_nlines, Isis::Buffer::p_nsamps, Isis::Buffer::p_sample, and Isis::IException::Programmer.
Referenced by Isis::ViewportBuffer::fillBuffer().
|
inherited |
Returns the line position associated with a shape buffer index.
The shape buffer is one dimensional. Let us assume a nsamps=2, nlines=3, and nbands=2. Therefore the total size of the shape buffer is 12 and valid index values are 0-11. Line(0), Line(1), Line(6) and Line(7), will return a 1, Line(2), Line(3), Line(8) and Line(9) will return a 2, and Line(4), Line(5), Line(10), and Line(11) will return a 3.
index | Shape buffer index to map to a line position. Defaults to 0 |
References Isis::Buffer::p_line, Isis::Buffer::p_nlines, and Isis::Buffer::p_nsamps.
Referenced by Isis::Buffer::CopyOverlapFrom(), Isis::IndependentCubeViewport::cubeDataChanged(), Isis::CubeViewport::cubeDataChanged(), Isis::ViewportBuffer::fillBuffer(), Isis::Buffer::Position(), Isis::QtExporter::writeGrayscale(), and Isis::StreamExporter::writeGrayscale().
|
inlineinherited |
Returns the number of lines in the shape buffer.
References Isis::Buffer::p_nlines.
Referenced by Isis::IndependentCubeViewport::cubeDataChanged(), Isis::CubeViewport::cubeDataChanged(), and Isis::ViewportBuffer::fillBuffer().
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
Returns the maximum number of positions the shape buffer needs to cover the entire image (see setpos method for more info).
Referenced by Isis::Brick::Bricks(), and Isis::TileManager::Tiles().
|
inlineprotectedinherited |
Returns the number of samples in the cube.
Referenced by Isis::SampleManager::SetSample().
|
inlineinherited |
Moves the shape buffer to the next position.
Returns true if the next position is valid.
References Isis::BufferManager::setpos().
Referenced by Isis::BufferManager::operator++(), and Isis::ProcessByBoxcar::StartProcess().
|
inlineinherited |
Moves the shape buffer to the next position.
Returns true if the next position is valid.
References Isis::BufferManager::next().
|
inlineinherited |
Moves the shape buffer by a certain amount.
Returns a pointer to the BufferManager it was called on.
i | How far to shift the shape buffer |
References Isis::BufferManager::setpos().
|
inlineinherited |
Returns the value in the shape buffer at given index.
index | Index position in buffer. No out of bounds index is checked |
References Isis::Buffer::p_buf.
|
inlineinherited |
Returns the value in the shape buffer at given index.
index | Index position in buffer. No out of bounds index is checked |
References Isis::Buffer::p_buf.
|
inlineinherited |
|
inherited |
Returns the sample, line, and band position associated with a shape buffer index.
Performs the same function as the Sample, Line, and Band methods.
index | Shape buffer index to map to a band position. |
i_samp | Sample position in shape buffer at index. |
i_line | Line position in shape buffer at index |
i_band | Band position in shape buffer at index. |
References Isis::Buffer::Band(), Isis::Buffer::Line(), and Isis::Buffer::Sample().
|
inlineinherited |
Returns a void pointer to the raw buffer.
Cast this void pointer using information from the PixelType() method
References Isis::Buffer::p_rawbuf.
|
inherited |
Returns the sample position associated with a shape buffer index.
The shape buffer is one dimensional. Let us assume a nsamps=2, nlines=3, and nbands=2. Therefore the total size of the shape buffer is 12 and valid index values are 0-11. Sample(0), Sample(2), Sample(4), etc will return a 1 while Sample(1), Sample(3), Sample(5), etc will return a 2.
index | Shape buffer index to map to a sample position. Defaults to 0. |
References Isis::Buffer::p_nsamps, and Isis::Buffer::p_sample.
Referenced by Isis::Buffer::CopyOverlapFrom(), Isis::IndependentCubeViewport::cubeDataChanged(), Isis::CubeViewport::cubeDataChanged(), Isis::ViewportBuffer::fillBuffer(), and Isis::Buffer::Position().
|
inlineinherited |
Returns the number of samples in the shape buffer.
References Isis::Buffer::p_nsamps.
Referenced by Isis::IndependentCubeViewport::cubeDataChanged(), Isis::CubeViewport::cubeDataChanged(), and Isis::ViewportBuffer::fillBuffer().
|
inlineprotectedinherited |
This method is used to set the base band position of the shape buffer.
start_band | Starting band to set |
References Isis::Buffer::p_band.
Referenced by Isis::Brick::SetBaseBand(), and Isis::Buffer::SetBasePosition().
|
inlineprotectedinherited |
This method is used to set the base line position of the shape buffer.
start_line | Starting line to set |
References Isis::Buffer::p_line.
Referenced by Isis::Brick::SetBaseLine(), and Isis::Buffer::SetBasePosition().
|
protectedinherited |
This method is used to set the base position of the shape buffer.
In general it is used by BufferManager objects to progress sequentially through a cube by line, tile, boxcar, etc.
start_sample | Starting sample to set. |
start_line | Starting line to set. |
start_band | Starting band to set. |
References Isis::Buffer::SetBaseBand(), Isis::Buffer::SetBaseLine(), and Isis::Buffer::SetBaseSample().
Referenced by Isis::Brick::SetBasePosition(), Isis::BufferManager::setpos(), and Isis::Portal::SetPosition().
|
inlineprotectedinherited |
This method is used to set the base sample position of the shape buffer.
start_samp | Starting sample to set |
References Isis::Buffer::p_sample.
Referenced by Isis::Buffer::SetBasePosition(), and Isis::Brick::SetBaseSample().
|
protectedinherited |
Sets how the shape is incremented through the cube.
By default (if this method is not invoked) shapes are moved sequentially through the cube with no overlap. For example, assume a 3 sample by 3 line tile buffer. It would first move across the image from left-to-right starting at sample 1, line 1, and band 1. Upon an increment it would be positioned at sample 4, line 1, and band 1. Each successive increment would cause the sample position to increase by 3 until it exceeds the number of samples in the cube. At that point the shape buffer would be positioned at sample 1, line 4, and band 1 (effectively moving to the next row of tiles). The shape would then continue moving across the cube until it reaches the edge again. Then the next row of tiles would be accessed until the shape reached the bottom of the cube. This default management can be overridden using this method. For example, by setting the increments to (6,3,1) we effectively skip every other tile. By setting them to (6,6,1) we skip every other tile and every other row of tiles. By setting them to (1,1,1) we essentially have NSxNLxNB positions in the cube and the 3x3 tile is managed such that the top left corner of the tile is moved over by 1 sample until it reaches the end of the line then down 1 line and so on until the end of the cube is reached.
sinc | Sample increment |
linc | Line increment |
binc | Band increment |
Referenced by Isis::BoxcarManager::BoxcarManager(), and Isis::BufferManager::BufferManager().
bool Isis::LineManager::SetLine | ( | const int | line, |
const int | band = 1 ) |
Positions the buffer at the requested line and returns a status indicator if the set was succesful or not.
line | The line number within a band (1-based). |
band | The band number within the cube (1-based). Defaults to 1 |
References _FILEINFO_, Isis::BufferManager::MaxLines(), Isis::IException::Programmer, Isis::BufferManager::setpos(), and Isis::toString().
Referenced by Isis::Process::CalculateStatistics(), Isis::Cube::histogram(), Isis::Cube::statistics(), and Isis::Chip::Write().
|
protectedinherited |
Sets the offset of the buffer.
By default (if this method is not invoked) the offsets are (0,0,0). Offsets are applied when computing the top-left corner of the shape buffer. When used in conjunction with the SetIncrements method, this allows for centering shape buffers around a pixel when passing in negative offsets. For example,with a 3x3x1 shape and offsets of (-1,-1,0) and increments of (1,1,1) would cause the manager to walk a 3x3 buffer through the entire image. Setting the manager position the beginning causes the 3x3 window to be positioned such that sample 1, line 1 of the cube would be at the center of the window and increment would cause sample 2, line 1 to be at the center of the window. Successive increments will move the window in the sample direction until the end of line is reached at which time the buffer would be centered on sample 1, line 2.
soff | Sample offset |
loff | Line offset |
boff | Band offset |
Referenced by Isis::BoxcarManager::BoxcarManager().
|
inherited |
Sets the position of the shape in the cube.
This shape fits into the cube a specific number of times.
When p_reverse is left false: (default) For example, a line shape on a 100 sample, 200 line, and 2 band cube would have 200*2 or 400 different positions as there are 400 total lines in the cube. Performing setpos(0) would position the shape at sample 1, line 1, and band 1. While setpos(200) would position the shape at sample 1, line 1, and band 2. Finally, setpos(399) would position the shape at sample 1, line 400, and band 2. Setpos returns true if it was sucessfully in setting the position, and false if the shape is at the end of the cube (beyond index 399 in the case of our example).
When p_reverse is set to true: Following the above cube with 100 samples, 200 lines, and 2 bands, performing the setpos(0) would still position the shape at sample 1, line 1, and band 1. However, setpos(1) would position the shape at sample 1, line 1, band 2, while setpos(200) would position the spame at sample 1, line 100, band 1. Setpos returns true of it was sucessfully in setting the position, and false if the shape is at the end of the cube(beyond final index).
map | Shape buffer position value |
Isis::iException::Programmer | - Invalid value for map argument |
References _FILEINFO_, Isis::BufferManager::end(), Isis::IException::Programmer, and Isis::Buffer::SetBasePosition().
Referenced by Isis::BufferManager::begin(), Isis::BufferManager::next(), Isis::BufferManager::operator+=(), Isis::BandManager::SetBand(), Isis::Brick::SetBrick(), SetLine(), Isis::SampleManager::SetSample(), and Isis::TileManager::SetTile().
|
inlineinherited |
Returns the total number of pixels in the shape buffer.
References Isis::Buffer::p_npixels.
Referenced by Isis::CubeDataThreadTester::BrickChanged(), Isis::Process::CalculateStatistics(), Isis::Buffer::CopyOverlapFrom(), Isis::IndependentCubeViewport::cubeDataChanged(), Isis::ViewportBuffer::fillBuffer(), Isis::Cube::histogram(), Isis::CubeDataThreadTester::ReadBrick(), Isis::CubeDataThreadTester::ReadWriteBrick(), Isis::ProcessByBoxcar::StartProcess(), and Isis::Cube::statistics().
|
inherited |
Swaps the values of this BufferManager with that of another.
&other | Reference to a BufferManager to swap with |
Referenced by Isis::BufferManager::operator=().
|
protectedinherited |
Starting band to read/write.
Referenced by Isis::Buffer::Band(), Isis::Buffer::Buffer(), Isis::Buffer::Buffer(), Isis::Buffer::CopyOverlapFrom(), Isis::Buffer::Index(), and Isis::Buffer::SetBaseBand().
|
protectedinherited |
Shape buffer allocated to the size of npixels for handling reads/writes.
Referenced by Isis::Buffer::Allocate(), Isis::Buffer::at(), Isis::Buffer::Copy(), Isis::Buffer::DoubleBuffer(), Isis::Buffer::operator=(), Isis::Buffer::operator[](), Isis::Buffer::operator[](), Isis::Brick::Resize(), and Isis::Buffer::~Buffer().
|
protectedinherited |
Starting line to read/write.
Referenced by Isis::Buffer::Buffer(), Isis::Buffer::Buffer(), Isis::Buffer::CopyOverlapFrom(), Isis::Buffer::Index(), Isis::Buffer::Line(), and Isis::Buffer::SetBaseLine().
|
protectedinherited |
Number of bands to read/write.
Referenced by Isis::Buffer::BandDimension(), Isis::Buffer::Buffer(), Isis::Buffer::CopyOverlapFrom(), Isis::Buffer::Index(), and Isis::Brick::Resize().
|
protectedinherited |
Number of lines to read/write.
Referenced by Isis::Buffer::Band(), Isis::Buffer::Buffer(), Isis::Buffer::CopyOverlapFrom(), Isis::Buffer::Index(), Isis::Buffer::Line(), Isis::Buffer::LineDimension(), and Isis::Brick::Resize().
|
protectedinherited |
Number of pixels (nsamps * nlines * nbands)
Referenced by Isis::Buffer::Allocate(), Isis::Buffer::at(), Isis::Buffer::Buffer(), Isis::Buffer::Buffer(), Isis::Buffer::Copy(), Isis::Buffer::CopyOverlapFrom(), Isis::Buffer::operator=(), Isis::Brick::Resize(), and Isis::Buffer::size().
|
protectedinherited |
Number of samples to read/write.
Referenced by Isis::Buffer::Band(), Isis::Buffer::Buffer(), Isis::Buffer::CopyOverlapFrom(), Isis::Buffer::Index(), Isis::Buffer::Line(), Isis::Brick::Resize(), Isis::Buffer::Sample(), and Isis::Buffer::SampleDimension().
|
protectedinherited |
The pixel type of the raw buffer.
Referenced by Isis::Buffer::Allocate(), Isis::Buffer::Copy(), and Isis::Buffer::PixelType().
|
protectedinherited |
The raw dm read from the disk.
Referenced by Isis::Buffer::Allocate(), Isis::Buffer::Copy(), Isis::Buffer::RawBuffer(), Isis::Brick::Resize(), and Isis::Buffer::~Buffer().
|
protectedinherited |
Starting sample to read/write.
Referenced by Isis::Buffer::Buffer(), Isis::Buffer::Buffer(), Isis::Buffer::CopyOverlapFrom(), Isis::Buffer::Index(), Isis::Buffer::Sample(), and Isis::Buffer::SetBaseSample().