Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Related Functions | List of all members
vil_openjpeg_pyramid_image_resource Class Reference

#include <vil_openjpeg_pyramid_image_resource.h>

Inheritance diagram for vil_openjpeg_pyramid_image_resource:
Inheritance graph
[legend]

Public Member Functions

 vil_openjpeg_pyramid_image_resource (vil_image_resource_sptr const &openjpeg)
 
 ~vil_openjpeg_pyramid_image_resource () override=default
 
unsigned nplanes () const override
 The number of planes (or components) in the image. More...
 
unsigned ni () const override
 The number of pixels in each row. More...
 
unsigned nj () const override
 The number of pixels in each column. More...
 
enum vil_pixel_format pixel_format () const override
 Pixel Format. More...
 
bool put_view (vil_image_view_base const &, unsigned, unsigned) override
 Put the data in this view back into the base image. More...
 
char const * file_format () const override
 Return a string describing the file format. More...
 
unsigned nlevels () const override
 Number of pyramid levels. More...
 
vil_image_view_base_sptr get_copy_view (unsigned i0, unsigned ni, unsigned j0, unsigned nj, unsigned level) const override
 Get a partial view from the image from a specified pyramid level. More...
 
vil_image_view_base_sptr get_copy_view (unsigned level) const override
 Get a complete view from a specified pyramid level. More...
 
vil_image_view_base_sptr get_copy_view (unsigned i0, unsigned ni, unsigned j0, unsigned nj, const float scale, float &actual_scale) const override
 Get a partial view from the image in the pyramid closest to scale. More...
 
vil_image_view_base_sptr get_copy_view (const float scale, float &actual_scale) const override
 Get a complete view from the image in the pyramid closest to the specified scale. More...
 
bool put_resource (vil_image_resource_sptr const &) override
 Copy a resource into the pyramid, level is determined by resource scale. More...
 
vil_image_resource_sptr get_resource (const unsigned level) const override
 Get an image resource from the pyramid at the specified level. More...
 
void print (const unsigned level) override
 for debug purposes. More...
 
vil_image_view_base_sptr get_copy_view (unsigned i0, unsigned n_i, unsigned j0, unsigned n_j) const override
 Create a read/write view of a copy of this data. More...
 
vil_image_view_base_sptr get_copy_view () const
 Create a read/write view of a copy of all the data. More...
 
virtual bool put_view (const vil_image_view_base &im)
 Put the data in this view back into the image source at the origin. More...
 
bool get_property (char const *tag, void *property_value=nullptr) const override
 Extra property information. More...
 
virtual vil_image_view_base_sptr get_view (unsigned i0, unsigned n_i, unsigned j0, unsigned n_j) const
 Create a read/write view of the data. More...
 
vil_image_view_base_sptr get_view () const
 Create a read/write view of all the data. More...
 
virtual bool view_fits (const vil_image_view_base &im, unsigned i0, unsigned j0)
 Check that a view will fit into the data at the given offset. More...
 

Static Public Member Functions

static bool blocked_decimate (vil_blocked_image_resource_sptr const &brsc, vil_blocked_image_resource_sptr &dec_resc)
 A utility function to decimate a resource using blocks. More...
 
static vil_image_resource_sptr decimate (vil_image_resource_sptr const &resc, char const *filename, char const *format="tiff")
 Utility for decimating a resource to create a new pyramid level. More...
 

Protected Member Functions

 vil_openjpeg_pyramid_image_resource ()
 
void ref ()
 
void unref ()
 

Protected Attributes

vil_image_resource_sptr openjpeg_sptr_
 
vil_openjpeg_imageptr_
 
vcl_atomic_count reference_count_
 

Related Functions

(Note that these are not member functions.)

vil_pyramid_image_resource_sptr vil_load_pyramid_resource (char const *directory_or_file, bool verbose=true)
 Load a pyramid image resource object from a file or directory. More...
 
template<class destT , class kernelT , class accumT >
vil_image_resource_sptr vil_convolve_1d (const vil_image_resource_sptr &src_im, const destT, const kernelT *kernel, int k_lo, int k_hi, const accumT, vil_convolve_boundary_option start_option, vil_convolve_boundary_option end_option)
 Create an image_resource object which convolve kernel[x] x in [k_lo,k_hi] with srcT. More...
 
template<class destT , class kernelT , class accumT >
vil_image_resource_sptr vil_correlate_1d (const vil_image_resource_sptr &src_im, const destT, const kernelT *kernel, std::ptrdiff_t k_lo, std::ptrdiff_t k_hi, const accumT, vil_convolve_boundary_option start_option, vil_convolve_boundary_option end_option)
 Create an image_resource object which correlate kernel[x] x in [k_lo,k_hi] with srcT. More...
 
vil_image_resource_sptr vil_clamp (const vil_image_resource_sptr &src, double low, double hi)
 Clamp an image resource between two values. More...
 
bool vil_copy_deep (const vil_image_resource_sptr &src, vil_image_resource_sptr &dest)
 Copy src to dest. More...
 
vil_image_resource_sptr vil_copy_deep (const vil_image_resource_sptr &src)
 Creates an in memory vil_image_resource and copies the src to it. More...
 
vil_image_resource_sptr vil_crop (const vil_image_resource_sptr &src, unsigned i0, unsigned n_i, unsigned j0, unsigned n_j)
 Crop to a region of src. More...
 
vil_image_resource_sptr vil_decimate (const vil_image_resource_sptr &src, unsigned i_factor, unsigned j_factor=0)
 decimate to a region of src. More...
 
vil_image_resource_sptr vil_flip_lr (const vil_image_resource_sptr &src)
 Flip an image resource left to right. More...
 
vil_image_resource_sptr vil_flip_ud (const vil_image_resource_sptr &src)
 Flip an image resource left to right. More...
 
vil_image_resource_sptr vil_load_image_resource (char const *filename, bool verbose=true)
 Load an image resource object from a file. More...
 
vil_image_resource_sptr vil_load_image_resource_raw (vil_stream *, bool verbose=true)
 Load from a stream. More...
 
vil_image_resource_sptr vil_load_image_resource_raw (char const *, bool verbose=true)
 Load an image resource object from a file. More...
 
vil_image_resource_sptr vil_load_image_resource_plugin (char const *)
 Load from a filename with a plugin. More...
 
template<class sumT >
bool vil_math_mean_and_variance (sumT &mean, sumT &var, const vil_image_resource_sptr im, const vil_image_view< bool > &mask, unsigned p)
 Mean and variance of masked elements in plane p for vil_image_resource. More...
 
vil_image_resource_sptr vil_new_image_resource (unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format)
 Make a new image of given format. More...
 
vil_image_resource_sptr vil_new_image_resource (unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype)
 Make a new image, similar format to the prototype. More...
 
vil_image_resource_sptr vil_new_image_resource (vil_stream *os, unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format, char const *file_format)
 Make a new image. More...
 
vil_image_resource_sptr vil_new_image_resource (char const *filename, unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype, char const *file_format)
 Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype". More...
 
vil_image_resource_sptr vil_new_image_resource (char const *filename, unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format, char const *file_format)
 Make a new image. More...
 
vil_image_resource_sptr vil_new_image_resource (vil_stream *os, unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype, char const *file_format)
 Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype". More...
 
vil_image_resource_sptr vil_new_image_resource (char const *filename, unsigned ni, unsigned nj, unsigned nplanes, vil_image_resource_sptr const &prototype, char const *format=nullptr)
 Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype". More...
 
vil_image_resource_sptr vil_new_image_resource (vil_stream *os, unsigned ni, unsigned nj, unsigned nplanes, vil_image_resource_sptr const &prototype, char const *file_format=nullptr)
 Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype". More...
 
vil_image_resource_sptr vil_new_image_resource_interleaved (unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format)
 Make a new image of given format with interleaved planes. More...
 
vil_image_resource_sptr vil_new_image_resource_of_view (vil_image_view_base const &view)
 Make a new image resource that is a wrapper on an existing view's data. More...
 
vil_image_resource_sptr vil_plane (const vil_image_resource_sptr &src, unsigned p)
 Return a specific plane of an image. More...
 
bool vil_save_image_resource (const vil_image_resource_sptr &ir, char const *filename, char const *file_format)
 Send vil_image_resource to disk. More...
 
bool vil_save_image_resource (const vil_image_resource_sptr &ir, char const *filename)
 Save vil_image_resource to file, deducing format from filename. More...
 
vil_image_resource_sptr vil_transpose (const vil_image_resource_sptr &src)
 Transpose an image. More...
 

Detailed Description

Definition at line 21 of file vil_openjpeg_pyramid_image_resource.h.

Constructor & Destructor Documentation

◆ vil_openjpeg_pyramid_image_resource() [1/2]

vil_openjpeg_pyramid_image_resource::vil_openjpeg_pyramid_image_resource ( vil_image_resource_sptr const &  openjpeg)

Definition at line 23 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ ~vil_openjpeg_pyramid_image_resource()

vil_openjpeg_pyramid_image_resource::~vil_openjpeg_pyramid_image_resource ( )
overridedefault

◆ vil_openjpeg_pyramid_image_resource() [2/2]

vil_openjpeg_pyramid_image_resource::vil_openjpeg_pyramid_image_resource ( )
protected

Member Function Documentation

◆ blocked_decimate()

bool vil_pyramid_image_resource::blocked_decimate ( vil_blocked_image_resource_sptr const &  brsc,
vil_blocked_image_resource_sptr dec_resc 
)
staticinherited

A utility function to decimate a resource using blocks.

The new scale is one half the input resource scale

Definition at line 125 of file vil_pyramid_image_resource.cxx.

◆ decimate()

vil_image_resource_sptr vil_pyramid_image_resource::decimate ( vil_image_resource_sptr const &  resc,
char const *  filename,
char const *  format = "tiff" 
)
staticinherited

Utility for decimating a resource to create a new pyramid level.

The new scale is one half the input resource scale. Creates a new resource from filename according to file format

Definition at line 298 of file vil_pyramid_image_resource.cxx.

◆ file_format()

char const * vil_openjpeg_pyramid_image_resource::file_format ( ) const
overridevirtual

Return a string describing the file format.

Only file images have a format, others return 0

Implements vil_pyramid_image_resource.

Definition at line 72 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ get_copy_view() [1/6]

vil_image_view_base_sptr vil_pyramid_image_resource::get_copy_view ( unsigned  i0,
unsigned  n_i,
unsigned  j0,
unsigned  n_j 
) const
inlineoverridevirtualinherited

Create a read/write view of a copy of this data.

Applies only to the base image

Implements vil_image_resource.

Definition at line 61 of file vil_pyramid_image_resource.h.

◆ get_copy_view() [2/6]

vil_image_view_base_sptr vil_openjpeg_pyramid_image_resource::get_copy_view ( unsigned  i0,
unsigned  ni,
unsigned  j0,
unsigned  nj,
unsigned  level 
) const
overridevirtual

Get a partial view from the image from a specified pyramid level.

Implements vil_pyramid_image_resource.

Definition at line 90 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ get_copy_view() [3/6]

vil_image_view_base_sptr vil_openjpeg_pyramid_image_resource::get_copy_view ( unsigned  level) const
inlineoverridevirtual

Get a complete view from a specified pyramid level.

This method needs no specialization.

Reimplemented from vil_pyramid_image_resource.

Definition at line 68 of file vil_openjpeg_pyramid_image_resource.h.

◆ get_copy_view() [4/6]

vil_image_view_base_sptr vil_openjpeg_pyramid_image_resource::get_copy_view ( unsigned  i0,
unsigned  ni,
unsigned  j0,
unsigned  nj,
const float  scale,
float &  actual_scale 
) const
overridevirtual

Get a partial view from the image in the pyramid closest to scale.

The origin and size parameters are in the coordinate system of the base image. The scale factor is with respect to the base image (base scale = 1.0).

Implements vil_pyramid_image_resource.

Definition at line 105 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ get_copy_view() [5/6]

vil_image_view_base_sptr vil_image_resource::get_copy_view ( ) const
inlineinherited

Create a read/write view of a copy of all the data.

Definition at line 80 of file vil_image_resource.h.

◆ get_copy_view() [6/6]

vil_image_view_base_sptr vil_openjpeg_pyramid_image_resource::get_copy_view ( const float  scale,
float &  actual_scale 
) const
inlineoverridevirtual

Get a complete view from the image in the pyramid closest to the specified scale.

The scale factor is with respect to the base image (base scale = 1.0). This method needs no specialization.

Reimplemented from vil_pyramid_image_resource.

Definition at line 82 of file vil_openjpeg_pyramid_image_resource.h.

◆ get_property()

bool vil_pyramid_image_resource::get_property ( char const *  tag,
void *  property_value = nullptr 
) const
overridevirtualinherited

Extra property information.

Implements vil_image_resource.

Definition at line 24 of file vil_pyramid_image_resource.cxx.

◆ get_resource()

vil_image_resource_sptr vil_openjpeg_pyramid_image_resource::get_resource ( const unsigned  level) const
overridevirtual

Get an image resource from the pyramid at the specified level.

Implements vil_pyramid_image_resource.

Definition at line 125 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ get_view() [1/2]

virtual vil_image_view_base_sptr vil_image_resource::get_view ( unsigned  i0,
unsigned  n_i,
unsigned  j0,
unsigned  n_j 
) const
inlinevirtualinherited

Create a read/write view of the data.

Modifying this view might modify the actual data. If you want to modify this data in place, call put_view after you done, and it should work efficiently. This function will always return a multi-plane scalar-pixel view of the data.

Returns
0 if unable to get view of correct size, or if resource is write-only.

If you want to fill an existing view (e.g. a window onto some other image), then use

 vil_reformat(data->get_view(..), window);

Reimplemented in vil_flip_ud_image_resource, vil_memory_image, vil_plane_image_resource, vil_clamp_image_resource, vil_flip_lr_image_resource, vil_decimate_image_resource, vil_dicom_image, vil_crop_image_resource, and vil_transpose_image_resource.

Definition at line 64 of file vil_image_resource.h.

◆ get_view() [2/2]

vil_image_view_base_sptr vil_image_resource::get_view ( ) const
inlineinherited

Create a read/write view of all the data.

Definition at line 69 of file vil_image_resource.h.

◆ ni()

unsigned vil_openjpeg_pyramid_image_resource::ni ( ) const
overridevirtual

The number of pixels in each row.

Dimensions: Planes x ni x nj. This method refers to the base (max resolution) image

Implements vil_pyramid_image_resource.

Definition at line 43 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ nj()

unsigned vil_openjpeg_pyramid_image_resource::nj ( ) const
overridevirtual

The number of pixels in each column.

Dimensions: Planes x ni x nj. This method refers to the base (max resolution) image

Implements vil_pyramid_image_resource.

Definition at line 54 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ nlevels()

unsigned vil_openjpeg_pyramid_image_resource::nlevels ( ) const
overridevirtual

Number of pyramid levels.

Implements vil_pyramid_image_resource.

Definition at line 81 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ nplanes()

unsigned vil_openjpeg_pyramid_image_resource::nplanes ( ) const
overridevirtual

The number of planes (or components) in the image.

Dimensions: Planes x ni x nj. This method refers to the base (max resolution) image This concept is treated as a synonym to components.

Implements vil_pyramid_image_resource.

Definition at line 32 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ pixel_format()

vil_pixel_format vil_openjpeg_pyramid_image_resource::pixel_format ( ) const
overridevirtual

Pixel Format.

Implements vil_pyramid_image_resource.

Definition at line 63 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ print()

void vil_openjpeg_pyramid_image_resource::print ( const unsigned  level)
overridevirtual

for debug purposes.

Implements vil_pyramid_image_resource.

Definition at line 133 of file vil_openjpeg_pyramid_image_resource.cxx.

◆ put_resource()

bool vil_openjpeg_pyramid_image_resource::put_resource ( vil_image_resource_sptr const &  )
inlineoverridevirtual

Copy a resource into the pyramid, level is determined by resource scale.

Implements vil_pyramid_image_resource.

Definition at line 86 of file vil_openjpeg_pyramid_image_resource.h.

◆ put_view() [1/2]

bool vil_openjpeg_pyramid_image_resource::put_view ( vil_image_view_base const &  ,
unsigned  ,
unsigned   
)
inlineoverridevirtual

Put the data in this view back into the base image.

Pyramid is readonly. This is essentially (although not formally) a pure virtual function.

Implements vil_image_resource.

Definition at line 49 of file vil_openjpeg_pyramid_image_resource.h.

◆ put_view() [2/2]

virtual bool vil_image_resource::put_view ( const vil_image_view_base im)
inlinevirtualinherited

Put the data in this view back into the image source at the origin.

Reimplemented in vil_j2k_image.

Definition at line 92 of file vil_image_resource.h.

◆ ref()

void vil_image_resource::ref ( )
inlineprotectedinherited

Definition at line 110 of file vil_image_resource.h.

◆ unref()

void vil_image_resource::unref ( )
inlineprotectedinherited

Definition at line 111 of file vil_image_resource.h.

◆ view_fits()

bool vil_image_resource::view_fits ( const vil_image_view_base im,
unsigned  i0,
unsigned  j0 
)
virtualinherited

Check that a view will fit into the data at the given offset.

This includes checking that the pixel type is scalar.

Reimplemented in vil_j2k_image.

Definition at line 27 of file vil_image_resource.cxx.

Friends And Related Function Documentation

◆ vil_clamp()

vil_image_resource_sptr vil_clamp ( const vil_image_resource_sptr src,
double  low,
double  hi 
)
related

Clamp an image resource between two values.

Definition at line 22 of file vil_clamp.cxx.

◆ vil_convolve_1d()

template<class destT , class kernelT , class accumT >
vil_image_resource_sptr vil_convolve_1d ( const vil_image_resource_sptr src_im,
const destT  dt,
const kernelT *  kernel,
int  k_lo,
int  k_hi,
const accumT  ac,
vil_convolve_boundary_option  start_option,
vil_convolve_boundary_option  end_option 
)
related

Create an image_resource object which convolve kernel[x] x in [k_lo,k_hi] with srcT.

Note
This function reverses the kernel. If you don't want the kernel reversed, use vil_correlate_1d instead.
Parameters
kernelshould point to tap 0.

Definition at line 406 of file vil_convolve_1d.h.

◆ vil_copy_deep() [1/2]

bool vil_copy_deep ( const vil_image_resource_sptr src,
vil_image_resource_sptr dest 
)
related

Copy src to dest.

This is useful if you want to copy on image into a window on another image. src and dest must have identical sizes, and pixel-types. Returns false if the copy failed. O(size).

Definition at line 45 of file vil_copy.cxx.

◆ vil_copy_deep() [2/2]

vil_image_resource_sptr vil_copy_deep ( const vil_image_resource_sptr src)
related

Creates an in memory vil_image_resource and copies the src to it.

The size and pixel type of the return vil_image_resource is determined by src O(size)

Definition at line 89 of file vil_copy.cxx.

◆ vil_correlate_1d()

template<class destT , class kernelT , class accumT >
vil_image_resource_sptr vil_correlate_1d ( const vil_image_resource_sptr src_im,
const destT  dt,
const kernelT *  kernel,
std::ptrdiff_t  k_lo,
std::ptrdiff_t  k_hi,
const accumT  ac,
vil_convolve_boundary_option  start_option,
vil_convolve_boundary_option  end_option 
)
related

Create an image_resource object which correlate kernel[x] x in [k_lo,k_hi] with srcT.

Note
This function does not reverse the kernel. If you want the kernel reversed, use vil_convolve_1d instead.
Parameters
kernelshould point to tap 0.

Definition at line 218 of file vil_correlate_1d.h.

◆ vil_crop()

vil_image_resource_sptr vil_crop ( const vil_image_resource_sptr src,
unsigned  i0,
unsigned  n_i,
unsigned  j0,
unsigned  n_j 
)
related

Crop to a region of src.

Definition at line 15 of file vil_crop.cxx.

◆ vil_decimate()

vil_image_resource_sptr vil_decimate ( const vil_image_resource_sptr src,
unsigned  i_factor,
unsigned  j_factor = 0 
)
related

decimate to a region of src.

Definition at line 23 of file vil_decimate.cxx.

◆ vil_flip_lr()

vil_image_resource_sptr vil_flip_lr ( const vil_image_resource_sptr src)
related

Flip an image resource left to right.

Definition at line 14 of file vil_flip.cxx.

◆ vil_flip_ud()

vil_image_resource_sptr vil_flip_ud ( const vil_image_resource_sptr src)
related

Flip an image resource left to right.

Definition at line 121 of file vil_flip.cxx.

◆ vil_load_image_resource()

vil_image_resource_sptr vil_load_image_resource ( char const *  filename,
bool  verbose = true 
)
related

Load an image resource object from a file.

Definition at line 68 of file vil_load.cxx.

◆ vil_load_image_resource_plugin()

vil_image_resource_sptr vil_load_image_resource_plugin ( char const *  )
related

Load from a filename with a plugin.

Definition at line 80 of file vil_load.cxx.

◆ vil_load_image_resource_raw() [1/2]

vil_image_resource_sptr vil_load_image_resource_raw ( vil_stream ,
bool  verbose = true 
)
related

Load from a stream.

Won't use plugins.

Definition at line 19 of file vil_load.cxx.

◆ vil_load_image_resource_raw() [2/2]

vil_image_resource_sptr vil_load_image_resource_raw ( char const *  ,
bool  verbose = true 
)
related

Load an image resource object from a file.

Won't use plugins.

Definition at line 46 of file vil_load.cxx.

◆ vil_load_pyramid_resource()

vil_pyramid_image_resource_sptr vil_load_pyramid_resource ( char const *  directory_or_file,
bool  verbose = true 
)
related

Load a pyramid image resource object from a file or directory.

Definition at line 100 of file vil_load.cxx.

◆ vil_math_mean_and_variance()

template<class sumT >
bool vil_math_mean_and_variance ( sumT &  mean,
sumT &  var,
const vil_image_resource_sptr  im,
const vil_image_view< bool > &  mask,
unsigned  p 
)
related

Mean and variance of masked elements in plane p for vil_image_resource.

Definition at line 380 of file vil_math.h.

◆ vil_new_image_resource() [1/8]

vil_image_resource_sptr vil_new_image_resource ( unsigned  ni,
unsigned  nj,
unsigned  nplanes,
vil_pixel_format  format 
)
related

Make a new image of given format.

If the format is not scalar, the number of planes must be 1. When you create a multi-component image in this way, the vil_image_resource API will treat it as a scalar pixel image with multiple planes. (This doesn't affect the underlying data storage.)

Definition at line 32 of file vil_new.cxx.

◆ vil_new_image_resource() [2/8]

vil_image_resource_sptr vil_new_image_resource ( unsigned  ni,
unsigned  nj,
vil_image_resource_sptr const &  prototype 
)
related

Make a new image, similar format to the prototype.

Definition at line 69 of file vil_new.cxx.

◆ vil_new_image_resource() [3/8]

vil_image_resource_sptr vil_new_image_resource ( vil_stream os,
unsigned  ni,
unsigned  nj,
unsigned  nplanes,
vil_pixel_format  format,
char const *  file_format 
)
related

Make a new image.

Definition at line 77 of file vil_new.cxx.

◆ vil_new_image_resource() [4/8]

vil_image_resource_sptr vil_new_image_resource ( char const *  filename,
unsigned  ni,
unsigned  nj,
unsigned  nplanes,
vil_image_resource_sptr const &  prototype,
char const *  format = nullptr 
)
related

Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype".

◆ vil_new_image_resource() [5/8]

vil_image_resource_sptr vil_new_image_resource ( vil_stream os,
unsigned  ni,
unsigned  nj,
unsigned  nplanes,
vil_image_resource_sptr const &  prototype,
char const *  file_format = nullptr 
)
related

Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype".

◆ vil_new_image_resource() [6/8]

vil_image_resource_sptr vil_new_image_resource ( char const *  filename,
unsigned  ni,
unsigned  nj,
vil_image_resource_sptr const &  prototype,
char const *  file_format 
)
related

Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype".

Definition at line 104 of file vil_new.cxx.

◆ vil_new_image_resource() [7/8]

vil_image_resource_sptr vil_new_image_resource ( char const *  filename,
unsigned  ni,
unsigned  nj,
unsigned  nplanes,
vil_pixel_format  format,
char const *  file_format 
)
related

Make a new image.

Definition at line 123 of file vil_new.cxx.

◆ vil_new_image_resource() [8/8]

vil_image_resource_sptr vil_new_image_resource ( vil_stream os,
unsigned  ni,
unsigned  nj,
vil_image_resource_sptr const &  prototype,
char const *  file_format 
)
related

Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype".

Definition at line 143 of file vil_new.cxx.

◆ vil_new_image_resource_interleaved()

vil_image_resource_sptr vil_new_image_resource_interleaved ( unsigned  ni,
unsigned  nj,
unsigned  nplanes,
vil_pixel_format  format 
)
related

Make a new image of given format with interleaved planes.

The format must be scalar.

Definition at line 44 of file vil_new.cxx.

◆ vil_new_image_resource_of_view()

vil_image_resource_sptr vil_new_image_resource_of_view ( vil_image_view_base const &  view)
related

Make a new image resource that is a wrapper on an existing view's data.

Note
The output will be a shallow copy of the input, so changing the pixel values of one may change the pixel value of the other. Thanks to the magic of smart pointers, the output will remain valid even if you destroy the input. When you wrap a multi-component image in this way, the vil_image_resource API will treat it as a scalar pixel image with multiple planes. (This doesn't affect the underlying data storage.)

Definition at line 62 of file vil_new.cxx.

◆ vil_plane()

vil_image_resource_sptr vil_plane ( const vil_image_resource_sptr src,
unsigned  p 
)
related

Return a specific plane of an image.

Definition at line 19 of file vil_plane.cxx.

◆ vil_save_image_resource() [1/2]

bool vil_save_image_resource ( const vil_image_resource_sptr ir,
char const *  filename,
char const *  file_format 
)
related

Send vil_image_resource to disk.

Definition at line 129 of file vil_save.cxx.

◆ vil_save_image_resource() [2/2]

bool vil_save_image_resource ( const vil_image_resource_sptr ir,
char const *  filename 
)
related

Save vil_image_resource to file, deducing format from filename.

Definition at line 148 of file vil_save.cxx.

◆ vil_transpose()

vil_image_resource_sptr vil_transpose ( const vil_image_resource_sptr src)
related

Transpose an image.

Definition at line 14 of file vil_transpose.cxx.

Member Data Documentation

◆ openjpeg_sptr_

vil_image_resource_sptr vil_openjpeg_pyramid_image_resource::openjpeg_sptr_
protected

Definition at line 97 of file vil_openjpeg_pyramid_image_resource.h.

◆ ptr_

vil_openjpeg_image* vil_openjpeg_pyramid_image_resource::ptr_
protected

Definition at line 98 of file vil_openjpeg_pyramid_image_resource.h.

◆ reference_count_

vcl_atomic_count vil_image_resource::reference_count_
protectedinherited

Definition at line 114 of file vil_image_resource.h.


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