FAST  3.2.0
Framework for Heterogeneous Medical Image Computing and Visualization
Public Member Functions | List of all members
fast::ImagePyramid Class Reference

#include <ImagePyramid.hpp>

+ Inheritance diagram for fast::ImagePyramid:
+ Collaboration diagram for fast::ImagePyramid:

Public Member Functions

void create (int width, int height, int channels, int levels=-1)
 
void create (openslide_t *fileHandle, std::vector< ImagePyramidLevel > levels)
 
int getNrOfLevels ()
 
int getLevelWidth (int level)
 
int getLevelHeight (int level)
 
int getLevelTileWidth (int level)
 
int getLevelTileHeight (int level)
 
int getLevelTilesX (int level)
 
int getLevelTilesY (int level)
 
int getFullWidth ()
 
int getFullHeight ()
 
int getNrOfChannels () const
 
void setSpacing (Vector3f spacing)
 
Vector3f getSpacing () const
 
ImagePyramidAccess::pointer getAccess (accessType type)
 
std::unordered_set< std::string > getDirtyPatches ()
 
bool isDirtyPatch (const std::string &tileID)
 
void setDirtyPatch (int level, int patchIdX, int patchIdY)
 
void clearDirtyPatches (std::set< std::string > patches)
 
void free (ExecutionDevice::pointer device) override
 
void freeAll () override
 
 ~ImagePyramid ()
 
- Public Member Functions inherited from fast::SpatialDataObject
 SpatialDataObject ()
 
virtual DataBoundingBox getBoundingBox () const
 
virtual DataBoundingBox getTransformedBoundingBox () const
 
SceneGraphNode::pointer getSceneGraphNode () const
 
- Public Member Functions inherited from fast::DataObject
 DataObject ()
 
void setMetadata (std::string name, std::string value)
 
void setMetadata (std::unordered_map< std::string, std::string > metadata)
 
std::string getMetadata (std::string name) const
 
std::unordered_map< std::string, std::string > getMetadata () const
 
void deleteMetadata (std::string name)
 
uint64_t getTimestamp () const
 
void updateModifiedTimestamp ()
 
virtual ~DataObject ()
 
virtual std::string getNameOfClass () const =0
 
uint64_t getCreationTimestamp () const
 
void setCreationTimestamp (uint64_t timestamp)
 
void setLastFrame (std::string streamer)
 
bool isLastFrame ()
 
bool isLastFrame (std::string streamer)
 
std::unordered_set< std::string > getLastFrame ()
 
void setFrameData (std::string name, std::string value)
 
std::string getFrameData (std::string name)
 
std::unordered_map< std::string, std::string > getFrameData ()
 
void accessFinished ()
 
- Public Member Functions inherited from fast::Object
 Object ()
 
virtual ~Object ()
 
ReportergetReporter ()
 

Additional Inherited Members

- Public Types inherited from fast::SpatialDataObject
typedef std::shared_ptr< SpatialDataObjectpointer
 
- Public Types inherited from fast::DataObject
typedef std::shared_ptr< DataObjectpointer
 
- Public Types inherited from fast::Object
typedef std::shared_ptr< Objectpointer
 
- Static Public Member Functions inherited from fast::SpatialDataObject
static std::string getStaticNameOfClass ()
 
- Static Public Member Functions inherited from fast::DataObject
static std::string getStaticNameOfClass ()
 
- Static Public Member Functions inherited from fast::Object
static std::string getStaticNameOfClass ()
 
- Protected Member Functions inherited from fast::DataObject
void blockIfBeingWrittenTo ()
 
void blockIfBeingAccessed ()
 
- Protected Member Functions inherited from fast::Object
ReporterreportError ()
 
ReporterreportWarning ()
 
ReporterreportInfo ()
 
ReporterEnd reportEnd () const
 
- Protected Attributes inherited from fast::SpatialDataObject
DataBoundingBox mBoundingBox
 
- Protected Attributes inherited from fast::DataObject
std::mutex mDataIsBeingWrittenToMutex
 
std::condition_variable mDataIsBeingWrittenToCondition
 
bool mDataIsBeingWrittenTo
 
std::mutex mDataIsBeingAccessedMutex
 
std::condition_variable mDataIsBeingAccessedCondition
 
bool mDataIsBeingAccessed
 
- Protected Attributes inherited from fast::Object
std::weak_ptr< ObjectmPtr
 

Detailed Description

Data object for storing large images as tiled image pyramids. Storage uses virtual memory enabling the images to be larger than the available RAM.

Constructor & Destructor Documentation

◆ ~ImagePyramid()

fast::ImagePyramid::~ImagePyramid ( )

Member Function Documentation

◆ clearDirtyPatches()

void fast::ImagePyramid::clearDirtyPatches ( std::set< std::string >  patches)

◆ create() [1/2]

void fast::ImagePyramid::create ( int  width,
int  height,
int  channels,
int  levels = -1 
)

◆ create() [2/2]

void fast::ImagePyramid::create ( openslide_t fileHandle,
std::vector< ImagePyramidLevel levels 
)

◆ free()

void fast::ImagePyramid::free ( ExecutionDevice::pointer  device)
overridevirtual

Implements fast::DataObject.

◆ freeAll()

void fast::ImagePyramid::freeAll ( )
overridevirtual

Implements fast::DataObject.

◆ getAccess()

ImagePyramidAccess::pointer fast::ImagePyramid::getAccess ( accessType  type)

◆ getDirtyPatches()

std::unordered_set<std::string> fast::ImagePyramid::getDirtyPatches ( )

◆ getFullHeight()

int fast::ImagePyramid::getFullHeight ( )

◆ getFullWidth()

int fast::ImagePyramid::getFullWidth ( )

◆ getLevelHeight()

int fast::ImagePyramid::getLevelHeight ( int  level)

◆ getLevelTileHeight()

int fast::ImagePyramid::getLevelTileHeight ( int  level)

◆ getLevelTilesX()

int fast::ImagePyramid::getLevelTilesX ( int  level)

◆ getLevelTilesY()

int fast::ImagePyramid::getLevelTilesY ( int  level)

◆ getLevelTileWidth()

int fast::ImagePyramid::getLevelTileWidth ( int  level)

◆ getLevelWidth()

int fast::ImagePyramid::getLevelWidth ( int  level)

◆ getNrOfChannels()

int fast::ImagePyramid::getNrOfChannels ( ) const

◆ getNrOfLevels()

int fast::ImagePyramid::getNrOfLevels ( )

◆ getSpacing()

Vector3f fast::ImagePyramid::getSpacing ( ) const

◆ isDirtyPatch()

bool fast::ImagePyramid::isDirtyPatch ( const std::string &  tileID)

◆ setDirtyPatch()

void fast::ImagePyramid::setDirtyPatch ( int  level,
int  patchIdX,
int  patchIdY 
)

◆ setSpacing()

void fast::ImagePyramid::setSpacing ( Vector3f  spacing)

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