File failed to load: https://isis.astrogeology.usgs.gov/3.9.0/Object/assets/jax/output/NativeMML/config.js
Isis 3 Developer Reference
Isis::BoxcarCachingAlgorithm Class Reference

This algorithm is designed for applications that jump around between a couple of spots in the cube with a difficult to predict pattern but always the same places in the cube. More...

#include <BoxcarCachingAlgorithm.h>

Inheritance diagram for Isis::BoxcarCachingAlgorithm:
Inheritance graph
Collaboration diagram for Isis::BoxcarCachingAlgorithm:
Collaboration graph

Public Member Functions

 BoxcarCachingAlgorithm ()
 Construct a new BoxcarCachingAlgorithm. More...
 
virtual ~BoxcarCachingAlgorithm ()
 Frees the memory allocated by this caching algorithm. More...
 
virtual CacheResult recommendChunksToFree (QList< RawCubeChunk *> allocated, QList< RawCubeChunk *> justUsed, const Buffer &justRequested)
 Please see the class description for how this algorithm works. More...
 

Detailed Description

This algorithm is designed for applications that jump around between a couple of spots in the cube with a difficult to predict pattern but always the same places in the cube.

This was designed for ProcessMosaic which jumps between band 1 and band n in the possible patterns (where A is a line on band 1 and B is a line on band N): A,A or A,B,A or A,B,B,A

Author
????-??-?? Jai Rideout and Steven Lambright

Constructor & Destructor Documentation

◆ BoxcarCachingAlgorithm()

Isis::BoxcarCachingAlgorithm::BoxcarCachingAlgorithm ( )

Construct a new BoxcarCachingAlgorithm.

The last numUniqueIOs will be kept in the cache, while the other chunks in the cache will all be tossed.

◆ ~BoxcarCachingAlgorithm()

Isis::BoxcarCachingAlgorithm::~BoxcarCachingAlgorithm ( )
virtual

Frees the memory allocated by this caching algorithm.

Member Function Documentation

◆ recommendChunksToFree()

CubeCachingAlgorithm::CacheResult Isis::BoxcarCachingAlgorithm::recommendChunksToFree ( QList< RawCubeChunk *>  allocated,
QList< RawCubeChunk *>  justUsed,
const Buffer justRequested 
)
virtual

Please see the class description for how this algorithm works.

Parameters
allocatedAll of the allocated cube chunks
justUsedThe cube chunks used in the last I/O
justRequestedThe buffer passed into the last I/O
Returns
The chunks that should be removed from memory

Implements Isis::CubeCachingAlgorithm.

References Isis::RawCubeChunk::getStartLine(), and Isis::RawCubeChunk::lineCount().


The documentation for this class was generated from the following files:

U.S. Department of the Interior | U.S. Geological Survey
ISIS | Privacy & Disclaimers | Astrogeology Research Program
To contact us, please post comments and questions on the USGS Astrogeology Discussion Board
To report a bug, or suggest a feature go to: ISIS Github
File Modified: 07/12/2023 23:37:05