vil_cached_image_resource.h

Go to the documentation of this file.

// This is core/vil/vil_cached_image_resource.h
#ifndef vil_cached_image_resource_h_
#define vil_cached_image_resource_h_
//:
// \file
// \brief A cached and blocked representation of the image_resource
// \author J. L. Mundy

#include <vil/vil_blocked_image_resource.h>
#include <vil/vil_block_cache.h>

class vil_cached_image_resource : public vil_blocked_image_resource
{
 public:

  vil_cached_image_resource(vil_blocked_image_resource_sptr bir,
                            const unsigned cache_size):
    bir_(bir), cache_(vil_block_cache(cache_size)){}

  ~vil_cached_image_resource() override = default;

 inline unsigned nplanes() const override
    {return bir_->nplanes();}
 inline unsigned ni() const override
    {return bir_->ni();}
 inline unsigned nj() const override
  {return bir_->nj();}
  //: Block size in columns
 inline unsigned size_block_i() const override
    {return bir_->size_block_i();}
  //: Block size in rows
 inline unsigned size_block_j() const override
    {return bir_->size_block_j();}
  //: Number of blocks in image width
 inline unsigned n_block_i() const override
    {return bir_->n_block_i();}
  //: Number of blocks in image height
 inline unsigned n_block_j() const override
    {return bir_->n_block_j();}

 inline enum vil_pixel_format pixel_format() const override
    {return bir_->pixel_format();}

 inline bool put_view(const vil_image_view_base& im, unsigned i0, unsigned j0) override {return bir_->put_view(im, i0, j0);}

  //: Block access
  vil_image_view_base_sptr get_block( unsigned  block_index_i,
                                              unsigned  block_index_j ) const override;

  //: put the block into the resource at the indicated location
  bool put_block(unsigned  block_index_i,
                         unsigned  block_index_j,
                         const vil_image_view_base& view) override
    {return bir_->put_block(block_index_i, block_index_j, view);}


  //: Extra property information
 inline bool get_property(char const* tag, void* property_value = nullptr) const override
    {return bir_->get_property(tag, property_value);}

 protected:
  vil_blocked_image_resource_sptr bir_;
  vil_block_cache cache_;
};

#endif // vil_cached_image_resource_h_